com.google.api.services.ml.v1.model

Class GoogleCloudMlV1ReplicaConfig

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.ml.v1.model.GoogleCloudMlV1ReplicaConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudMlV1ReplicaConfig
extends GenericJson

Represents the configuration for a replica in a cluster.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the AI Platform Training & Prediction API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GoogleCloudMlV1ReplicaConfig()

Method Summary

Modifier and Type	Method and Description
GoogleCloudMlV1ReplicaConfig	clone()
GoogleCloudMlV1AcceleratorConfig	getAcceleratorConfig() Represents the type and number of accelerators used by the replica.
List<String>	getContainerArgs() Arguments to the entrypoint command.
List<String>	getContainerCommand() The command with which the replica's custom container is run.
GoogleCloudMlV1DiskConfig	getDiskConfig() Represents the configuration of disk options.
String	getImageUri() The Docker image to run on the replica.
String	getTpuTfVersion() The AI Platform runtime version that includes a TensorFlow version matching the one used in the custom container.
GoogleCloudMlV1ReplicaConfig	set(String fieldName, Object value)
GoogleCloudMlV1ReplicaConfig	setAcceleratorConfig(GoogleCloudMlV1AcceleratorConfig acceleratorConfig) Represents the type and number of accelerators used by the replica.
GoogleCloudMlV1ReplicaConfig	setContainerArgs(List<String> containerArgs) Arguments to the entrypoint command.
GoogleCloudMlV1ReplicaConfig	setContainerCommand(List<String> containerCommand) The command with which the replica's custom container is run.
GoogleCloudMlV1ReplicaConfig	setDiskConfig(GoogleCloudMlV1DiskConfig diskConfig) Represents the configuration of disk options.
GoogleCloudMlV1ReplicaConfig	setImageUri(String imageUri) The Docker image to run on the replica.
GoogleCloudMlV1ReplicaConfig	setTpuTfVersion(String tpuTfVersion) The AI Platform runtime version that includes a TensorFlow version matching the one used in the custom container.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GoogleCloudMlV1ReplicaConfig

public GoogleCloudMlV1ReplicaConfig()

Method Detail

getAcceleratorConfig

public GoogleCloudMlV1AcceleratorConfig getAcceleratorConfig()

