Class SupervisedTuningSpec (3.71.0)

public final class SupervisedTuningSpec extends GeneratedMessageV3 implements SupervisedTuningSpecOrBuilder

Tuning Spec for Supervised Tuning for first party models.

Protobuf type google.cloud.aiplatform.v1beta1.SupervisedTuningSpec

Static Fields

EXPORT_LAST_CHECKPOINT_ONLY_FIELD_NUMBER

public static final int EXPORT_LAST_CHECKPOINT_ONLY_FIELD_NUMBER
Field Value
Type Description
int

HYPER_PARAMETERS_FIELD_NUMBER

public static final int HYPER_PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

TRAINING_DATASET_URI_FIELD_NUMBER

public static final int TRAINING_DATASET_URI_FIELD_NUMBER
Field Value
Type Description
int

TUNING_MODE_FIELD_NUMBER

public static final int TUNING_MODE_FIELD_NUMBER
Field Value
Type Description
int

VALIDATION_DATASET_URI_FIELD_NUMBER

public static final int VALIDATION_DATASET_URI_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SupervisedTuningSpec getDefaultInstance()
Returns
Type Description
SupervisedTuningSpec

getDescriptor()

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

newBuilder()

public static SupervisedTuningSpec.Builder newBuilder()
Returns
Type Description
SupervisedTuningSpec.Builder

newBuilder(SupervisedTuningSpec prototype)

public static SupervisedTuningSpec.Builder newBuilder(SupervisedTuningSpec prototype)
Parameter
Name Description
prototype SupervisedTuningSpec
Returns
Type Description
SupervisedTuningSpec.Builder

parseDelimitedFrom(InputStream input)

public static SupervisedTuningSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SupervisedTuningSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SupervisedTuningSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SupervisedTuningSpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SupervisedTuningSpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SupervisedTuningSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SupervisedTuningSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SupervisedTuningSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SupervisedTuningSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SupervisedTuningSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SupervisedTuningSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SupervisedTuningSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SupervisedTuningSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SupervisedTuningSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SupervisedTuningSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SupervisedTuningSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SupervisedTuningSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SupervisedTuningSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SupervisedTuningSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SupervisedTuningSpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SupervisedTuningSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SupervisedTuningSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SupervisedTuningSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SupervisedTuningSpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SupervisedTuningSpec> parser()
Returns
Type Description
Parser<SupervisedTuningSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SupervisedTuningSpec getDefaultInstanceForType()
Returns
Type Description
SupervisedTuningSpec

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.

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

getParserForType()

public Parser<SupervisedTuningSpec> getParserForType()
Returns
Type Description
Parser<SupervisedTuningSpec>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SupervisedTuningSpec.Builder newBuilderForType()
Returns
Type Description
SupervisedTuningSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SupervisedTuningSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SupervisedTuningSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SupervisedTuningSpec.Builder toBuilder()
Returns
Type Description
SupervisedTuningSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException