ModelGroupModelSummary¶

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

Bases: object

Summary information for a model associated with the model group.

Attributes:

`CATEGORY_SERVICE`	A constant which can be used with the category property of a ModelGroupModelSummary.
`CATEGORY_USER`	A constant which can be used with the category property of a ModelGroupModelSummary.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ModelGroupModelSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ModelGroupModelSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a ModelGroupModelSummary.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a ModelGroupModelSummary.
`category`	[Required] Gets the category of this ModelGroupModelSummary.
`compartment_id`	[Required] Gets the compartment_id of this ModelGroupModelSummary.
`created_by`	[Required] Gets the created_by of this ModelGroupModelSummary.
`defined_tags`	Gets the defined_tags of this ModelGroupModelSummary.
`display_name`	[Required] Gets the display_name of this ModelGroupModelSummary.
`freeform_tags`	Gets the freeform_tags of this ModelGroupModelSummary.
`id`	[Required] Gets the id of this ModelGroupModelSummary.
`inference_key`	Gets the inference_key of this ModelGroupModelSummary.
`is_model_by_reference`	[Required] Gets the is_model_by_reference of this ModelGroupModelSummary.
`lifecycle_details`	[Required] Gets the lifecycle_details of this ModelGroupModelSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ModelGroupModelSummary.
`model_id`	[Required] Gets the model_id of this ModelGroupModelSummary.
`project_id`	[Required] Gets the project_id of this ModelGroupModelSummary.
`system_tags`	Gets the system_tags of this ModelGroupModelSummary.
`time_created`	[Required] Gets the time_created of this ModelGroupModelSummary.
`time_updated`	[Required] Gets the time_updated of this ModelGroupModelSummary.

Methods:

__init__(**kwargs)

Initializes a new ModelGroupModelSummary object with values from keyword arguments.

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

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new ModelGroupModelSummary 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 ModelGroupModelSummary.
model_id (str) – The value to assign to the model_id property of this ModelGroupModelSummary.
inference_key (str) – The value to assign to the inference_key property of this ModelGroupModelSummary.
compartment_id (str) – The value to assign to the compartment_id property of this ModelGroupModelSummary.
project_id (str) – The value to assign to the project_id property of this ModelGroupModelSummary.
display_name (str) – The value to assign to the display_name property of this ModelGroupModelSummary.
created_by (str) – The value to assign to the created_by property of this ModelGroupModelSummary.
time_created (datetime) – The value to assign to the time_created property of this ModelGroupModelSummary.
time_updated (datetime) – The value to assign to the time_updated property of this ModelGroupModelSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ModelGroupModelSummary. 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 ModelGroupModelSummary.
category (str) – The value to assign to the category property of this ModelGroupModelSummary. 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 ModelGroupModelSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ModelGroupModelSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ModelGroupModelSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ModelGroupModelSummary.

property category¶

[Required] Gets the category of this ModelGroupModelSummary. 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 ModelGroupModelSummary.
Return type: str

property compartment_id¶

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

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

property created_by¶

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

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

property defined_tags¶

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

property display_name¶

[Required] Gets the display_name of this ModelGroupModelSummary. A user-friendly display name of the model.

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

property freeform_tags¶

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

property id¶

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

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

property inference_key¶

Gets the inference_key of this ModelGroupModelSummary. SaaS friendly name of the model.

Returns: The inference_key of this ModelGroupModelSummary.
Return type: str

property is_model_by_reference¶

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

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

property lifecycle_details¶

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

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

property lifecycle_state¶

[Required] Gets the lifecycle_state of this ModelGroupModelSummary. 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 ModelGroupModelSummary.
Return type: str

property model_id¶

[Required] Gets the model_id of this ModelGroupModelSummary. The OCID of the model.

Returns: The model_id of this ModelGroupModelSummary.
Return type: str

property project_id¶

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

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

property system_tags¶

Gets the system_tags of this ModelGroupModelSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns: The system_tags of this ModelGroupModelSummary.
Return type: dict(str, dict(str, object))

property time_created¶

[Required] Gets the time_created of this ModelGroupModelSummary. 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 ModelGroupModelSummary.
Return type: datetime

property time_updated¶

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

Returns: The time_updated of this ModelGroupModelSummary.
Return type: datetime