trendminer.ml.models.models module¶

This module contains definitions to interface with ML platforms managed by Trendminer

class trendminer.ml.models.models.Models¶

Bases: abc.ABC

An abstract base class to interface with a specific TendMiner managed ML platform.

abstract delete_model(model_id: str)¶

Delete a model from some ML platform.

Parameters

model_id – The identifier of the model one wishes to delete

Raises

MLModelException – If the deletion failed

abstract deploy_model(model: any) → str¶

Deploy a model to some ML platform managed by TrendMiner.

Parameters

model – The model one wishes to deploy the ML platform

Returns

An identifier for a successfully deployed model

Raises

MLModelException – If the deployment failed

abstract list_models() → List[any]¶

List all models in the ML platform.

Returns

A list of all models in the Ml platform

Raises

MLModelException – If the list request failed

abstract model_details(model_id: str) → any¶

Request detailed information about a model in the ML platform.

Parameters

model_id – The identifier of the model at hand

Returns

Some detailed information about the requested model

Raises

MLModelException – If the details request failed

class trendminer.ml.models.models.ZementisModels(trend_miner_client: trendminer.trendminer_client.TrendMinerClient)¶

Bases: trendminer.ml.models.models.Models

An instantiation of the Models to interface with the Zementis instance managed by TrendMiner

delete_model(model_id: str)¶

Delete a model from some ML platform.

Parameters

model_id – The identifier of the model one wishes to delete

Raises

MLModelException – If the deletion failed

deploy_model(model: any) → str¶

Deploy a model to some ML platform managed by TrendMiner.

Parameters

model – The model one wishes to deploy the ML platform

Returns

An identifier for a successfully deployed model

Raises

MLModelException – If the deployment failed

list_models() → List[any]¶

List all models in the ML platform.

Returns

A list of all models in the Ml platform

Raises

MLModelException – If the list request failed

model_details(model_id: str) → any¶

Request detailed information about a model in the ML platform.

Parameters

model_id – The identifier of the model at hand

Returns

Some detailed information about the requested model

Raises

MLModelException – If the details request failed