turi::toolkit_class_specification Struct Reference

#include <model_server/lib/toolkit_class_specification.hpp>

Public Attributes
std::string	name
std::map< std::string, flexible_type >	description
model_base *(*	constructor )()

Detailed Description

Each model is specified by filling in toolkit_model_specification struct. The contents of the struct describe user-facing documentation and default options, as well as a callback to actual toolkit execution.

Definition at line 19 of file toolkit_class_specification.hpp.

Member Data Documentation

constructor

model_base*(* turi::toolkit_class_specification::constructor) ()

A callback function to call to construct a model

Definition at line 41 of file toolkit_class_specification.hpp.

description

std::map<std::string, flexible_type> turi::toolkit_class_specification::description

Model properties. The following keys are recognized.

• "functions": A dictionary with key: function name, and value, a list of input parameters.
• "get_properties": The list of all readable properties of the model
• "set_properties": The list of all writable properties of the model
• "file": The file which the toolkit was loaded from
• "documentation": A documentation string

Definition at line 36 of file toolkit_class_specification.hpp.

name

std::string turi::toolkit_class_specification::name

A short name used to identify this toolkit. For instance, LDA, or PageRank.

Definition at line 24 of file toolkit_class_specification.hpp.

---

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

• model_server/lib/toolkit_class_specification.hpp