DedicatedAiCluster¶

class oci.generative_ai.models.DedicatedAiCluster(**kwargs)¶

Bases: object

Dedicated AI clusters are compute resources that you can use for fine-tuning custom models or for hosting endpoints for custom models. The clusters are dedicated to your models and not shared with users in other tenancies.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator who gives OCI resource access to users. See Getting Started with Policies and Getting Access to Generative AI Resouces.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a DedicatedAiCluster.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a DedicatedAiCluster.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a DedicatedAiCluster.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a DedicatedAiCluster.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a DedicatedAiCluster.
`LIFECYCLE_STATE_NEEDS_ATTENTION`	A constant which can be used with the lifecycle_state property of a DedicatedAiCluster.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a DedicatedAiCluster.
`TYPE_FINE_TUNING`	A constant which can be used with the type property of a DedicatedAiCluster.
`TYPE_HOSTING`	A constant which can be used with the type property of a DedicatedAiCluster.
`UNIT_SHAPE_EMBED_COHERE`	A constant which can be used with the unit_shape property of a DedicatedAiCluster.
`UNIT_SHAPE_LARGE_COHERE`	A constant which can be used with the unit_shape property of a DedicatedAiCluster.
`UNIT_SHAPE_LARGE_COHERE_V2`	A constant which can be used with the unit_shape property of a DedicatedAiCluster.
`UNIT_SHAPE_LARGE_COHERE_V2_2`	A constant which can be used with the unit_shape property of a DedicatedAiCluster.
`UNIT_SHAPE_LARGE_GENERIC`	A constant which can be used with the unit_shape property of a DedicatedAiCluster.
`UNIT_SHAPE_LARGE_GENERIC_4`	A constant which can be used with the unit_shape property of a DedicatedAiCluster.
`UNIT_SHAPE_LLAMA2_70`	A constant which can be used with the unit_shape property of a DedicatedAiCluster.
`UNIT_SHAPE_SMALL_COHERE`	A constant which can be used with the unit_shape property of a DedicatedAiCluster.
`UNIT_SHAPE_SMALL_COHERE_V2`	A constant which can be used with the unit_shape property of a DedicatedAiCluster.
`capacity`	Gets the capacity of this DedicatedAiCluster.
`compartment_id`	[Required] Gets the compartment_id of this DedicatedAiCluster.
`defined_tags`	Gets the defined_tags of this DedicatedAiCluster.
`description`	Gets the description of this DedicatedAiCluster.
`display_name`	Gets the display_name of this DedicatedAiCluster.
`freeform_tags`	Gets the freeform_tags of this DedicatedAiCluster.
`id`	[Required] Gets the id of this DedicatedAiCluster.
`lifecycle_details`	Gets the lifecycle_details of this DedicatedAiCluster.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DedicatedAiCluster.
`previous_state`	Gets the previous_state of this DedicatedAiCluster.
`system_tags`	Gets the system_tags of this DedicatedAiCluster.
`time_created`	[Required] Gets the time_created of this DedicatedAiCluster.
`time_updated`	Gets the time_updated of this DedicatedAiCluster.
`type`	[Required] Gets the type of this DedicatedAiCluster.
`unit_count`	[Required] Gets the unit_count of this DedicatedAiCluster.
`unit_shape`	[Required] Gets the unit_shape of this DedicatedAiCluster.

Methods

__init__(**kwargs) Initializes a new DedicatedAiCluster object with values from keyword arguments.

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

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

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

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

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

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the lifecycle_state property of a DedicatedAiCluster. 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 DedicatedAiCluster. This constant has a value of “UPDATING”

TYPE_FINE_TUNING = 'FINE_TUNING'¶: A constant which can be used with the type property of a DedicatedAiCluster. This constant has a value of “FINE_TUNING”

TYPE_HOSTING = 'HOSTING'¶: A constant which can be used with the type property of a DedicatedAiCluster. This constant has a value of “HOSTING”

UNIT_SHAPE_EMBED_COHERE = 'EMBED_COHERE'¶: A constant which can be used with the unit_shape property of a DedicatedAiCluster. This constant has a value of “EMBED_COHERE”

UNIT_SHAPE_LARGE_COHERE = 'LARGE_COHERE'¶: A constant which can be used with the unit_shape property of a DedicatedAiCluster. This constant has a value of “LARGE_COHERE”

UNIT_SHAPE_LARGE_COHERE_V2 = 'LARGE_COHERE_V2'¶: A constant which can be used with the unit_shape property of a DedicatedAiCluster. This constant has a value of “LARGE_COHERE_V2”

UNIT_SHAPE_LARGE_COHERE_V2_2 = 'LARGE_COHERE_V2_2'¶: A constant which can be used with the unit_shape property of a DedicatedAiCluster. This constant has a value of “LARGE_COHERE_V2_2”

UNIT_SHAPE_LARGE_GENERIC = 'LARGE_GENERIC'¶: A constant which can be used with the unit_shape property of a DedicatedAiCluster. This constant has a value of “LARGE_GENERIC”

