Class: Google::Cloud::AIPlatform::V1::ResourcePool

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/persistent_resource.rb

Overview

Represents the spec of a group of resources of the same type, for example machine type, disk, and accelerators, in a PersistentResource.

Defined Under Namespace

Classes: AutoscalingSpec

Instance Attribute Summary collapse

Instance Attribute Details

#autoscaling_spec ⇒ ::Google::Cloud::AIPlatform::V1::ResourcePool::AutoscalingSpec

Returns Optional. Optional spec to configure GKE or Ray-on-Vertex autoscaling.

Returns:



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'proto_docs/google/cloud/aiplatform/v1/persistent_resource.rb', line 170

class ResourcePool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The min/max number of replicas allowed if enabling autoscaling
  # @!attribute [rw] min_replica_count
  #   @return [::Integer]
  #     Optional. min replicas in the node pool,
  #     must be ≤ replica_count and < max_replica_count or will throw error.
  #     For autoscaling enabled Ray-on-Vertex, we allow min_replica_count of a
  #     resource_pool to be 0 to match the OSS Ray
  #     behavior(https://docs.ray.io/en/latest/cluster/vms/user-guides/configuring-autoscaling.html#cluster-config-parameters).
  #     As for Persistent Resource, the min_replica_count must be > 0, we added
  #     a corresponding validation inside
  #     CreatePersistentResourceRequestValidator.java.
  # @!attribute [rw] max_replica_count
  #   @return [::Integer]
  #     Optional. max replicas in the node pool,
  #     must be ≥ replica_count and > min_replica_count or will throw error
  class AutoscalingSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#disk_spec ⇒ ::Google::Cloud::AIPlatform::V1::DiskSpec

Returns Optional. Disk spec for the machine in this node pool.

Returns:



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'proto_docs/google/cloud/aiplatform/v1/persistent_resource.rb', line 170

class ResourcePool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The min/max number of replicas allowed if enabling autoscaling
  # @!attribute [rw] min_replica_count
  #   @return [::Integer]
  #     Optional. min replicas in the node pool,
  #     must be ≤ replica_count and < max_replica_count or will throw error.
  #     For autoscaling enabled Ray-on-Vertex, we allow min_replica_count of a
  #     resource_pool to be 0 to match the OSS Ray
  #     behavior(https://docs.ray.io/en/latest/cluster/vms/user-guides/configuring-autoscaling.html#cluster-config-parameters).
  #     As for Persistent Resource, the min_replica_count must be > 0, we added
  #     a corresponding validation inside
  #     CreatePersistentResourceRequestValidator.java.
  # @!attribute [rw] max_replica_count
  #   @return [::Integer]
  #     Optional. max replicas in the node pool,
  #     must be ≥ replica_count and > min_replica_count or will throw error
  class AutoscalingSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#id ⇒ ::String

Returns Immutable. The unique ID in a PersistentResource for referring to this resource pool. User can specify it if necessary. Otherwise, it's generated automatically.

Returns:

  • (::String) —

    Immutable. The unique ID in a PersistentResource for referring to this resource pool. User can specify it if necessary. Otherwise, it's generated automatically.



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'proto_docs/google/cloud/aiplatform/v1/persistent_resource.rb', line 170

class ResourcePool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The min/max number of replicas allowed if enabling autoscaling
  # @!attribute [rw] min_replica_count
  #   @return [::Integer]
  #     Optional. min replicas in the node pool,
  #     must be ≤ replica_count and < max_replica_count or will throw error.
  #     For autoscaling enabled Ray-on-Vertex, we allow min_replica_count of a
  #     resource_pool to be 0 to match the OSS Ray
  #     behavior(https://docs.ray.io/en/latest/cluster/vms/user-guides/configuring-autoscaling.html#cluster-config-parameters).
  #     As for Persistent Resource, the min_replica_count must be > 0, we added
  #     a corresponding validation inside
  #     CreatePersistentResourceRequestValidator.java.
  # @!attribute [rw] max_replica_count
  #   @return [::Integer]
  #     Optional. max replicas in the node pool,
  #     must be ≥ replica_count and > min_replica_count or will throw error
  class AutoscalingSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#machine_spec ⇒ ::Google::Cloud::AIPlatform::V1::MachineSpec

