Module aivis_engine_v2_sd_sdk_python.analysis

Classes

class StateDetectionAnalysis (handle, key)

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

Private constructor. To create new instances use:

Static methods

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

@FlavourRequirement([Flavour.FULL])

Create state detection analysis for given data and config.

Use StateDetectionAnalysis.get_training_preparation() or StateDetectionAnalysis.get_report() to get instances of DtoTrainingPreparation or DtoAnalysisReport as JSON string.

Parameters

data : StateDetectionData
Instance of state detection data
config_json : str
DtoAnalysisConfig as JSON string

Returns

StateDetectionAnalysis
Instance of state detection analysis

Methods

def destroy(self)

@FlavourRequirement([Flavour.FULL])

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

def get_report(self) ‑> str

@FlavourRequirement([Flavour.FULL])

Get this analysis' DtoAnalysisReport.

Returns

str
DtoAnalysisReport as JSON string
def get_training_preparation(self) ‑> str

@FlavourRequirement([Flavour.FULL])

Get this analysis' DtoTrainingPreparation.

Returns

str
DtoTrainingPreparation as JSON string