Class StratifiedSplit (3.38.0)

public final class StratifiedSplit extends 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

Static Fields

KEY_FIELD_NUMBER

public static final int KEY_FIELD_NUMBER
Field Value
TypeDescription
int

TEST_FRACTION_FIELD_NUMBER

public static final int TEST_FRACTION_FIELD_NUMBER
Field Value
TypeDescription
int

TRAINING_FRACTION_FIELD_NUMBER

public static final int TRAINING_FRACTION_FIELD_NUMBER
Field Value
TypeDescription
int

VALIDATION_FRACTION_FIELD_NUMBER

public static final int VALIDATION_FRACTION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static StratifiedSplit getDefaultInstance()
Returns
TypeDescription
StratifiedSplit

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static StratifiedSplit.Builder newBuilder()
Returns
TypeDescription
StratifiedSplit.Builder

newBuilder(StratifiedSplit prototype)

public static StratifiedSplit.Builder newBuilder(StratifiedSplit prototype)
Parameter
NameDescription
prototypeStratifiedSplit
Returns
TypeDescription
StratifiedSplit.Builder

parseDelimitedFrom(InputStream input)

public static StratifiedSplit parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
StratifiedSplit
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StratifiedSplit parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StratifiedSplit
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static StratifiedSplit parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
StratifiedSplit
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StratifiedSplit parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StratifiedSplit
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StratifiedSplit parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
StratifiedSplit
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StratifiedSplit parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StratifiedSplit
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StratifiedSplit parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
StratifiedSplit
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StratifiedSplit parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StratifiedSplit
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static StratifiedSplit parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
StratifiedSplit
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StratifiedSplit parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StratifiedSplit
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static StratifiedSplit parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
StratifiedSplit
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StratifiedSplit parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StratifiedSplit
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<StratifiedSplit> parser()
Returns
TypeDescription
Parser<StratifiedSplit>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public StratifiedSplit getDefaultInstanceForType()
Returns
TypeDescription
StratifiedSplit

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

Returns
TypeDescription
String

The key.

getKeyBytes()

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

Returns
TypeDescription
ByteString

The bytes for key.

getParserForType()

public Parser<StratifiedSplit> getParserForType()
Returns
TypeDescription
Parser<StratifiedSplit>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTestFraction()

public double getTestFraction()

The fraction of the input data that is to be used to evaluate the Model.

double test_fraction = 3;

Returns
TypeDescription
double

The testFraction.

getTrainingFraction()

public double getTrainingFraction()

The fraction of the input data that is to be used to train the Model.

double training_fraction = 1;

Returns
TypeDescription
double

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;

Returns
TypeDescription
double

The validationFraction.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public StratifiedSplit.Builder newBuilderForType()
Returns
TypeDescription
StratifiedSplit.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StratifiedSplit.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
StratifiedSplit.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public StratifiedSplit.Builder toBuilder()
Returns
TypeDescription
StratifiedSplit.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException