ModelDeployment¶

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

Bases: object

Model deployments are used by data scientists to perform predictions from the model hosted on an HTTP server.

Attributes:

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ModelDeployment.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a ModelDeployment.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ModelDeployment.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a ModelDeployment.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a ModelDeployment.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a ModelDeployment.
`LIFECYCLE_STATE_NEEDS_ATTENTION`	A constant which can be used with the lifecycle_state property of a ModelDeployment.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a ModelDeployment.
`category_log_details`	Gets the category_log_details of this ModelDeployment.
`compartment_id`	[Required] Gets the compartment_id of this ModelDeployment.
`created_by`	[Required] Gets the created_by of this ModelDeployment.
`defined_tags`	Gets the defined_tags of this ModelDeployment.
`description`	Gets the description of this ModelDeployment.
`display_name`	[Required] Gets the display_name of this ModelDeployment.
`freeform_tags`	Gets the freeform_tags of this ModelDeployment.
`id`	[Required] Gets the id of this ModelDeployment.
`lifecycle_details`	Gets the lifecycle_details of this ModelDeployment.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ModelDeployment.
`model_deployment_configuration_details`	Gets the model_deployment_configuration_details of this ModelDeployment.
`model_deployment_system_data`	Gets the model_deployment_system_data of this ModelDeployment.
`model_deployment_url`	[Required] Gets the model_deployment_url of this ModelDeployment.
`project_id`	[Required] Gets the project_id of this ModelDeployment.
`time_created`	[Required] Gets the time_created of this ModelDeployment.

Methods:

__init__(**kwargs)

Initializes a new ModelDeployment object with values from keyword arguments.

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

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a ModelDeployment. This constant has a value of “CREATING”

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

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a ModelDeployment. This constant has a value of “DELETING”

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

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

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the lifecycle_state property of a ModelDeployment. This constant has a value of “NEEDS_ATTENTION”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a ModelDeployment. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new ModelDeployment 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 ModelDeployment.
time_created (datetime) – The value to assign to the time_created property of this ModelDeployment.
display_name (str) – The value to assign to the display_name property of this ModelDeployment.
description (str) – The value to assign to the description property of this ModelDeployment.
project_id (str) – The value to assign to the project_id property of this ModelDeployment.
created_by (str) – The value to assign to the created_by property of this ModelDeployment.
compartment_id (str) – The value to assign to the compartment_id property of this ModelDeployment.
model_deployment_configuration_details (oci.data_science.models.ModelDeploymentConfigurationDetails) – The value to assign to the model_deployment_configuration_details property of this ModelDeployment.
category_log_details (oci.data_science.models.CategoryLogDetails) – The value to assign to the category_log_details property of this ModelDeployment.
model_deployment_url (str) – The value to assign to the model_deployment_url property of this ModelDeployment.
model_deployment_system_data (oci.data_science.models.ModelDeploymentSystemData) – The value to assign to the model_deployment_system_data property of this ModelDeployment.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ModelDeployment. Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “FAILED”, “INACTIVE”, “UPDATING”, “DELETED”, “NEEDS_ATTENTION”, ‘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 ModelDeployment.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ModelDeployment.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ModelDeployment.

property category_log_details¶

Gets the category_log_details of this ModelDeployment.

Returns: The category_log_details of this ModelDeployment.
Return type: oci.data_science.models.CategoryLogDetails

property compartment_id¶

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

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

property created_by¶

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

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

property defined_tags¶

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

property description¶

Gets the description of this ModelDeployment. A short description of the model deployment.

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

property display_name¶

[Required] Gets the display_name of this ModelDeployment. A user-friendly display name for the resource. Does not have to be unique, and can be modified. Avoid entering confidential information. Example: My ModelDeployment

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

property freeform_tags¶

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

property id¶

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

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

property lifecycle_details¶

Gets the lifecycle_details of this ModelDeployment. Details about the state of the model deployment.

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

property lifecycle_state¶

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

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

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

property model_deployment_configuration_details¶

Gets the model_deployment_configuration_details of this ModelDeployment.

Returns: The model_deployment_configuration_details of this ModelDeployment.
Return type: oci.data_science.models.ModelDeploymentConfigurationDetails

property model_deployment_system_data¶

Gets the model_deployment_system_data of this ModelDeployment.

Returns: The model_deployment_system_data of this ModelDeployment.
Return type: oci.data_science.models.ModelDeploymentSystemData

property model_deployment_url¶

[Required] Gets the model_deployment_url of this ModelDeployment. The URL to interact with the model deployment.

Returns: The model_deployment_url of this ModelDeployment.
Return type: str

property project_id¶

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

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

property time_created¶

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