Class SupervisedTuningSpec.Builder (3.88.0)

public static final class SupervisedTuningSpec.Builder extends GeneratedMessage.Builder<SupervisedTuningSpec.Builder> implements SupervisedTuningSpecOrBuilder

Tuning Spec for Supervised Tuning for first party models.

Protobuf type google.cloud.aiplatform.v1beta1.SupervisedTuningSpec

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public SupervisedTuningSpec build()
Returns
Type Description
SupervisedTuningSpec

buildPartial()

public SupervisedTuningSpec buildPartial()
Returns
Type Description
SupervisedTuningSpec

clear()

public SupervisedTuningSpec.Builder clear()
Returns
Type Description
SupervisedTuningSpec.Builder
Overrides

clearEvaluationConfig()

public SupervisedTuningSpec.Builder clearEvaluationConfig()

Optional. Evaluation Config for Tuning Job.

.google.cloud.aiplatform.v1beta1.EvaluationConfig evaluation_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SupervisedTuningSpec.Builder

clearExportLastCheckpointOnly()

public SupervisedTuningSpec.Builder clearExportLastCheckpointOnly()

Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false.

bool export_last_checkpoint_only = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SupervisedTuningSpec.Builder

This builder for chaining.

clearHyperParameters()

public SupervisedTuningSpec.Builder clearHyperParameters()

Optional. Hyperparameters for SFT.

.google.cloud.aiplatform.v1beta1.SupervisedHyperParameters hyper_parameters = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SupervisedTuningSpec.Builder

clearTrainingDatasetUri()

public SupervisedTuningSpec.Builder clearTrainingDatasetUri()

Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.

string training_dataset_uri = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SupervisedTuningSpec.Builder

This builder for chaining.

clearTuningMode()

public SupervisedTuningSpec.Builder clearTuningMode()

Tuning mode.

.google.cloud.aiplatform.v1beta1.SupervisedTuningSpec.TuningMode tuning_mode = 7;

Returns
Type Description
SupervisedTuningSpec.Builder

This builder for chaining.

clearValidationDatasetUri()

public SupervisedTuningSpec.Builder clearValidationDatasetUri()

Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.

string validation_dataset_uri = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SupervisedTuningSpec.Builder

This builder for chaining.

getDefaultInstanceForType()

public SupervisedTuningSpec getDefaultInstanceForType()
Returns
Type Description
SupervisedTuningSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEvaluationConfig()

public EvaluationConfig getEvaluationConfig()

Optional. Evaluation Config for Tuning Job.

.google.cloud.aiplatform.v1beta1.EvaluationConfig evaluation_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EvaluationConfig

The evaluationConfig.

getEvaluationConfigBuilder()

public EvaluationConfig.Builder getEvaluationConfigBuilder()

Optional. Evaluation Config for Tuning Job.

.google.cloud.aiplatform.v1beta1.EvaluationConfig evaluation_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EvaluationConfig.Builder

getEvaluationConfigOrBuilder()

public EvaluationConfigOrBuilder getEvaluationConfigOrBuilder()

Optional. Evaluation Config for Tuning Job.

.google.cloud.aiplatform.v1beta1.EvaluationConfig evaluation_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EvaluationConfigOrBuilder

getExportLastCheckpointOnly()

public boolean getExportLastCheckpointOnly()

Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false.

bool export_last_checkpoint_only = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The exportLastCheckpointOnly.

getHyperParameters()

public SupervisedHyperParameters getHyperParameters()

Optional. Hyperparameters for SFT.

.google.cloud.aiplatform.v1beta1.SupervisedHyperParameters hyper_parameters = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SupervisedHyperParameters

The hyperParameters.

getHyperParametersBuilder()

public SupervisedHyperParameters.Builder getHyperParametersBuilder()

Optional. Hyperparameters for SFT.

.google.cloud.aiplatform.v1beta1.SupervisedHyperParameters hyper_parameters = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SupervisedHyperParameters.Builder

getHyperParametersOrBuilder()

public SupervisedHyperParametersOrBuilder getHyperParametersOrBuilder()

Optional. Hyperparameters for SFT.

.google.cloud.aiplatform.v1beta1.SupervisedHyperParameters hyper_parameters = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SupervisedHyperParametersOrBuilder

getTrainingDatasetUri()

public String getTrainingDatasetUri()

Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.

string training_dataset_uri = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The trainingDatasetUri.

getTrainingDatasetUriBytes()

public ByteString getTrainingDatasetUriBytes()

Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.

string training_dataset_uri = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for trainingDatasetUri.

getTuningMode()

public SupervisedTuningSpec.TuningMode getTuningMode()

Tuning mode.

.google.cloud.aiplatform.v1beta1.SupervisedTuningSpec.TuningMode tuning_mode = 7;

Returns
Type Description
SupervisedTuningSpec.TuningMode

The tuningMode.

getTuningModeValue()

public int getTuningModeValue()

Tuning mode.

.google.cloud.aiplatform.v1beta1.SupervisedTuningSpec.TuningMode tuning_mode = 7;

Returns
Type Description
int

The enum numeric value on the wire for tuningMode.

getValidationDatasetUri()

public String getValidationDatasetUri()

Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.

string validation_dataset_uri = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The validationDatasetUri.

getValidationDatasetUriBytes()

public ByteString getValidationDatasetUriBytes()

Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.

string validation_dataset_uri = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for validationDatasetUri.

hasEvaluationConfig()

public boolean hasEvaluationConfig()

Optional. Evaluation Config for Tuning Job.

