Class DistillationSpec (3.56.0)

public final class DistillationSpec extends GeneratedMessageV3 implements DistillationSpecOrBuilder

Tuning Spec for Distillation.

Protobuf type google.cloud.aiplatform.v1beta1.DistillationSpec

Static Fields

BASE_TEACHER_MODEL_FIELD_NUMBER

public static final int BASE_TEACHER_MODEL_FIELD_NUMBER
Field Value
Type Description
int

HYPER_PARAMETERS_FIELD_NUMBER

public static final int HYPER_PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

PIPELINE_ROOT_DIRECTORY_FIELD_NUMBER

public static final int PIPELINE_ROOT_DIRECTORY_FIELD_NUMBER
Field Value
Type Description
int

STUDENT_MODEL_FIELD_NUMBER

public static final int STUDENT_MODEL_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

TUNED_TEACHER_MODEL_SOURCE_FIELD_NUMBER

public static final int TUNED_TEACHER_MODEL_SOURCE_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 DistillationSpec getDefaultInstance()
Returns
Type Description
DistillationSpec

getDescriptor()

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

newBuilder()

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

newBuilder(DistillationSpec prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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

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.

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

getParserForType()

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

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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 DistillationSpec.Builder newBuilderForType()
Returns
Type Description
DistillationSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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