Turi Create  4.0
turi::sparse_sim::sparse_similarity_lookup_impl< SimilarityType > Class Template Reference

#include <toolkits/sparse_similarity/sparse_similarity_lookup_impl.hpp>

Public Member Functions

std::string similarity_name () const
 
const std::map< std::string, flexible_type > & current_options () const
 

Static Public Member Functions

static void add_options (option_manager &options)
 
static std::shared_ptr< sparse_similarity_lookupcreate (const std::string &similarity, const std::map< std::string, flexible_type > &options)
 

Protected Attributes

std::map< std::string, flexible_typeoptions
 

Detailed Description

template<typename SimilarityType>
class turi::sparse_sim::sparse_similarity_lookup_impl< SimilarityType >

The main class for training and actually implementing the sparse similarity lookup stuff.

Definition at line 34 of file sparse_similarity_lookup_impl.hpp.

Member Function Documentation

◆ add_options()

static void turi::sparse_similarity_lookup::add_options ( option_manager options)
staticinherited

Adds in all of the options needed for this class to the option manager.

◆ create()

static std::shared_ptr<sparse_similarity_lookup> turi::sparse_similarity_lookup::create ( const std::string &  similarity,
const std::map< std::string, flexible_type > &  options 
)
staticinherited

Factory method: Call this to create or load a model from one of the existing similarities by name.

◆ current_options()

const std::map<std::string, flexible_type>& turi::sparse_similarity_lookup::current_options ( ) const
inlineinherited

The current options.

Definition at line 166 of file sparse_similarity_lookup.hpp.

◆ similarity_name()

template<typename SimilarityType >
std::string turi::sparse_sim::sparse_similarity_lookup_impl< SimilarityType >::similarity_name ( ) const
inlinevirtual

Returns the name of the similarity this version uses.

Implements turi::sparse_similarity_lookup.

Definition at line 50 of file sparse_similarity_lookup_impl.hpp.

Member Data Documentation

◆ options

std::map<std::string, flexible_type> turi::sparse_similarity_lookup::options
protectedinherited

The stored options.

Definition at line 180 of file sparse_similarity_lookup.hpp.


The documentation for this class was generated from the following file: