ModelDeploymentModelStateSummary¶

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

Bases: object

Status of the model in a model group deployment.

Attributes:

`STATE_FAILED`	A constant which can be used with the state property of a ModelDeploymentModelStateSummary.
`STATE_INCONSISTENT`	A constant which can be used with the state property of a ModelDeploymentModelStateSummary.
`STATE_SUCCESS`	A constant which can be used with the state property of a ModelDeploymentModelStateSummary.
`defined_tags`	Gets the defined_tags of this ModelDeploymentModelStateSummary.
`display_name`	[Required] Gets the display_name of this ModelDeploymentModelStateSummary.
`freeform_tags`	Gets the freeform_tags of this ModelDeploymentModelStateSummary.
`inference_key`	[Required] Gets the inference_key of this ModelDeploymentModelStateSummary.
`model_id`	[Required] Gets the model_id of this ModelDeploymentModelStateSummary.
`project_id`	[Required] Gets the project_id of this ModelDeploymentModelStateSummary.
`state`	[Required] Gets the state of this ModelDeploymentModelStateSummary.
`system_tags`	Gets the system_tags of this ModelDeploymentModelStateSummary.

Methods:

__init__(**kwargs)

Initializes a new ModelDeploymentModelStateSummary object with values from keyword arguments.

STATE_FAILED = 'FAILED'¶: A constant which can be used with the state property of a ModelDeploymentModelStateSummary. This constant has a value of “FAILED”

STATE_INCONSISTENT = 'INCONSISTENT'¶: A constant which can be used with the state property of a ModelDeploymentModelStateSummary. This constant has a value of “INCONSISTENT”

STATE_SUCCESS = 'SUCCESS'¶: A constant which can be used with the state property of a ModelDeploymentModelStateSummary. This constant has a value of “SUCCESS”

__init__(**kwargs)¶

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

Parameters

model_id (str) – The value to assign to the model_id property of this ModelDeploymentModelStateSummary.
project_id (str) – The value to assign to the project_id property of this ModelDeploymentModelStateSummary.
display_name (str) – The value to assign to the display_name property of this ModelDeploymentModelStateSummary.
inference_key (str) – The value to assign to the inference_key property of this ModelDeploymentModelStateSummary.
state (str) – The value to assign to the state property of this ModelDeploymentModelStateSummary. Allowed values for this property are: “SUCCESS”, “FAILED”, “INCONSISTENT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ModelDeploymentModelStateSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ModelDeploymentModelStateSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ModelDeploymentModelStateSummary.

property defined_tags¶

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

property display_name¶

[Required] Gets the display_name of this ModelDeploymentModelStateSummary. A user-friendly display name for the resource.

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

property freeform_tags¶

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

property inference_key¶

[Required] Gets the inference_key of this ModelDeploymentModelStateSummary. SaaS friendly name for the model OCID.

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

property model_id¶

[Required] Gets the model_id of this ModelDeploymentModelStateSummary. The OCID of the deployed model in model deployment.

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

property project_id¶

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

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

property state¶

[Required] Gets the state of this ModelDeploymentModelStateSummary. The state of the deployed model in model deployment.

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

Returns: The state of this ModelDeploymentModelStateSummary.
Return type: str

property system_tags¶

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