.google.cloud.aiplatform.v1beta1.EvaluationConfig evaluation_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the evaluationConfig field is set.

hasHyperParameters()

public boolean hasHyperParameters()

Optional. Hyperparameters for SFT.

.google.cloud.aiplatform.v1beta1.SupervisedHyperParameters hyper_parameters = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the hyperParameters field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEvaluationConfig(EvaluationConfig value)

public SupervisedTuningSpec.Builder mergeEvaluationConfig(EvaluationConfig value)

Optional. Evaluation Config for Tuning Job.

.google.cloud.aiplatform.v1beta1.EvaluationConfig evaluation_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value EvaluationConfig
Returns
Type Description
SupervisedTuningSpec.Builder

mergeFrom(SupervisedTuningSpec other)

public SupervisedTuningSpec.Builder mergeFrom(SupervisedTuningSpec other)
Parameter
Name Description
other SupervisedTuningSpec
Returns
Type Description
SupervisedTuningSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SupervisedTuningSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SupervisedTuningSpec.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SupervisedTuningSpec.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SupervisedTuningSpec.Builder
Overrides

mergeHyperParameters(SupervisedHyperParameters value)

public SupervisedTuningSpec.Builder mergeHyperParameters(SupervisedHyperParameters value)

Optional. Hyperparameters for SFT.

.google.cloud.aiplatform.v1beta1.SupervisedHyperParameters hyper_parameters = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value SupervisedHyperParameters
Returns
Type Description
SupervisedTuningSpec.Builder

setEvaluationConfig(EvaluationConfig value)

public SupervisedTuningSpec.Builder setEvaluationConfig(EvaluationConfig value)

Optional. Evaluation Config for Tuning Job.

.google.cloud.aiplatform.v1beta1.EvaluationConfig evaluation_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value EvaluationConfig
Returns
Type Description
SupervisedTuningSpec.Builder

setEvaluationConfig(EvaluationConfig.Builder builderForValue)

public SupervisedTuningSpec.Builder setEvaluationConfig(EvaluationConfig.Builder builderForValue)

Optional. Evaluation Config for Tuning Job.

.google.cloud.aiplatform.v1beta1.EvaluationConfig evaluation_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue EvaluationConfig.Builder
Returns
Type Description
SupervisedTuningSpec.Builder

setExportLastCheckpointOnly(boolean value)

public SupervisedTuningSpec.Builder setExportLastCheckpointOnly(boolean value)

Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false.

bool export_last_checkpoint_only = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The exportLastCheckpointOnly to set.

Returns
Type Description
SupervisedTuningSpec.Builder

This builder for chaining.

setHyperParameters(SupervisedHyperParameters value)

public SupervisedTuningSpec.Builder setHyperParameters(SupervisedHyperParameters value)

Optional. Hyperparameters for SFT.

.google.cloud.aiplatform.v1beta1.SupervisedHyperParameters hyper_parameters = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value SupervisedHyperParameters
Returns
Type Description
SupervisedTuningSpec.Builder

setHyperParameters(SupervisedHyperParameters.Builder builderForValue)

public SupervisedTuningSpec.Builder setHyperParameters(SupervisedHyperParameters.Builder builderForValue)

Optional. Hyperparameters for SFT.

.google.cloud.aiplatform.v1beta1.SupervisedHyperParameters hyper_parameters = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue SupervisedHyperParameters.Builder
Returns
Type Description
SupervisedTuningSpec.Builder

setTrainingDatasetUri(String value)

public SupervisedTuningSpec.Builder setTrainingDatasetUri(String value)

Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.

string training_dataset_uri = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The trainingDatasetUri to set.

Returns
Type Description
SupervisedTuningSpec.Builder

This builder for chaining.

setTrainingDatasetUriBytes(ByteString value)

public SupervisedTuningSpec.Builder setTrainingDatasetUriBytes(ByteString value)

Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.

string training_dataset_uri = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for trainingDatasetUri to set.

Returns
Type Description
SupervisedTuningSpec.Builder

This builder for chaining.

setTuningMode(SupervisedTuningSpec.TuningMode value)

public SupervisedTuningSpec.Builder setTuningMode(SupervisedTuningSpec.TuningMode value)

Tuning mode.

.google.cloud.aiplatform.v1beta1.SupervisedTuningSpec.TuningMode tuning_mode = 7;

Parameter
Name Description
value SupervisedTuningSpec.TuningMode

The tuningMode to set.

Returns
Type Description
SupervisedTuningSpec.Builder

This builder for chaining.

setTuningModeValue(int value)

public SupervisedTuningSpec.Builder setTuningModeValue(int value)

Tuning mode.

.google.cloud.aiplatform.v1beta1.SupervisedTuningSpec.TuningMode tuning_mode = 7;

Parameter
Name Description
value int

The enum numeric value on the wire for tuningMode to set.

Returns
Type Description
SupervisedTuningSpec.Builder

This builder for chaining.

setValidationDatasetUri(String value)

public SupervisedTuningSpec.Builder setValidationDatasetUri(String value)

Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.

string validation_dataset_uri = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The validationDatasetUri to set.

Returns
Type Description
SupervisedTuningSpec.Builder

This builder for chaining.

setValidationDatasetUriBytes(ByteString value)

public SupervisedTuningSpec.Builder setValidationDatasetUriBytes(ByteString value)

Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.

string validation_dataset_uri = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for validationDatasetUri to set.

Returns
Type Description
SupervisedTuningSpec.Builder

This builder for chaining.