Module aivis_engine_v2_sd_sdk_python.training

Classes

class StateDetectionTraining (handle, key)

Class for creating and handling state detection training. This is your entry point for all training operations.

Private constructor. To create new instances use any of:

• StateDetectionTraining.create()
• StateDetectionTraining.create_by_analysis()
• StateDetectionTraining.create_by_training_preparation()

Static methods

def create(cls, data: StateDetectionData, config_json: str) ‑> StateDetectionTraining

@FlavourRequirement([Flavour.FULL])

Create state detection training for given data and config.

Use StateDetectionTraining.get_model() or StateDetectionTraining.get_report() to get instances of DtoModel or DtoTrainingReport as JSON string.

Parameters

data : StateDetectionData

Instance of signal prediction data

config_json : str

DtoTrainingConfig as JSON string

Returns

StateDetectionTraining

Instance of state detection training

def create_by_analysis(cls, data: StateDetectionData, analysis: StateDetectionAnalysis, config_json: str) ‑> StateDetectionTraining

@FlavourRequirement([Flavour.FULL])

Create state detection training for given data context, analysis and config.

Use StateDetectionTraining.get_model() or StateDetectionTraining.get_report() to get instances of DtoModel or DtoTrainingReport as JSON string.

Parameters

data : StateDetectionData

Instance of signal prediction data

analysis : StateDetectionAnalysis

Instance of state detection analysis

config_json : str

DtoPreparationBasedTrainingConfig as JSON string

Returns

StateDetectionTraining

Instance of state detection training

def create_by_training_preparation(cls, data: StateDetectionData, preparation_json: str, config_json: str) ‑> StateDetectionTraining

@FlavourRequirement([Flavour.FULL])

Create state detection training for given data context, training preparation and config.

Use StateDetectionTraining.get_model() or StateDetectionTraining.get_report() to get instances of DtoModel or DtoTrainingReport as JSON string.

Parameters

data : StateDetectionData

Instance of signal prediction data

preparation_json : str

DtoTrainingPreparation as JSON string

config_json : str

DtoPreparationBasedTrainingConfig as JSON string

Returns

StateDetectionTraining

Instance of state detection training

Methods

def destroy(self)

@FlavourRequirement([Flavour.FULL])

Destroy this state detection training. It's always safe to destroy a training. Internally the destruction only takes place after all references to this object have been released.

def get_model(self) ‑> str

@FlavourRequirement([Flavour.FULL])

Get this training's DtoModel.

Returns

str

DtoModel as JSON string

def get_report(self) ‑> str

@FlavourRequirement([Flavour.FULL])

Get this training's DtoTrainingReport.

Returns

str

DtoTrainingReport as JSON string