Represents the type and number of accelerators used by the replica. [Learn about restrictions on accelerator configurations for training.](/ai-platform/training/docs/using-gpus#compute- engine-machine-types-with-gpu)

Returns:

value or null for none

setAcceleratorConfig

public GoogleCloudMlV1ReplicaConfig setAcceleratorConfig(GoogleCloudMlV1AcceleratorConfig acceleratorConfig)

Represents the type and number of accelerators used by the replica. [Learn about restrictions on accelerator configurations for training.](/ai-platform/training/docs/using-gpus#compute- engine-machine-types-with-gpu)

Parameters:

acceleratorConfig - acceleratorConfig or null for none

getContainerArgs

public List<String> getContainerArgs()

Arguments to the entrypoint command. The following rules apply for container_command and container_args: - If you do not supply command or args: The defaults defined in the Docker image are used. - If you supply a command but no args: The default EntryPoint and the default Cmd defined in the Docker image are ignored. Your command is run without any arguments. - If you supply only args: The default Entrypoint defined in the Docker image is run with the args that you supplied. - If you supply a command and args: The default Entrypoint and the default Cmd defined in the Docker image are ignored. Your command is run with your args. It cannot be set if custom container image is not provided. Note that this field and [TrainingInput.args] are mutually exclusive, i.e., both cannot be set at the same time.

Returns:

value or null for none

setContainerArgs

public GoogleCloudMlV1ReplicaConfig setContainerArgs(List<String> containerArgs)

Arguments to the entrypoint command. The following rules apply for container_command and container_args: - If you do not supply command or args: The defaults defined in the Docker image are used. - If you supply a command but no args: The default EntryPoint and the default Cmd defined in the Docker image are ignored. Your command is run without any arguments. - If you supply only args: The default Entrypoint defined in the Docker image is run with the args that you supplied. - If you supply a command and args: The default Entrypoint and the default Cmd defined in the Docker image are ignored. Your command is run with your args. It cannot be set if custom container image is not provided. Note that this field and [TrainingInput.args] are mutually exclusive, i.e., both cannot be set at the same time.

Parameters:

containerArgs - containerArgs or null for none

getContainerCommand

public List<String> getContainerCommand()

The command with which the replica's custom container is run. If provided, it will override default ENTRYPOINT of the docker image. If not provided, the docker image's ENTRYPOINT is used. It cannot be set if custom container image is not provided. Note that this field and [TrainingInput.args] are mutually exclusive, i.e., both cannot be set at the same time.

Returns:

value or null for none

setContainerCommand

public GoogleCloudMlV1ReplicaConfig setContainerCommand(List<String> containerCommand)

The command with which the replica's custom container is run. If provided, it will override default ENTRYPOINT of the docker image. If not provided, the docker image's ENTRYPOINT is used. It cannot be set if custom container image is not provided. Note that this field and [TrainingInput.args] are mutually exclusive, i.e., both cannot be set at the same time.

Parameters:

containerCommand - containerCommand or null for none

getDiskConfig

public GoogleCloudMlV1DiskConfig getDiskConfig()

Represents the configuration of disk options.

Returns:

value or null for none

setDiskConfig

public GoogleCloudMlV1ReplicaConfig setDiskConfig(GoogleCloudMlV1DiskConfig diskConfig)

Represents the configuration of disk options.

Parameters:

diskConfig - diskConfig or null for none

getImageUri

public String getImageUri()

The Docker image to run on the replica. This image must be in Container Registry. Learn more about [configuring custom containers](/ai-platform/training/docs/distributed-training- containers).

Returns:

value or null for none

setImageUri

public GoogleCloudMlV1ReplicaConfig setImageUri(String imageUri)

The Docker image to run on the replica. This image must be in Container Registry. Learn more about [configuring custom containers](/ai-platform/training/docs/distributed-training- containers).

Parameters:

imageUri - imageUri or null for none

getTpuTfVersion

public String getTpuTfVersion()

The AI Platform runtime version that includes a TensorFlow version matching the one used in the custom container. This field is required if the replica is a TPU worker that uses a custom container. Otherwise, do not specify this field. This must be a [runtime version that currently supports training with TPUs](/ml-engine/docs/tensorflow/runtime-version-list#tpu-support). Note that the version of TensorFlow included in a runtime version may differ from the numbering of the runtime version itself, because it may have a different [patch version](https://www.tensorflow.org/guide/version_compat#semantic_versioning_20). In this field, you must specify the runtime version (TensorFlow minor version). For example, if your custom container runs TensorFlow `1.x.y`, specify `1.x`.

Returns:

value or null for none

setTpuTfVersion

public GoogleCloudMlV1ReplicaConfig setTpuTfVersion(String tpuTfVersion)

The AI Platform runtime version that includes a TensorFlow version matching the one used in the custom container. This field is required if the replica is a TPU worker that uses a custom container. Otherwise, do not specify this field. This must be a [runtime version that currently supports training with TPUs](/ml-engine/docs/tensorflow/runtime-version-list#tpu-support). Note that the version of TensorFlow included in a runtime version may differ from the numbering of the runtime version itself, because it may have a different [patch version](https://www.tensorflow.org/guide/version_compat#semantic_versioning_20). In this field, you must specify the runtime version (TensorFlow minor version). For example, if your custom container runs TensorFlow `1.x.y`, specify `1.x`.

Parameters:

tpuTfVersion - tpuTfVersion or null for none

set

public GoogleCloudMlV1ReplicaConfig set(String fieldName,
                                        Object value)

Overrides:

set in class GenericJson

clone

public GoogleCloudMlV1ReplicaConfig clone()

Overrides:

clone in class GenericJson