UNIT_SHAPE_LARGE_GENERIC_4 = 'LARGE_GENERIC_4'¶: A constant which can be used with the unit_shape property of a DedicatedAiCluster. This constant has a value of “LARGE_GENERIC_4”

UNIT_SHAPE_LLAMA2_70 = 'LLAMA2_70'¶: A constant which can be used with the unit_shape property of a DedicatedAiCluster. This constant has a value of “LLAMA2_70”

UNIT_SHAPE_SMALL_COHERE = 'SMALL_COHERE'¶: A constant which can be used with the unit_shape property of a DedicatedAiCluster. This constant has a value of “SMALL_COHERE”

UNIT_SHAPE_SMALL_COHERE_V2 = 'SMALL_COHERE_V2'¶: A constant which can be used with the unit_shape property of a DedicatedAiCluster. This constant has a value of “SMALL_COHERE_V2”

__init__(**kwargs)¶

Initializes a new DedicatedAiCluster 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 DedicatedAiCluster.
display_name (str) – The value to assign to the display_name property of this DedicatedAiCluster.
description (str) – The value to assign to the description property of this DedicatedAiCluster.
type (str) – The value to assign to the type property of this DedicatedAiCluster. Allowed values for this property are: “HOSTING”, “FINE_TUNING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
compartment_id (str) – The value to assign to the compartment_id property of this DedicatedAiCluster.
time_created (datetime) – The value to assign to the time_created property of this DedicatedAiCluster.
time_updated (datetime) – The value to assign to the time_updated property of this DedicatedAiCluster.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DedicatedAiCluster. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “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 DedicatedAiCluster.
unit_count (int) – The value to assign to the unit_count property of this DedicatedAiCluster.
unit_shape (str) – The value to assign to the unit_shape property of this DedicatedAiCluster. Allowed values for this property are: “LARGE_COHERE”, “LARGE_COHERE_V2”, “SMALL_COHERE”, “SMALL_COHERE_V2”, “EMBED_COHERE”, “LLAMA2_70”, “LARGE_GENERIC”, “LARGE_COHERE_V2_2”, “LARGE_GENERIC_4”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
capacity (oci.generative_ai.models.DedicatedAiClusterCapacity) – The value to assign to the capacity property of this DedicatedAiCluster.
previous_state (oci.generative_ai.models.DedicatedAiCluster) – The value to assign to the previous_state property of this DedicatedAiCluster.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DedicatedAiCluster.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DedicatedAiCluster.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DedicatedAiCluster.

capacity¶

Gets the capacity of this DedicatedAiCluster.

Returns:	The capacity of this DedicatedAiCluster.
Return type:	oci.generative_ai.models.DedicatedAiClusterCapacity

compartment_id¶

[Required] Gets the compartment_id of this DedicatedAiCluster. The compartment OCID to create the dedicated AI cluster in.

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

defined_tags¶

Gets the defined_tags of this DedicatedAiCluster. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this DedicatedAiCluster.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this DedicatedAiCluster. An optional description of the dedicated AI cluster.

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

display_name¶

Gets the display_name of this DedicatedAiCluster. A user-friendly name. Does not have to be unique, and it’s changeable.

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

freeform_tags¶

Gets the freeform_tags of this DedicatedAiCluster. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this DedicatedAiCluster.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this DedicatedAiCluster. The OCID of the dedicated AI cluster.

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

lifecycle_details¶

Gets the lifecycle_details of this DedicatedAiCluster. A message describing the current state with detail that can provide actionable information.

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this DedicatedAiCluster. The current state of the dedicated AI cluster.

Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “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 DedicatedAiCluster.
Return type:	str

previous_state¶

Gets the previous_state of this DedicatedAiCluster.

Returns:	The previous_state of this DedicatedAiCluster.
Return type:	oci.generative_ai.models.DedicatedAiCluster

system_tags¶

Gets the system_tags of this DedicatedAiCluster. System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

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

time_created¶

[Required] Gets the time_created of this DedicatedAiCluster. The date and time the dedicated AI cluster was created, in the format defined by RFC 3339

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

time_updated¶

Gets the time_updated of this DedicatedAiCluster. The date and time the dedicated AI cluster was updated, in the format defined by RFC 3339

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

type¶

[Required] Gets the type of this DedicatedAiCluster. The dedicated AI cluster type indicating whether this is a fine-tuning/training processor or hosting/inference processor.

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

Returns:	The type of this DedicatedAiCluster.
Return type:	str

unit_count¶

[Required] Gets the unit_count of this DedicatedAiCluster. The number of dedicated units in this AI cluster.

Returns:	The unit_count of this DedicatedAiCluster.
Return type:	int

unit_shape¶

[Required] Gets the unit_shape of this DedicatedAiCluster. The shape of dedicated unit in this AI cluster. The underlying hardware configuration is hidden from customers.

Allowed values for this property are: “LARGE_COHERE”, “LARGE_COHERE_V2”, “SMALL_COHERE”, “SMALL_COHERE_V2”, “EMBED_COHERE”, “LLAMA2_70”, “LARGE_GENERIC”, “LARGE_COHERE_V2_2”, “LARGE_GENERIC_4”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The unit_shape of this DedicatedAiCluster.
Return type:	str