Package com.google.cloud.aiplatform.v1

Class StratifiedSplit

  • All Implemented Interfaces:
    StratifiedSplitOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class StratifiedSplit
extends com.google.protobuf.GeneratedMessageV3
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
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  StratifiedSplit.Builder
      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.

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

      • TRAINING_FRACTION_FIELD_NUMBER

        public static final int TRAINING_FRACTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • VALIDATION_FRACTION_FIELD_NUMBER

        public static final int VALIDATION_FRACTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TEST_FRACTION_FIELD_NUMBER

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

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

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

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

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

      • 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 StratifiedSplit parseFrom​(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StratifiedSplit parseFrom​(ByteBuffer data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StratifiedSplit parseFrom​(com.google.protobuf.ByteString data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StratifiedSplit parseFrom​(com.google.protobuf.ByteString data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StratifiedSplit parseFrom​(byte[] data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StratifiedSplit parseFrom​(byte[] data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StratifiedSplit parseFrom​(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException
        Throws:
        IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected StratifiedSplit.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<StratifiedSplit> 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 StratifiedSplit getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder