Model¶

class oci.data_science.models.Model(**kwargs)¶

Bases: object

Models are mathematical representations of the relationships between data. Models are represented by their associated metadata and artifacts.

Attributes:

`CATEGORY_SERVICE`	A constant which can be used with the category property of a Model.
`CATEGORY_USER`	A constant which can be used with the category property of a Model.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a Model.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a Model.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a Model.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a Model.
`backup_operation_details`	[Required] Gets the backup_operation_details of this Model.
`backup_setting`	[Required] Gets the backup_setting of this Model.
`category`	[Required] Gets the category of this Model.
`compartment_id`	[Required] Gets the compartment_id of this Model.
`created_by`	[Required] Gets the created_by of this Model.
`custom_metadata_list`	Gets the custom_metadata_list of this Model.
`defined_metadata_list`	Gets the defined_metadata_list of this Model.
`defined_tags`	Gets the defined_tags of this Model.
`description`	Gets the description of this Model.
`display_name`	[Required] Gets the display_name of this Model.
`freeform_tags`	Gets the freeform_tags of this Model.
`id`	[Required] Gets the id of this Model.
`input_schema`	Gets the input_schema of this Model.
`is_model_by_reference`	[Required] Gets the is_model_by_reference of this Model.
`lifecycle_details`	[Required] Gets the lifecycle_details of this Model.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Model.
`model_version_set_id`	[Required] Gets the model_version_set_id of this Model.
`model_version_set_name`	[Required] Gets the model_version_set_name of this Model.
`output_schema`	Gets the output_schema of this Model.
`project_id`	[Required] Gets the project_id of this Model.
`retention_operation_details`	[Required] Gets the retention_operation_details of this Model.
`retention_setting`	[Required] Gets the retention_setting of this Model.
`time_created`	[Required] Gets the time_created of this Model.
`version_id`	[Required] Gets the version_id of this Model.
`version_label`	[Required] Gets the version_label of this Model.

Methods:

__init__(**kwargs)

Initializes a new Model object with values from keyword arguments.

CATEGORY_SERVICE = 'SERVICE'¶: A constant which can be used with the category property of a Model. This constant has a value of “SERVICE”

CATEGORY_USER = 'USER'¶: A constant which can be used with the category property of a Model. This constant has a value of “USER”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a Model. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a Model. This constant has a value of “DELETED”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a Model. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a Model. This constant has a value of “INACTIVE”

__init__(**kwargs)¶

Initializes a new Model object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

id (str) – The value to assign to the id property of this Model.
compartment_id (str) – The value to assign to the compartment_id property of this Model.
project_id (str) – The value to assign to the project_id property of this Model.
display_name (str) – The value to assign to the display_name property of this Model.
description (str) – The value to assign to the description property of this Model.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Model. Allowed values for this property are: “ACTIVE”, “DELETED”, “FAILED”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this Model.
time_created (datetime) – The value to assign to the time_created property of this Model.
created_by (str) – The value to assign to the created_by property of this Model.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Model.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Model.
custom_metadata_list (list[oci.data_science.models.Metadata]) – The value to assign to the custom_metadata_list property of this Model.
defined_metadata_list (list[oci.data_science.models.Metadata]) – The value to assign to the defined_metadata_list property of this Model.
input_schema (str) – The value to assign to the input_schema property of this Model.
output_schema (str) – The value to assign to the output_schema property of this Model.
model_version_set_id (str) – The value to assign to the model_version_set_id property of this Model.
model_version_set_name (str) – The value to assign to the model_version_set_name property of this Model.
version_id (int) – The value to assign to the version_id property of this Model.
version_label (str) – The value to assign to the version_label property of this Model.
category (str) – The value to assign to the category property of this Model. Allowed values for this property are: “USER”, “SERVICE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_model_by_reference (bool) – The value to assign to the is_model_by_reference property of this Model.
retention_setting (oci.data_science.models.RetentionSetting) – The value to assign to the retention_setting property of this Model.
backup_setting (oci.data_science.models.BackupSetting) – The value to assign to the backup_setting property of this Model.
retention_operation_details (oci.data_science.models.RetentionOperationDetails) – The value to assign to the retention_operation_details property of this Model.
backup_operation_details (oci.data_science.models.BackupOperationDetails) – The value to assign to the backup_operation_details property of this Model.

property backup_operation_details¶

[Required] Gets the backup_operation_details of this Model.

Returns: The backup_operation_details of this Model.
Return type: oci.data_science.models.BackupOperationDetails

property backup_setting¶

[Required] Gets the backup_setting of this Model.

Returns: The backup_setting of this Model.
Return type: oci.data_science.models.BackupSetting

property category¶

[Required] Gets the category of this Model. The category of the model.

Allowed values for this property are: “USER”, “SERVICE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The category of this Model.
Return type: str

property compartment_id¶

[Required] Gets the compartment_id of this Model. The OCID of the model’s compartment.

Returns: The compartment_id of this Model.
Return type: str

property created_by¶

[Required] Gets the created_by of this Model. The OCID of the user who created the model.

Returns: The created_by of this Model.
Return type: str

property custom_metadata_list¶

Gets the custom_metadata_list of this Model. An array of custom metadata details for the model.

Returns: The custom_metadata_list of this Model.
Return type: list[oci.data_science.models.Metadata]

property defined_metadata_list¶

Gets the defined_metadata_list of this Model. An array of defined metadata details for the model.

Returns: The defined_metadata_list of this Model.
Return type: list[oci.data_science.models.Metadata]

property defined_tags¶

Gets the defined_tags of this Model. 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 Model.
Return type: dict(str, dict(str, object))

property description¶

Gets the description of this Model. A short description of the model.

Returns: The description of this Model.
Return type: str

property display_name¶

[Required] Gets the display_name of this Model. A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.

Returns: The display_name of this Model.
Return type: str

property freeform_tags¶

Gets the freeform_tags of this Model. 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 Model.
Return type: dict(str, str)

property id¶

[Required] Gets the id of this Model. The OCID of the model.

Returns: The id of this Model.
Return type: str

property input_schema¶

Gets the input_schema of this Model. Input schema file content in String format

Returns: The input_schema of this Model.
Return type: str

property is_model_by_reference¶

[Required] Gets the is_model_by_reference of this Model. Identifier to indicate whether a model artifact resides in the Service Tenancy or Customer Tenancy.

Returns: The is_model_by_reference of this Model.
Return type: bool

property lifecycle_details¶

[Required] Gets the lifecycle_details of this Model. Details about the lifecycle state of the model.

Returns: The lifecycle_details of this Model.
Return type: str

property lifecycle_state¶

[Required] Gets the lifecycle_state of this Model. The state of the model.

Allowed values for this property are: “ACTIVE”, “DELETED”, “FAILED”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The lifecycle_state of this Model.
Return type: str

property model_version_set_id¶

[Required] Gets the model_version_set_id of this Model. The OCID of the model version set that the model is associated to.

Returns: The model_version_set_id of this Model.
Return type: str

property model_version_set_name¶

[Required] Gets the model_version_set_name of this Model. The name of the model version set that the model is associated to.

Returns: The model_version_set_name of this Model.
Return type: str

property output_schema¶

Gets the output_schema of this Model. Output schema file content in String format

Returns: The output_schema of this Model.
Return type: str

property project_id¶

[Required] Gets the project_id of this Model. The OCID of the project associated with the model.

Returns: The project_id of this Model.
Return type: str

property retention_operation_details¶

[Required] Gets the retention_operation_details of this Model.

Returns: The retention_operation_details of this Model.
Return type: oci.data_science.models.RetentionOperationDetails

property retention_setting¶

[Required] Gets the retention_setting of this Model.

Returns: The retention_setting of this Model.
Return type: oci.data_science.models.RetentionSetting

property time_created¶

[Required] Gets the time_created of this Model. The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z

Returns: The time_created of this Model.
Return type: datetime

property version_id¶

[Required] Gets the version_id of this Model. Unique identifier assigned to each version of the model.

Returns: The version_id of this Model.
Return type: int

property version_label¶

[Required] Gets the version_label of this Model. The version label can add an additional description of the lifecycle state of the model or the application using and training the model.

Returns: The version_label of this Model.
Return type: str