ContainerSummary¶

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

Bases: object

Summary representation of a container

Attributes:

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ContainerSummary.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a ContainerSummary.
`TARGET_WORKLOADS_JOB_RUN`	A constant which can be used with the target_workloads property of a ContainerSummary.
`TARGET_WORKLOADS_MODEL_DEPLOYMENT`	A constant which can be used with the target_workloads property of a ContainerSummary.
`USAGES_BATCH_INFERENCE`	A constant which can be used with the usages property of a ContainerSummary.
`USAGES_EVALUATION`	A constant which can be used with the usages property of a ContainerSummary.
`USAGES_FINE_TUNE`	A constant which can be used with the usages property of a ContainerSummary.
`USAGES_INFERENCE`	A constant which can be used with the usages property of a ContainerSummary.
`USAGES_OTHER`	A constant which can be used with the usages property of a ContainerSummary.
`container_name`	[Required] Gets the container_name of this ContainerSummary.
`defined_tags`	Gets the defined_tags of this ContainerSummary.
`description`	Gets the description of this ContainerSummary.
`display_name`	Gets the display_name of this ContainerSummary.
`family_name`	Gets the family_name of this ContainerSummary.
`freeform_tags`	Gets the freeform_tags of this ContainerSummary.
`is_latest`	[Required] Gets the is_latest of this ContainerSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ContainerSummary.
`tag`	[Required] Gets the tag of this ContainerSummary.
`tag_configuration_list`	Gets the tag_configuration_list of this ContainerSummary.
`target_workloads`	Gets the target_workloads of this ContainerSummary.
`usages`	Gets the usages of this ContainerSummary.
`workload_configuration_details_list`	Gets the workload_configuration_details_list of this ContainerSummary.

Methods:

__init__(**kwargs)

Initializes a new ContainerSummary object with values from keyword arguments.

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

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

TARGET_WORKLOADS_JOB_RUN = 'JOB_RUN'¶: A constant which can be used with the target_workloads property of a ContainerSummary. This constant has a value of “JOB_RUN”

TARGET_WORKLOADS_MODEL_DEPLOYMENT = 'MODEL_DEPLOYMENT'¶: A constant which can be used with the target_workloads property of a ContainerSummary. This constant has a value of “MODEL_DEPLOYMENT”

USAGES_BATCH_INFERENCE = 'BATCH_INFERENCE'¶: A constant which can be used with the usages property of a ContainerSummary. This constant has a value of “BATCH_INFERENCE”

USAGES_EVALUATION = 'EVALUATION'¶: A constant which can be used with the usages property of a ContainerSummary. This constant has a value of “EVALUATION”

USAGES_FINE_TUNE = 'FINE_TUNE'¶: A constant which can be used with the usages property of a ContainerSummary. This constant has a value of “FINE_TUNE”

USAGES_INFERENCE = 'INFERENCE'¶: A constant which can be used with the usages property of a ContainerSummary. This constant has a value of “INFERENCE”

USAGES_OTHER = 'OTHER'¶: A constant which can be used with the usages property of a ContainerSummary. This constant has a value of “OTHER”

__init__(**kwargs)¶

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

Parameters

container_name (str) – The value to assign to the container_name property of this ContainerSummary.
display_name (str) – The value to assign to the display_name property of this ContainerSummary.
family_name (str) – The value to assign to the family_name property of this ContainerSummary.
description (str) – The value to assign to the description property of this ContainerSummary.
is_latest (bool) – The value to assign to the is_latest property of this ContainerSummary.
target_workloads (list[str]) – The value to assign to the target_workloads property of this ContainerSummary. Allowed values for items in this list are: “MODEL_DEPLOYMENT”, “JOB_RUN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
usages (list[str]) – The value to assign to the usages property of this ContainerSummary. Allowed values for items in this list are: “INFERENCE”, “FINE_TUNE”, “EVALUATION”, “BATCH_INFERENCE”, “OTHER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
tag (str) – The value to assign to the tag property of this ContainerSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ContainerSummary. Allowed values for this property are: “ACTIVE”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
workload_configuration_details_list (list[oci.data_science.models.WorkloadConfigurationDetails]) – The value to assign to the workload_configuration_details_list property of this ContainerSummary.
tag_configuration_list (list[oci.data_science.models.TagConfiguration]) – The value to assign to the tag_configuration_list property of this ContainerSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ContainerSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ContainerSummary.

property container_name¶

[Required] Gets the container_name of this ContainerSummary. The name of the container. This can be same for different tags

Returns: The container_name of this ContainerSummary.
Return type: str

property defined_tags¶

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

property description¶

Gets the description of this ContainerSummary. Description of the container.

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

property display_name¶

Gets the display_name of this ContainerSummary. The display name of the container.

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

property family_name¶

Gets the family_name of this ContainerSummary. The family name of the container.

Returns: The family_name of this ContainerSummary.
Return type: str

property freeform_tags¶

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

property is_latest¶

[Required] Gets the is_latest of this ContainerSummary. The latest tag of the container.

Returns: The is_latest of this ContainerSummary.
Return type: bool

property lifecycle_state¶

[Required] Gets the lifecycle_state of this ContainerSummary. Container Version LifecycleState.

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

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

property tag¶

[Required] Gets the tag of this ContainerSummary. Container Tag.

Returns: The tag of this ContainerSummary.
Return type: str

property tag_configuration_list¶

Gets the tag_configuration_list of this ContainerSummary. An array of defined metadata details for the model.

Returns: The tag_configuration_list of this ContainerSummary.
Return type: list[oci.data_science.models.TagConfiguration]

property target_workloads¶

Gets the target_workloads of this ContainerSummary. The list of target workload. This Container can be used with given data science resources.

Allowed values for items in this list are: “MODEL_DEPLOYMENT”, “JOB_RUN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The target_workloads of this ContainerSummary.
Return type: list[str]

property usages¶

Gets the usages of this ContainerSummary. The list of usages of this container. This Container can be used for given use-cases.

Allowed values for items in this list are: “INFERENCE”, “FINE_TUNE”, “EVALUATION”, “BATCH_INFERENCE”, “OTHER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The usages of this ContainerSummary.
Return type: list[str]

property workload_configuration_details_list¶

Gets the workload_configuration_details_list of this ContainerSummary. workload configuration of the container.

Returns: The workload_configuration_details_list of this ContainerSummary.
Return type: list[oci.data_science.models.WorkloadConfigurationDetails]