com.google.cloud.aiplatform.v1beta1

Class DistillationSpec

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1beta1.DistillationSpec

All Implemented Interfaces:

DistillationSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class DistillationSpec
extends com.google.protobuf.GeneratedMessageV3
implements DistillationSpecOrBuilder

 Tuning Spec for Distillation.
 

Protobuf type google.cloud.aiplatform.v1beta1.DistillationSpec

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DistillationSpec.Builder Tuning Spec for Distillation.
static class	DistillationSpec.TeacherModelCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	BASE_TEACHER_MODEL_FIELD_NUMBER
static int	HYPER_PARAMETERS_FIELD_NUMBER
static int	PIPELINE_ROOT_DIRECTORY_FIELD_NUMBER
static int	STUDENT_MODEL_FIELD_NUMBER
static int	TRAINING_DATASET_URI_FIELD_NUMBER
static int	TUNED_TEACHER_MODEL_SOURCE_FIELD_NUMBER
static int	VALIDATION_DATASET_URI_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getBaseTeacherModel() The base teacher model that is being distilled, e.g., "gemini-1.0-pro-002".
com.google.protobuf.ByteString	getBaseTeacherModelBytes() The base teacher model that is being distilled, e.g., "gemini-1.0-pro-002".
static DistillationSpec	getDefaultInstance()
DistillationSpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
DistillationHyperParameters	getHyperParameters() Optional.
DistillationHyperParametersOrBuilder	getHyperParametersOrBuilder() Optional.
com.google.protobuf.Parser<DistillationSpec>	getParserForType()
String	getPipelineRootDirectory() Required.
com.google.protobuf.ByteString	getPipelineRootDirectoryBytes() Required.
int	getSerializedSize()
String	getStudentModel() The student model that is being tuned, e.g., "google/gemma-2b-1.1-it".
com.google.protobuf.ByteString	getStudentModelBytes() The student model that is being tuned, e.g., "google/gemma-2b-1.1-it".
DistillationSpec.TeacherModelCase	getTeacherModelCase()
String	getTrainingDatasetUri() Required.
com.google.protobuf.ByteString	getTrainingDatasetUriBytes() Required.
String	getTunedTeacherModelSource() The resource name of the Tuned teacher model.
com.google.protobuf.ByteString	getTunedTeacherModelSourceBytes() The resource name of the Tuned teacher model.
String	getValidationDatasetUri() Optional.
com.google.protobuf.ByteString	getValidationDatasetUriBytes() Optional.
boolean	hasBaseTeacherModel() The base teacher model that is being distilled, e.g., "gemini-1.0-pro-002".
int	hashCode()
boolean	hasHyperParameters() Optional.
boolean	hasTunedTeacherModelSource() The resource name of the Tuned teacher model.
boolean	hasValidationDatasetUri() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static DistillationSpec.Builder	newBuilder()
static DistillationSpec.Builder	newBuilder(DistillationSpec prototype)
DistillationSpec.Builder	newBuilderForType()
protected DistillationSpec.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static DistillationSpec	parseDelimitedFrom(InputStream input)
static DistillationSpec	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DistillationSpec	parseFrom(byte[] data)
static DistillationSpec	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DistillationSpec	parseFrom(ByteBuffer data)
static DistillationSpec	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DistillationSpec	parseFrom(com.google.protobuf.ByteString data)
static DistillationSpec	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DistillationSpec	parseFrom(com.google.protobuf.CodedInputStream input)
static DistillationSpec	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DistillationSpec	parseFrom(InputStream input)
static DistillationSpec	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<DistillationSpec>	parser()
DistillationSpec.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

BASE_TEACHER_MODEL_FIELD_NUMBER

public static final int BASE_TEACHER_MODEL_FIELD_NUMBER

See Also:

Constant Field Values

TUNED_TEACHER_MODEL_SOURCE_FIELD_NUMBER

public static final int TUNED_TEACHER_MODEL_SOURCE_FIELD_NUMBER

See Also:

Constant Field Values

TRAINING_DATASET_URI_FIELD_NUMBER

public static final int TRAINING_DATASET_URI_FIELD_NUMBER

See Also:

Constant Field Values

VALIDATION_DATASET_URI_FIELD_NUMBER

public static final int VALIDATION_DATASET_URI_FIELD_NUMBER

See Also:

Constant Field Values

HYPER_PARAMETERS_FIELD_NUMBER

public static final int HYPER_PARAMETERS_FIELD_NUMBER

See Also:

Constant Field Values

STUDENT_MODEL_FIELD_NUMBER

public static final int STUDENT_MODEL_FIELD_NUMBER

See Also:

Constant Field Values

PIPELINE_ROOT_DIRECTORY_FIELD_NUMBER

public static final int PIPELINE_ROOT_DIRECTORY_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getTeacherModelCase

