CreateModelDetails¶
- class oci.data_science.models.CreateModelDetails(**kwargs)¶
Bases:
objectParameters needed to create a new model. Models are mathematical representations of the relationships between data. Models are represented by their associated metadata and artifact.
Methods:
__init__(**kwargs)Initializes a new CreateModelDetails object with values from keyword arguments.
Attributes:
Gets the backup_setting of this CreateModelDetails.
[Required] Gets the compartment_id of this CreateModelDetails.
Gets the custom_metadata_list of this CreateModelDetails.
Gets the defined_metadata_list of this CreateModelDetails.
Gets the defined_tags of this CreateModelDetails.
Gets the description of this CreateModelDetails.
Gets the display_name of this CreateModelDetails.
Gets the freeform_tags of this CreateModelDetails.
Gets the input_schema of this CreateModelDetails.
Gets the model_version_set_id of this CreateModelDetails.
Gets the output_schema of this CreateModelDetails.
[Required] Gets the project_id of this CreateModelDetails.
Gets the retention_setting of this CreateModelDetails.
Gets the version_label of this CreateModelDetails.
- __init__(**kwargs)¶
Initializes a new CreateModelDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
compartment_id (str) – The value to assign to the compartment_id property of this CreateModelDetails.
project_id (str) – The value to assign to the project_id property of this CreateModelDetails.
display_name (str) – The value to assign to the display_name property of this CreateModelDetails.
description (str) – The value to assign to the description property of this CreateModelDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateModelDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateModelDetails.
custom_metadata_list (list[oci.data_science.models.Metadata]) – The value to assign to the custom_metadata_list property of this CreateModelDetails.
defined_metadata_list (list[oci.data_science.models.Metadata]) – The value to assign to the defined_metadata_list property of this CreateModelDetails.
input_schema (str) – The value to assign to the input_schema property of this CreateModelDetails.
output_schema (str) – The value to assign to the output_schema property of this CreateModelDetails.
model_version_set_id (str) – The value to assign to the model_version_set_id property of this CreateModelDetails.
version_label (str) – The value to assign to the version_label property of this CreateModelDetails.
retention_setting (oci.data_science.models.RetentionSetting) – The value to assign to the retention_setting property of this CreateModelDetails.
backup_setting (oci.data_science.models.BackupSetting) – The value to assign to the backup_setting property of this CreateModelDetails.
- property backup_setting¶
Gets the backup_setting of this CreateModelDetails.
- Returns
The backup_setting of this CreateModelDetails.
- Return type
- property compartment_id¶
[Required] Gets the compartment_id of this CreateModelDetails. The OCID of the compartment to create the model in.
- Returns
The compartment_id of this CreateModelDetails.
- Return type
str
- property custom_metadata_list¶
Gets the custom_metadata_list of this CreateModelDetails. An array of custom metadata details for the model.
- Returns
The custom_metadata_list of this CreateModelDetails.
- Return type
- property defined_metadata_list¶
Gets the defined_metadata_list of this CreateModelDetails. An array of defined metadata details for the model.
- Returns
The defined_metadata_list of this CreateModelDetails.
- Return type
- property defined_tags¶
Gets the defined_tags of this CreateModelDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}
- Returns
The defined_tags of this CreateModelDetails.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this CreateModelDetails. A short description of the model.
- Returns
The description of this CreateModelDetails.
- Return type
str
- property display_name¶
Gets the display_name of this CreateModelDetails. A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information. Example: My Model
- Returns
The display_name of this CreateModelDetails.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this CreateModelDetails. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {“Department”: “Finance”}
- Returns
The freeform_tags of this CreateModelDetails.
- Return type
dict(str, str)
- property input_schema¶
Gets the input_schema of this CreateModelDetails. Input schema file content in String format
- Returns
The input_schema of this CreateModelDetails.
- Return type
str
- property model_version_set_id¶
Gets the model_version_set_id of this CreateModelDetails. The OCID of the model version set that the model is associated to.
- Returns
The model_version_set_id of this CreateModelDetails.
- Return type
str
- property output_schema¶
Gets the output_schema of this CreateModelDetails. Output schema file content in String format
- Returns
The output_schema of this CreateModelDetails.
- Return type
str
- property project_id¶
[Required] Gets the project_id of this CreateModelDetails. The OCID of the project to associate with the model.
- Returns
The project_id of this CreateModelDetails.
- Return type
str
- property retention_setting¶
Gets the retention_setting of this CreateModelDetails.
- Returns
The retention_setting of this CreateModelDetails.
- Return type
- property version_label¶
Gets the version_label of this CreateModelDetails. The version label can add an additional description of the lifecycle state of the model or the application using/training the model.
- Returns
The version_label of this CreateModelDetails.
- Return type
str