Class DistillationSpec.Builder (3.53.0)

public static final class DistillationSpec.Builder extends GeneratedMessageV3.Builder<DistillationSpec.Builder> implements DistillationSpecOrBuilder

Tuning Spec for Distillation.

Protobuf type google.cloud.aiplatform.v1beta1.DistillationSpec

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DistillationSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DistillationSpec.Builder
Overrides

build()

public DistillationSpec build()
Returns
Type Description
DistillationSpec

buildPartial()

public DistillationSpec buildPartial()
Returns
Type Description
DistillationSpec

clear()

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

clearBaseTeacherModel()

public DistillationSpec.Builder clearBaseTeacherModel()

The base teacher model that is being distilled, e.g., "gemini-1.0-pro-002".

string base_teacher_model = 5;

Returns
Type Description
DistillationSpec.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DistillationSpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
DistillationSpec.Builder
Overrides

clearHyperParameters()

public DistillationSpec.Builder clearHyperParameters()

Optional. Hyperparameters for Distillation.

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

Returns
Type Description
DistillationSpec.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public DistillationSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
DistillationSpec.Builder
Overrides

clearPipelineRootDirectory()

public DistillationSpec.Builder clearPipelineRootDirectory()

Required. A path in a Cloud Storage bucket, which will be treated as the root output directory of the distillation pipeline. It is used by the system to generate the paths of output artifacts.

string pipeline_root_directory = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DistillationSpec.Builder

This builder for chaining.

clearStudentModel()

public DistillationSpec.Builder clearStudentModel()

The student model that is being tuned, e.g., "google/gemma-2b-1.1-it".

string student_model = 4;

Returns
Type Description
DistillationSpec.Builder

This builder for chaining.

clearTeacherModel()

public DistillationSpec.Builder clearTeacherModel()
Returns
Type Description
DistillationSpec.Builder

clearTrainingDatasetUri()

public DistillationSpec.Builder clearTrainingDatasetUri()

Required. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file.

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

Returns
Type Description
DistillationSpec.Builder

This builder for chaining.

clearTunedTeacherModelSource()

public DistillationSpec.Builder clearTunedTeacherModelSource()

The resource name of the Tuned teacher model. Format: projects/{project}/locations/{location}/models/{model}.

