Models

A collection of classes for building a SimAI model. Launching a build requires a configuration (ModelConfiguration) which defines the model properties, such as its inputs and outputs, the Global Coefficients and the Domain of Analysis, and its project. The ModelConfiguration object is, then, parsed to models.build() for launching a build.

Directory

class ModelDirectory

Provides a collection of methods related to building models.

build(configuration: ModelConfiguration, dismiss_data_with_fields_discrepancies: bool = False, dismiss_data_with_volume_overflow: bool = False, dismiss_data_input_with_nan: bool = False)

Launches a build given a configuration.

Parameters:

• configuration (ModelConfiguration) – a ModelConfiguration object that contains the properties to be used in the build

• dismiss_data_with_fields_discrepancies (bool) – set to True for omitting data with missing properties

• dismiss_data_with_volume_overflow (bool) – set to True for omitting data outside the Domain of Analysis

• dismiss_data_input_with_nan (bool) – set to True for omitting data with inputs containing NaN values

Example

Use a previous configuration for a new build in the same project

a_project = simai.projects.get("project_A")

build_conf = a_project.last_model_configuration

new_model = simai.models.build(build_conf)

Use a previous configuration for a new build in another project

a_project = simai.projects.get("project_A")

build_conf = a_project.last_model_configuration

b_project = simai.projects.get("project_B")

# set the id of b_project as the project_id of the configuration
build_conf.project = b_project

new_model = simai.models.build(build_conf)

Model

class Model

Training model representation.

reload() → None

Refresh the object with its representation from the server.

wait(timeout: float | None = None) → bool

Wait for all jobs concerning the object to either finish or fail.

Parameters:

timeout (float | None) – Maximum amount of time in seconds to wait. The default is None, it means that there is no maximum on the time to wait.

Returns:

True if the computation has finished, False if the operation timed out.

Return type:

bool

property configuration: ModelConfiguration

Build configuration of a model.

property failure_reason

Optional message giving the causes for why the creation of the object failed.

See also

• has_failed

property fields: dict

Dictionary containing the raw object representation.

property has_failed

Boolean indicating if the creation of the object failed.

See also

• failure_reason

• wait()

• is_ready

• is_pending

property id: str

ID of the object on the server.

property is_pending

Boolean indicating if the object is still in creation. The value becomes False once object creation is either successful or has failed.

See also

• wait()

• is_ready

• has_failed

property is_ready

Boolean indicating if the object has finished creating without error.

See also

• wait()

• is_pending

• has_failed

property project_id: str

The ID of the project where the model exists.