Rapid-Mix API  v2.2.0
A simple library for machine learning & signal processing
rapidmix::trainingData Class Reference

#include <trainingData.h>

Collaboration diagram for rapidmix::trainingData:
Collaboration graph

Classes

struct  element
 
struct  phrase
 

Public Member Functions

 trainingData ()
 
uint32_t startRecording ()
 
uint32_t startRecording (const std::string &label)
 
uint32_t addElement (const std::vector< double > &input, const std::vector< double > &output)
 
uint32_t addElement (const std::vector< double > &input)
 
void stopRecording ()
 
uint32_t recordSingleElement (const std::string &label, const std::vector< double > &input)
 
uint32_t recordSingleElement (const std::vector< double > &input, const std::vector< double > &output)
 
uint32_t recordSingleElement (const std::string &label, const std::vector< double > &input, const std::vector< double > &output)
 
std::vector< std::string > getColumnNames ()
 
void setColumnNames (const std::vector< std::string > &columnNames)
 
std::string getJSON ()
 
void writeJSON (const std::string &filepath)
 
bool putJSON (const std::string &jsonMessage)
 
bool readJSON (const std::string &filepath)
 

Public Attributes

std::vector< phrasetrainingSet
 

Detailed Description

This is used by both NN and KNN models for training

Constructor & Destructor Documentation

§ trainingData()

rapidmix::trainingData::trainingData ( )

Member Function Documentation

§ addElement() [1/2]

uint32_t rapidmix::trainingData::addElement ( const std::vector< double > &  input,
const std::vector< double > &  output 
)

Add an element with input and output to the phrase that is recording, or to the default phrase if recording is stopped. Returns phrase id.

§ addElement() [2/2]

uint32_t rapidmix::trainingData::addElement ( const std::vector< double > &  input)

Add an element with just input to the phrase that is recording, or to the default phrase if recording is stopped. Returns phrase id.

§ getColumnNames()

std::vector< std::string > rapidmix::trainingData::getColumnNames ( )

§ getJSON()

std::string rapidmix::trainingData::getJSON ( )

Get a JSON representation of the data set in the form of a styled string

§ putJSON()

bool rapidmix::trainingData::putJSON ( const std::string &  jsonMessage)

populate a data set with string. See getJSON()

§ readJSON()

bool rapidmix::trainingData::readJSON ( const std::string &  filepath)

read a JSON file at file path and build a training set from it

§ recordSingleElement() [1/3]

uint32_t rapidmix::trainingData::recordSingleElement ( const std::string &  label,
const std::vector< double > &  input 
)

Create a phrase with a single element that has a label and input. Returns phrase id.

§ recordSingleElement() [2/3]

uint32_t rapidmix::trainingData::recordSingleElement ( const std::vector< double > &  input,
const std::vector< double > &  output 
)

Create a phrase with a single element that has input, and output. Returns phrase id.

§ recordSingleElement() [3/3]

uint32_t rapidmix::trainingData::recordSingleElement ( const std::string &  label,
const std::vector< double > &  input,
const std::vector< double > &  output 
)

Create a phrase with a single element that has a label, input, and output. Returns phrase id.

§ setColumnNames()

void rapidmix::trainingData::setColumnNames ( const std::vector< std::string > &  columnNames)

§ startRecording() [1/2]

uint32_t rapidmix::trainingData::startRecording ( )

Create a new phrase that can be recorded into. Returns phrase id

§ startRecording() [2/2]

uint32_t rapidmix::trainingData::startRecording ( const std::string &  label)

Create new phrase, with a label, that can be recorded into. Returns phrase id

§ stopRecording()

void rapidmix::trainingData::stopRecording ( )

§ writeJSON()

void rapidmix::trainingData::writeJSON ( const std::string &  filepath)

Write a JSON version of the training set to specified file path

Member Data Documentation

§ trainingSet

std::vector<phrase> rapidmix::trainingData::trainingSet

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