string tuned_teacher_model_source = 6 [(.google.api.resource_reference) = { ... }

Returns
Type Description
DistillationSpec.Builder

This builder for chaining.

clearValidationDatasetUri()

public DistillationSpec.Builder clearValidationDatasetUri()

Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file.

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

Returns
Type Description
DistillationSpec.Builder

This builder for chaining.

clone()

public DistillationSpec.Builder clone()
Returns
Type Description
DistillationSpec.Builder
Overrides

getBaseTeacherModel()

public String getBaseTeacherModel()

The base teacher model that is being distilled, e.g., "gemini-1.0-pro-002".

string base_teacher_model = 5;

Returns
Type Description
String

The baseTeacherModel.

getBaseTeacherModelBytes()

public ByteString getBaseTeacherModelBytes()

The base teacher model that is being distilled, e.g., "gemini-1.0-pro-002".

string base_teacher_model = 5;

Returns
Type Description
ByteString

The bytes for baseTeacherModel.

getDefaultInstanceForType()

public DistillationSpec getDefaultInstanceForType()
Returns
Type Description
DistillationSpec

getDescriptorForType()

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

getHyperParameters()

public DistillationHyperParameters getHyperParameters()

Optional. Hyperparameters for Distillation.

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

Returns
Type Description
DistillationHyperParameters

The hyperParameters.

getHyperParametersBuilder()

public DistillationHyperParameters.Builder getHyperParametersBuilder()

Optional. Hyperparameters for Distillation.

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

Returns
Type Description
DistillationHyperParameters.Builder

getHyperParametersOrBuilder()

public DistillationHyperParametersOrBuilder getHyperParametersOrBuilder()

Optional. Hyperparameters for Distillation.

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

Returns
Type Description
DistillationHyperParametersOrBuilder

getPipelineRootDirectory()

public String getPipelineRootDirectory()

Required. A path in a Cloud Storage bucket, which will be treated as the root output directory of the distillation pipeline. It is used by the system to generate the paths of output artifacts.

string pipeline_root_directory = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The pipelineRootDirectory.

getPipelineRootDirectoryBytes()

public ByteString getPipelineRootDirectoryBytes()

Required. A path in a Cloud Storage bucket, which will be treated as the root output directory of the distillation pipeline. It is used by the system to generate the paths of output artifacts.

string pipeline_root_directory = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for pipelineRootDirectory.

getStudentModel()

public String getStudentModel()

The student model that is being tuned, e.g., "google/gemma-2b-1.1-it".

string student_model = 4;

Returns
Type Description
String

The studentModel.

getStudentModelBytes()

public ByteString getStudentModelBytes()

The student model that is being tuned, e.g., "google/gemma-2b-1.1-it".

string student_model = 4;

Returns
Type Description
ByteString

The bytes for studentModel.

getTeacherModelCase()

public DistillationSpec.TeacherModelCase getTeacherModelCase()
Returns
Type Description
DistillationSpec.TeacherModelCase

getTrainingDatasetUri()

public String getTrainingDatasetUri()

Required. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file.

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

Returns
Type Description
String

The trainingDatasetUri.

getTrainingDatasetUriBytes()

public ByteString getTrainingDatasetUriBytes()

Required. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file.

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

Returns
Type Description
ByteString

The bytes for trainingDatasetUri.

getTunedTeacherModelSource()

public String getTunedTeacherModelSource()

The resource name of the Tuned teacher model. Format: projects/{project}/locations/{location}/models/{model}.

string tuned_teacher_model_source = 6 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The tunedTeacherModelSource.

getTunedTeacherModelSourceBytes()

public ByteString getTunedTeacherModelSourceBytes()

The resource name of the Tuned teacher model. Format: projects/{project}/locations/{location}/models/{model}.

string tuned_teacher_model_source = 6 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for tunedTeacherModelSource.

getValidationDatasetUri()

public String getValidationDatasetUri()

Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file.

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

Returns
Type Description
String

The validationDatasetUri.

getValidationDatasetUriBytes()

public ByteString getValidationDatasetUriBytes()

Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file.

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

Returns
Type Description
ByteString

The bytes for validationDatasetUri.

hasBaseTeacherModel()

public boolean hasBaseTeacherModel()

The base teacher model that is being distilled, e.g., "gemini-1.0-pro-002".

string base_teacher_model = 5;

Returns
Type Description
boolean

Whether the baseTeacherModel field is set.

hasHyperParameters()

public boolean hasHyperParameters()

Optional. Hyperparameters for Distillation.

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

Returns
Type Description
boolean

Whether the hyperParameters field is set.

hasTunedTeacherModelSource()

public boolean hasTunedTeacherModelSource()

The resource name of the Tuned teacher model. Format: projects/{project}/locations/{location}/models/{model}.

string tuned_teacher_model_source = 6 [(.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the tunedTeacherModelSource field is set.

hasValidationDatasetUri()

public boolean hasValidationDatasetUri()

Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file.

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

Returns
Type Description
boolean

Whether the validationDatasetUri field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(DistillationSpec other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeHyperParameters(DistillationHyperParameters value)

public DistillationSpec.Builder mergeHyperParameters(DistillationHyperParameters value)

Optional. Hyperparameters for Distillation.

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

Parameter
Name Description
value DistillationHyperParameters
Returns
Type Description
DistillationSpec.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DistillationSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DistillationSpec.Builder
Overrides

setBaseTeacherModel(String value)

public DistillationSpec.Builder setBaseTeacherModel(String value)

The base teacher model that is being distilled, e.g., "gemini-1.0-pro-002".

string base_teacher_model = 5;

Parameter
Name Description
value String

The baseTeacherModel to set.

Returns
Type Description
DistillationSpec.Builder

This builder for chaining.

setBaseTeacherModelBytes(ByteString value)

public DistillationSpec.Builder setBaseTeacherModelBytes(ByteString value)

The base teacher model that is being distilled, e.g., "gemini-1.0-pro-002".

string base_teacher_model = 5;

Parameter
Name Description
value ByteString

The bytes for baseTeacherModel to set.

Returns
Type Description
DistillationSpec.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DistillationSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DistillationSpec.Builder
Overrides

setHyperParameters(DistillationHyperParameters value)

public DistillationSpec.Builder setHyperParameters(DistillationHyperParameters value)

Optional. Hyperparameters for Distillation.

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

Parameter
Name Description
value DistillationHyperParameters
Returns
Type Description
DistillationSpec.Builder

setHyperParameters(DistillationHyperParameters.Builder builderForValue)

public DistillationSpec.Builder setHyperParameters(DistillationHyperParameters.Builder builderForValue)

Optional. Hyperparameters for Distillation.

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

Parameter
Name Description
builderForValue DistillationHyperParameters.Builder
Returns
Type Description
DistillationSpec.Builder

setPipelineRootDirectory(String value)

public DistillationSpec.Builder setPipelineRootDirectory(String value)

Required. A path in a Cloud Storage bucket, which will be treated as the root output directory of the distillation pipeline. It is used by the system to generate the paths of output artifacts.

string pipeline_root_directory = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The pipelineRootDirectory to set.

Returns
Type Description
DistillationSpec.Builder

This builder for chaining.

setPipelineRootDirectoryBytes(ByteString value)

public DistillationSpec.Builder setPipelineRootDirectoryBytes(ByteString value)

Required. A path in a Cloud Storage bucket, which will be treated as the root output directory of the distillation pipeline. It is used by the system to generate the paths of output artifacts.

string pipeline_root_directory = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for pipelineRootDirectory to set.

Returns
Type Description
DistillationSpec.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DistillationSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
DistillationSpec.Builder
Overrides

setStudentModel(String value)

public DistillationSpec.Builder setStudentModel(String value)

The student model that is being tuned, e.g., "google/gemma-2b-1.1-it".

string student_model = 4;

Parameter
Name Description
value String

The studentModel to set.

Returns
Type Description
DistillationSpec.Builder

This builder for chaining.

setStudentModelBytes(ByteString value)

public DistillationSpec.Builder setStudentModelBytes(ByteString value)

The student model that is being tuned, e.g., "google/gemma-2b-1.1-it".

string student_model = 4;

Parameter
Name Description
value ByteString

The bytes for studentModel to set.

Returns
Type Description
DistillationSpec.Builder

This builder for chaining.

setTrainingDatasetUri(String value)

public DistillationSpec.Builder setTrainingDatasetUri(String value)

Required. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file.

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

Parameter
Name Description
value String

The trainingDatasetUri to set.

Returns
Type Description
DistillationSpec.Builder

This builder for chaining.

setTrainingDatasetUriBytes(ByteString value)

public DistillationSpec.Builder setTrainingDatasetUriBytes(ByteString value)

Required. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file.

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

Parameter
Name Description
value ByteString

The bytes for trainingDatasetUri to set.

Returns
Type Description
DistillationSpec.Builder

This builder for chaining.

setTunedTeacherModelSource(String value)

public DistillationSpec.Builder setTunedTeacherModelSource(String value)

The resource name of the Tuned teacher model. Format: projects/{project}/locations/{location}/models/{model}.

string tuned_teacher_model_source = 6 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The tunedTeacherModelSource to set.

Returns
Type Description
DistillationSpec.Builder

This builder for chaining.

setTunedTeacherModelSourceBytes(ByteString value)

public DistillationSpec.Builder setTunedTeacherModelSourceBytes(ByteString value)

The resource name of the Tuned teacher model. Format: projects/{project}/locations/{location}/models/{model}.

string tuned_teacher_model_source = 6 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for tunedTeacherModelSource to set.

Returns
Type Description
DistillationSpec.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final DistillationSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DistillationSpec.Builder
Overrides

setValidationDatasetUri(String value)

public DistillationSpec.Builder setValidationDatasetUri(String value)

Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file.

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

Parameter
Name Description
value String

The validationDatasetUri to set.

Returns
Type Description
DistillationSpec.Builder

This builder for chaining.

setValidationDatasetUriBytes(ByteString value)

public DistillationSpec.Builder setValidationDatasetUriBytes(ByteString value)

Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file.

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

Parameter
Name Description
value ByteString

The bytes for validationDatasetUri to set.

Returns
Type Description
DistillationSpec.Builder

This builder for chaining.