Projects#
Projects are a selection of training data used to train a model.
Directory#
- class ProjectDirectory#
Provides a collection of methods related to projects.
This class is accessed through
client.projects
.Example
List all projects:
import ansys.simai.core simai = ansys.simai.core.from_config() simai.projects.list()
Model#
- class Project#
Provides the local representation of a project object.
- cancel_build()#
Cancels a build if there is one pending.
- compute_gc_formula(gc_formula: str, bc: list[str] | None = None, surface_variables: list[str] | None = None)#
Compute the result of a global coefficient formula according to the project sample.
- get_variables() Dict[str, List[str]] | None #
Get the available variables for the model’s input/output.
- verify_gc_formula(gc_formula: str, bc: list[str] | None = None, surface_variables: list[str] | None = None)#
Verify whether the syntax of the global coefficient formula is valid.
- property data: List[TrainingData]#
List of all
TrainingData
instances in the project.
- property last_model_configuration: ModelConfiguration#
Last
configuration
used for model training in this project.
- property sample: TrainingData | None#
Sample of the project. The sample determines what variable and settings are available during model configuration.
IsTrainableInfo#
- class IsTrainableInfo#
Properties for project’s trainability.
The objects of this class can be used as booleans in condition statements as in the example:
Example
Verify the project is trainable
pt = my_project.is_trainable() if pt: print(pt)
It prints:
<is_trainable: False, reason(s): Not enough data to train a model: we need at least 3 data points to train a model.>
- reason#
If not_trainable is False, the reason why the project is not trainable. None otherwise.
- Type:
Create new instance of IsTrainableInfo(is_trainable, reason)