modelon.impact.client.entities.interfaces package

Submodules

modelon.impact.client.entities.interfaces.case module

class CaseInterface(case_id, workspace_id, exp_id, service, info)

Bases: ABC

property experiment_id: str

Experiment id.

abstract property id: str

Case id.

class CaseReference(case_id, workspace_id, exp_id, service, info)

Bases: CaseInterface

property experiment_id: str

Experiment id.

property id: str

Case id.

modelon.impact.client.entities.interfaces.custom_artifact module

class CustomArtifactInterface(workspace_id, experiment_id, case_id, artifact_id, download_as, exp_sal)

Bases: ABC

abstract property id: str

Custom artifact id.

modelon.impact.client.entities.interfaces.custom_function module

class CustomFunctionInterface

Bases: ABC

abstract property name: str

Custom function name

modelon.impact.client.entities.interfaces.experiment module

class ExperimentInterface(workspace_id, exp_id, service, info=None)

Bases: ABC

abstract get_cases()

Returns a list of case objects for an experiment.

Return type:

Any

abstract property id: str

Experiment id.

class ExperimentReference(workspace_id, exp_id, service, info=None)

Bases: ExperimentInterface

get_cases()

Returns a list of case objects for an experiment.

Return type:

Any

property id: str

Experiment id.

modelon.impact.client.entities.interfaces.external_result module

class ExternalResultInterface

Bases: ABC

abstract property id: str

Result id.

modelon.impact.client.entities.interfaces.model module

class ModelInterface

Bases: ABC

abstract property name: str

Model name.

modelon.impact.client.entities.interfaces.model_executable module

class ModelExecutableInterface

Bases: ABC

abstract property id: str

FMU id.

modelon.impact.client.entities.interfaces.workspace module

class WorkspaceInterface

Bases: ABC

abstract property id: str

Workspace id.

Module contents