Package com.google.cloud.aiplatform.v1beta1

Class DistillationSpec.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<DistillationSpec.Builder>
com.google.cloud.aiplatform.v1beta1.DistillationSpec.Builder
All Implemented Interfaces:
DistillationSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
DistillationSpec
public static final class DistillationSpec.Builder extends com.google.protobuf.GeneratedMessage.Builder<DistillationSpec.Builder> implements DistillationSpecOrBuilder
 Tuning Spec for Distillation.
Protobuf type google.cloud.aiplatform.v1beta1.DistillationSpec

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<DistillationSpec.Builder>

    • clear

      public DistillationSpec.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<DistillationSpec.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<DistillationSpec.Builder>

    • getDefaultInstanceForType

      public DistillationSpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public DistillationSpec build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public DistillationSpec buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public DistillationSpec.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DistillationSpec.Builder>

    • mergeFrom

      public DistillationSpec.Builder mergeFrom(DistillationSpec other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<DistillationSpec.Builder>

    • mergeFrom

      public DistillationSpec.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DistillationSpec.Builder>
      Throws:
      IOException

    • getTeacherModelCase

      public DistillationSpec.TeacherModelCase getTeacherModelCase()
      Specified by:
      getTeacherModelCase in interface DistillationSpecOrBuilder

    • clearTeacherModel

      public DistillationSpec.Builder clearTeacherModel()

    • hasBaseTeacherModel

      public boolean hasBaseTeacherModel()
       The base teacher model that is being distilled. See [Supported
 models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models).
      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. See [Supported
 models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models).
      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. See [Supported
 models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models).
      string base_teacher_model = 5;
      Specified by:
      getBaseTeacherModelBytes in interface DistillationSpecOrBuilder
      Returns:
      The bytes for baseTeacherModel.

    • setBaseTeacherModel

      public DistillationSpec.Builder setBaseTeacherModel(String value)
       The base teacher model that is being distilled. See [Supported
 models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models).
      string base_teacher_model = 5;
      Parameters:
      value - The baseTeacherModel to set.
      Returns:
      This builder for chaining.

    • clearBaseTeacherModel

      public DistillationSpec.Builder clearBaseTeacherModel()
       The base teacher model that is being distilled. See [Supported
 models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models).
      string base_teacher_model = 5;
      Returns:
      This builder for chaining.

    • setBaseTeacherModelBytes

      public DistillationSpec.Builder setBaseTeacherModelBytes(com.google.protobuf.ByteString value)
       The base teacher model that is being distilled. See [Supported
 models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models).
      string base_teacher_model = 5;
      Parameters:
      value - The bytes for baseTeacherModel to set.
      Returns:
      This builder for chaining.

    • 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.

    • setTunedTeacherModelSource

      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) = { ... }
      Parameters:
      value - The tunedTeacherModelSource to set.
      Returns:
      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:
      This builder for chaining.

    • setTunedTeacherModelSourceBytes

      public DistillationSpec.Builder setTunedTeacherModelSourceBytes(com.google.protobuf.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) = { ... }
      Parameters:
      value - The bytes for tunedTeacherModelSource to set.
      Returns:
      This builder for chaining.

    • 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.

    • setTrainingDatasetUri

      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];
      Parameters:
      value - The trainingDatasetUri to set.
      Returns:
      This builder for chaining.

    • 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:
      This builder for chaining.

    • setTrainingDatasetUriBytes

      public DistillationSpec.Builder setTrainingDatasetUriBytes(com.google.protobuf.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];
      Parameters:
      value - The bytes for trainingDatasetUri to set.
      Returns:
      This builder for chaining.

    • 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.

    • setValidationDatasetUri

      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];
      Parameters:
      value - The validationDatasetUri to set.
      Returns:
      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:
      This builder for chaining.

    • setValidationDatasetUriBytes

      public DistillationSpec.Builder setValidationDatasetUriBytes(com.google.protobuf.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];
      Parameters:
      value - The bytes for validationDatasetUri to set.
      Returns:
      This builder for chaining.

    • 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.

    • setHyperParameters

      public DistillationSpec.Builder setHyperParameters(DistillationHyperParameters value)
       Optional. Hyperparameters for Distillation.
      .google.cloud.aiplatform.v1beta1.DistillationHyperParameters hyper_parameters = 3 [(.google.api.field_behavior) = OPTIONAL];

    • setHyperParameters

      public DistillationSpec.Builder setHyperParameters(DistillationHyperParameters.Builder builderForValue)
       Optional. Hyperparameters for Distillation.
      .google.cloud.aiplatform.v1beta1.DistillationHyperParameters hyper_parameters = 3 [(.google.api.field_behavior) = OPTIONAL];

    • mergeHyperParameters

      public DistillationSpec.Builder mergeHyperParameters(DistillationHyperParameters value)
       Optional. Hyperparameters for Distillation.
      .google.cloud.aiplatform.v1beta1.DistillationHyperParameters hyper_parameters = 3 [(.google.api.field_behavior) = OPTIONAL];

    • clearHyperParameters

      public DistillationSpec.Builder clearHyperParameters()
       Optional. Hyperparameters for Distillation.
      .google.cloud.aiplatform.v1beta1.DistillationHyperParameters hyper_parameters = 3 [(.google.api.field_behavior) = OPTIONAL];

    • getHyperParametersBuilder

      public DistillationHyperParameters.Builder getHyperParametersBuilder()
       Optional. Hyperparameters for Distillation.
      .google.cloud.aiplatform.v1beta1.DistillationHyperParameters hyper_parameters = 3 [(.google.api.field_behavior) = OPTIONAL];

    • 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.

    • setStudentModel

      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;
      Parameters:
      value - The studentModel to set.
      Returns:
      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:
      This builder for chaining.

    • setStudentModelBytes

      public DistillationSpec.Builder setStudentModelBytes(com.google.protobuf.ByteString value)
       The student model that is being tuned, e.g., "google/gemma-2b-1.1-it".
      string student_model = 4;
      Parameters:
      value - The bytes for studentModel to set.
      Returns:
      This builder for chaining.

    • 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.

    • setPipelineRootDirectory

      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];
      Parameters:
      value - The pipelineRootDirectory to set.
      Returns:
      This builder for chaining.

    • 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:
      This builder for chaining.

    • setPipelineRootDirectoryBytes

      public DistillationSpec.Builder setPipelineRootDirectoryBytes(com.google.protobuf.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];
      Parameters:
      value - The bytes for pipelineRootDirectory to set.
      Returns:
      This builder for chaining.