Module aivis_engine_v2_cn_sdk_python.model_context

Classes

class ConstraintNavigatorModelContext (handle, key)

Class for creating and handling model context. This is your entry point for all model context methods.

Private constructor. To create new instance, use: - ConstraintNavigatorModelContext.create()

Static methods

def create(cls) ‑> ConstraintNavigatorModelContext

@FlavourRequirement([Flavour.FULL])

Create model context

To add models use any of: - ConstraintNavigatorModelContext.add_signal_prediction() - ConstraintNavigatorModelContext.add_anomaly_detection() - ConstraintNavigatorModelContext.add_state_detection()

Returns

ModelContext

Instance of model context

Methods

def add_anomaly_detection(self, model_id, model_json)

@FlavourRequirement([Flavour.FULL])

Add a anomaly detection model to model context. The added model will be used for constructing constraints.

Parameters

model_id : str

Model-ID as string

model_json : str

anomaly detection DtoModel as JSON string

Returns

ModelContext

Instance of model context

def add_signal_prediction(self, model_id, model_json)

@FlavourRequirement([Flavour.FULL])

Add a signal prediction model to model context. The added model will be used for constructing constraints.

Parameters

model_id : str

Model-ID as string

model_json : str

signal prediction DtoModel as JSON string

Returns

ModelContext

Instance of model context

def add_state_detection(self, model_id, model_json, segment_id)

@FlavourRequirement([Flavour.FULL])

Add a state detection model segment to model context. The added model will be used for constructing constraints.

Parameters

model_id : str

Model-ID as string

model_json : str

state detection DtoModel as JSON string

segment_id : int

ID of model segment to be added to model context

Returns

ModelContext

Instance of model context

def destroy(self)

@FlavourRequirement([Flavour.FULL])

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