Returns Required. Immutable. The specification of a single machine.

Returns:



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'proto_docs/google/cloud/aiplatform/v1/persistent_resource.rb', line 170

class ResourcePool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The min/max number of replicas allowed if enabling autoscaling
  # @!attribute [rw] min_replica_count
  #   @return [::Integer]
  #     Optional. min replicas in the node pool,
  #     must be ≤ replica_count and < max_replica_count or will throw error.
  #     For autoscaling enabled Ray-on-Vertex, we allow min_replica_count of a
  #     resource_pool to be 0 to match the OSS Ray
  #     behavior(https://docs.ray.io/en/latest/cluster/vms/user-guides/configuring-autoscaling.html#cluster-config-parameters).
  #     As for Persistent Resource, the min_replica_count must be > 0, we added
  #     a corresponding validation inside
  #     CreatePersistentResourceRequestValidator.java.
  # @!attribute [rw] max_replica_count
  #   @return [::Integer]
  #     Optional. max replicas in the node pool,
  #     must be ≥ replica_count and > min_replica_count or will throw error
  class AutoscalingSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#replica_count ⇒ ::Integer

Returns Optional. The total number of machines to use for this resource pool.

Returns:

  • (::Integer) —

    Optional. The total number of machines to use for this resource pool.



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'proto_docs/google/cloud/aiplatform/v1/persistent_resource.rb', line 170

class ResourcePool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The min/max number of replicas allowed if enabling autoscaling
  # @!attribute [rw] min_replica_count
  #   @return [::Integer]
  #     Optional. min replicas in the node pool,
  #     must be ≤ replica_count and < max_replica_count or will throw error.
  #     For autoscaling enabled Ray-on-Vertex, we allow min_replica_count of a
  #     resource_pool to be 0 to match the OSS Ray
  #     behavior(https://docs.ray.io/en/latest/cluster/vms/user-guides/configuring-autoscaling.html#cluster-config-parameters).
  #     As for Persistent Resource, the min_replica_count must be > 0, we added
  #     a corresponding validation inside
  #     CreatePersistentResourceRequestValidator.java.
  # @!attribute [rw] max_replica_count
  #   @return [::Integer]
  #     Optional. max replicas in the node pool,
  #     must be ≥ replica_count and > min_replica_count or will throw error
  class AutoscalingSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#used_replica_count ⇒ ::Integer (readonly)

Returns Output only. The number of machines currently in use by training jobs for this resource pool. Will replace idle_replica_count.

Returns:

  • (::Integer) —

    Output only. The number of machines currently in use by training jobs for this resource pool. Will replace idle_replica_count.



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'proto_docs/google/cloud/aiplatform/v1/persistent_resource.rb', line 170

class ResourcePool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The min/max number of replicas allowed if enabling autoscaling
  # @!attribute [rw] min_replica_count
  #   @return [::Integer]
  #     Optional. min replicas in the node pool,
  #     must be ≤ replica_count and < max_replica_count or will throw error.
  #     For autoscaling enabled Ray-on-Vertex, we allow min_replica_count of a
  #     resource_pool to be 0 to match the OSS Ray
  #     behavior(https://docs.ray.io/en/latest/cluster/vms/user-guides/configuring-autoscaling.html#cluster-config-parameters).
  #     As for Persistent Resource, the min_replica_count must be > 0, we added
  #     a corresponding validation inside
  #     CreatePersistentResourceRequestValidator.java.
  # @!attribute [rw] max_replica_count
  #   @return [::Integer]
  #     Optional. max replicas in the node pool,
  #     must be ≥ replica_count and > min_replica_count or will throw error
  class AutoscalingSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end