public DistillationSpec.TeacherModelCase getTeacherModelCase()

Specified by:

getTeacherModelCase in interface DistillationSpecOrBuilder

hasBaseTeacherModel

public boolean hasBaseTeacherModel()

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

string base_teacher_model = 5;

Specified by:

hasBaseTeacherModel in interface DistillationSpecOrBuilder

Returns:

Whether the baseTeacherModel field is set.

getBaseTeacherModel

public String getBaseTeacherModel()

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

string base_teacher_model = 5;

Specified by:

getBaseTeacherModel in interface DistillationSpecOrBuilder

Returns:

The baseTeacherModel.

getBaseTeacherModelBytes

public com.google.protobuf.ByteString getBaseTeacherModelBytes()

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

string base_teacher_model = 5;

Specified by:

getBaseTeacherModelBytes in interface DistillationSpecOrBuilder

Returns:

The bytes for baseTeacherModel.

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) = { ... }

Specified by:

hasTunedTeacherModelSource in interface DistillationSpecOrBuilder

Returns:

Whether the tunedTeacherModelSource field is set.

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) = { ... }

Specified by:

getTunedTeacherModelSource in interface DistillationSpecOrBuilder

Returns:

The tunedTeacherModelSource.

getTunedTeacherModelSourceBytes

public com.google.protobuf.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) = { ... }

Specified by:

getTunedTeacherModelSourceBytes in interface DistillationSpecOrBuilder

Returns:

The bytes for tunedTeacherModelSource.

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];

Specified by:

getTrainingDatasetUri in interface DistillationSpecOrBuilder

Returns:

The trainingDatasetUri.

getTrainingDatasetUriBytes

public com.google.protobuf.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];

Specified by:

getTrainingDatasetUriBytes in interface DistillationSpecOrBuilder

Returns:

The bytes for trainingDatasetUri.

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];

Specified by:

hasValidationDatasetUri in interface DistillationSpecOrBuilder

Returns:

Whether the validationDatasetUri field is set.

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];

Specified by:

getValidationDatasetUri in interface DistillationSpecOrBuilder

Returns:

The validationDatasetUri.

getValidationDatasetUriBytes

public com.google.protobuf.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];

Specified by:

getValidationDatasetUriBytes in interface DistillationSpecOrBuilder

Returns:

The bytes for validationDatasetUri.

hasHyperParameters

public boolean hasHyperParameters()

 Optional. Hyperparameters for Distillation.
 

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

Specified by:

hasHyperParameters in interface DistillationSpecOrBuilder

Returns:

Whether the hyperParameters field is set.

getHyperParameters

public DistillationHyperParameters getHyperParameters()

 Optional. Hyperparameters for Distillation.
 

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

Specified by:

getHyperParameters in interface DistillationSpecOrBuilder

Returns:

The hyperParameters.

getHyperParametersOrBuilder

public DistillationHyperParametersOrBuilder getHyperParametersOrBuilder()

 Optional. Hyperparameters for Distillation.
 

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

Specified by:

getHyperParametersOrBuilder in interface DistillationSpecOrBuilder

getStudentModel

public String getStudentModel()

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

string student_model = 4;

Specified by:

getStudentModel in interface DistillationSpecOrBuilder

Returns:

The studentModel.

getStudentModelBytes

public com.google.protobuf.ByteString getStudentModelBytes()

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

string student_model = 4;

Specified by:

getStudentModelBytes in interface DistillationSpecOrBuilder

Returns:

The bytes for studentModel.

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];

Specified by:

getPipelineRootDirectory in interface DistillationSpecOrBuilder

Returns:

The pipelineRootDirectory.

getPipelineRootDirectoryBytes

public com.google.protobuf.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];

Specified by:

getPipelineRootDirectoryBytes in interface DistillationSpecOrBuilder

Returns:

The bytes for pipelineRootDirectory.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static DistillationSpec parseFrom(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DistillationSpec parseFrom(ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DistillationSpec parseFrom(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DistillationSpec parseFrom(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DistillationSpec parseFrom(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DistillationSpec parseFrom(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DistillationSpec parseFrom(InputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static DistillationSpec parseFrom(InputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static DistillationSpec parseDelimitedFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static DistillationSpec parseDelimitedFrom(InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

parseFrom

public static DistillationSpec parseFrom(com.google.protobuf.CodedInputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static DistillationSpec parseFrom(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

newBuilderForType

public DistillationSpec.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static DistillationSpec.Builder newBuilder()

newBuilder

public static DistillationSpec.Builder newBuilder(DistillationSpec prototype)

toBuilder

public DistillationSpec.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected DistillationSpec.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static DistillationSpec getDefaultInstance()

parser

public static com.google.protobuf.Parser<DistillationSpec> parser()

getParserForType

public com.google.protobuf.Parser<DistillationSpec> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public DistillationSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder