Package com.google.cloud.aiplatform.v1

Class StratifiedSplit.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<StratifiedSplit.Builder>
com.google.cloud.aiplatform.v1.StratifiedSplit.Builder
All Implemented Interfaces:
StratifiedSplitOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
StratifiedSplit
public static final class StratifiedSplit.Builder extends com.google.protobuf.GeneratedMessage.Builder<StratifiedSplit.Builder> implements StratifiedSplitOrBuilder
 Assigns input data to the training, validation, and test sets so that the
 distribution of values found in the categorical column (as specified by the
 `key` field) is mirrored within each split. The fraction values determine
 the relative sizes of the splits.

 For example, if the specified column has three values, with 50% of the rows
 having value "A", 25% value "B", and 25% value "C", and the split fractions
 are specified as 80/10/10, then the training set will constitute 80% of the
 training data, with about 50% of the training set rows having the value "A"
 for the specified column, about 25% having the value "B", and about 25%
 having the value "C".

 Only the top 500 occurring values are used; any values not in the top
 500 values are randomly assigned to a split. If less than three rows contain
 a specific value, those rows are randomly assigned.

 Supported only for tabular Datasets.
Protobuf type google.cloud.aiplatform.v1.StratifiedSplit

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

    • clear

      public StratifiedSplit.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<StratifiedSplit.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<StratifiedSplit.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public StratifiedSplit.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<StratifiedSplit.Builder>

    • mergeFrom

      public StratifiedSplit.Builder mergeFrom(StratifiedSplit other)

    • isInitialized

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

    • mergeFrom

      public StratifiedSplit.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<StratifiedSplit.Builder>
      Throws:
      IOException

    • getTrainingFraction

      public double getTrainingFraction()
       The fraction of the input data that is to be used to train the Model.
      double training_fraction = 1;
      Specified by:
      getTrainingFraction in interface StratifiedSplitOrBuilder
      Returns:
      The trainingFraction.

    • setTrainingFraction

      public StratifiedSplit.Builder setTrainingFraction(double value)
       The fraction of the input data that is to be used to train the Model.
      double training_fraction = 1;
      Parameters:
      value - The trainingFraction to set.
      Returns:
      This builder for chaining.

    • clearTrainingFraction

      public StratifiedSplit.Builder clearTrainingFraction()
       The fraction of the input data that is to be used to train the Model.
      double training_fraction = 1;
      Returns:
      This builder for chaining.

    • getValidationFraction

      public double getValidationFraction()
       The fraction of the input data that is to be used to validate the Model.
      double validation_fraction = 2;
      Specified by:
      getValidationFraction in interface StratifiedSplitOrBuilder
      Returns:
      The validationFraction.

    • setValidationFraction

      public StratifiedSplit.Builder setValidationFraction(double value)
       The fraction of the input data that is to be used to validate the Model.
      double validation_fraction = 2;
      Parameters:
      value - The validationFraction to set.
      Returns:
      This builder for chaining.

    • clearValidationFraction

      public StratifiedSplit.Builder clearValidationFraction()
       The fraction of the input data that is to be used to validate the Model.
      double validation_fraction = 2;
      Returns:
      This builder for chaining.

    • getTestFraction

      public double getTestFraction()
       The fraction of the input data that is to be used to evaluate the Model.
      double test_fraction = 3;
      Specified by:
      getTestFraction in interface StratifiedSplitOrBuilder
      Returns:
      The testFraction.

    • setTestFraction

      public StratifiedSplit.Builder setTestFraction(double value)
       The fraction of the input data that is to be used to evaluate the Model.
      double test_fraction = 3;
      Parameters:
      value - The testFraction to set.
      Returns:
      This builder for chaining.

    • clearTestFraction

      public StratifiedSplit.Builder clearTestFraction()
       The fraction of the input data that is to be used to evaluate the Model.
      double test_fraction = 3;
      Returns:
      This builder for chaining.

    • getKey

      public String getKey()
       Required. The key is a name of one of the Dataset's data columns.
 The key provided must be for a categorical column.
      string key = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getKey in interface StratifiedSplitOrBuilder
      Returns:
      The key.

    • getKeyBytes

      public com.google.protobuf.ByteString getKeyBytes()
       Required. The key is a name of one of the Dataset's data columns.
 The key provided must be for a categorical column.
      string key = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getKeyBytes in interface StratifiedSplitOrBuilder
      Returns:
      The bytes for key.

    • setKey

      public StratifiedSplit.Builder setKey(String value)
       Required. The key is a name of one of the Dataset's data columns.
 The key provided must be for a categorical column.
      string key = 4 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The key to set.
      Returns:
      This builder for chaining.

    • clearKey

      public StratifiedSplit.Builder clearKey()
       Required. The key is a name of one of the Dataset's data columns.
 The key provided must be for a categorical column.
      string key = 4 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setKeyBytes

      public StratifiedSplit.Builder setKeyBytes(com.google.protobuf.ByteString value)
       Required. The key is a name of one of the Dataset's data columns.
 The key provided must be for a categorical column.
      string key = 4 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for key to set.
      Returns:
      This builder for chaining.