Documentation - Global

Members

(constant) RAPID_MIX_DOC_VERSION :String

The RAPID-MIX JSON document specification version.

Type:

String

Default Value:

1.0.0

Source:

index.js, line 15

(constant) RAPID_MIX_DEFAULT_LABEL :String

The default RAPID-MIX label used to build training sets.

Type:

String

Default Value:

rapidmixDefaultLabel

Source:

index.js, line 23

Methods

rapidMixToRapidLibTrainingSet(rapidMixTrainingSet) → {Object}

Convert a RAPID-MIX training set Object to a RapidLib JS training set Object.

Parameters:

Name	Type	Description
`rapidMixTrainingSet`	Object	A RAPID-MIX compatible training set

Source:

index.js, line 38

Returns:

rapidLibTrainingSet - A RapidLib JS compatible training set

Type: Object

rapidMixToXmmTrainingSet(rapidMixTrainingSet) → {Object}

Convert a RAPID-MIX training set Object to an XMM training set Object.

Parameters:

Name	Type	Description
`rapidMixTrainingSet`	Object	A RAPID-MIX compatible training set

Source:

index.js, line 71

Returns:

xmmTrainingSet - An XMM compatible training set

Type: Object

xmmToRapidMixTrainingSet(xmmTrainingSet) → {Object}

Convert an XMM training set Object to a RAPID-MIX training set Object.

Parameters:

Name	Type	Description
`xmmTrainingSet`	Object	An XMM compatible training set

Source:

index.js, line 116

Returns:

rapidMixTrainingSet - A RAPID-MIX compatible training set

Type: Object

rapidMixToXmmConfig(rapidMixConfig) → {Object}

Convert a RAPID-MIX configuration Object to an XMM configuration Object.

Parameters:

Name	Type	Description
`rapidMixConfig`	Object	A RAPID-MIX compatible configuraiton object

Source:

index.js, line 191

Returns:

xmmConfig - A configuration object ready to be used by the XMM library

Type: Object

xmmToRapidMixConfig(xmmConfig) → {Object}

Convert an XMM configuration Object to a RAPID-MIX configuration set Object.

Parameters:

Name	Type	Description
`xmmConfig`	Object	A configuration object targeting the XMM library

Source:

index.js, line 202

Returns:

rapidMixConfig - A RAPID-MIX compatible configuration object

Type: Object

rapidMixToXmmModel(rapidMixModel) → {Object}

Convert a RAPID-MIX configuration Object to an XMM configuration Object.

Parameters:

Name	Type	Description
`rapidMixModel`	Object	A RAPID-MIX compatible model

Source:

index.js, line 221

Returns:

xmmModel - A model ready to be used by the XMM library

Type: Object

xmmToRapidMixModel(xmmModel) → {Object}

Convert an XMM model Object to a RAPID-MIX model Object.

Parameters:

Name	Type	Description
`xmmModel`	Object	A model generated by the XMM library

Source:

index.js, line 232

Returns:

rapidMixModel - A RAPID-MIX compatible model

Type: Object

createComoHttpRequest(config, trainingSet, metasopt, signalProcessingopt) → {Object}

Create the JSON to send to the Como web service via http request.

Parameters:

Name	Type	Attributes	Default	Description
`config`	Object			A valid RAPID-MIX configuration object
`trainingSet`	Object			A valid RAPID-MIX training set object
`metas`	Object	<optional>	null	Some optional meta data
`signalProcessing`	Object	<optional>	null	An optional description of the pre processing used to obtain the training set

Source:

index.js, line 263

Returns:

httpRequest - A valid JSON to be sent to the Como web service via http request.

Type: Object

createComoHttpResponse(config, model, metasopt, signalProcessingopt) → {Object}

Create the JSON to send back as a response to http requests to the Como web service.

Parameters:

Name	Type	Attributes	Default	Description
`config`	Object			A valid RAPID-MIX configuration object
`model`	Object			A valid RAPID-MIX model object
`metas`	Object	<optional>	null	Some optional meta data
`signalProcessing`	Object	<optional>	null	An optional description of the pre processing used to obtain the training set

Source:

index.js, line 298

Returns:

httpResponse - A valid JSON response to be sent back from the Como web service via http.

Type: Object