Class StratifiedSplit.Builder (3.42.0)

public static final class StratifiedSplit.Builder extends GeneratedMessageV3.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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > StratifiedSplit.Builder

Implements

StratifiedSplitOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public StratifiedSplit.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`StratifiedSplit.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public StratifiedSplit build()

Returns
Type	Description
`StratifiedSplit`

buildPartial()

public StratifiedSplit buildPartial()

Returns
Type	Description
`StratifiedSplit`

clear()

public StratifiedSplit.Builder clear()

Returns
Type	Description
`StratifiedSplit.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public StratifiedSplit.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`StratifiedSplit.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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
Type	Description
`StratifiedSplit.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public StratifiedSplit.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`StratifiedSplit.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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
Type	Description
`StratifiedSplit.Builder`	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
Type	Description
`StratifiedSplit.Builder`	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
Type	Description
`StratifiedSplit.Builder`	This builder for chaining.

clone()

public StratifiedSplit.Builder clone()

Returns
Type	Description
`StratifiedSplit.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public StratifiedSplit getDefaultInstanceForType()

Returns
Type	Description
`StratifiedSplit`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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
Type	Description
`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
Type	Description
`ByteString`	The bytes for key.

getTestFraction()

public double getTestFraction()

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

double test_fraction = 3;

Returns
Type	Description
`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
Type	Description
`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
Type	Description
`double`	The validationFraction.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(StratifiedSplit other)

public StratifiedSplit.Builder mergeFrom(StratifiedSplit other)

Parameter
Name	Description
`other`	`StratifiedSplit`

Returns
Type	Description
`StratifiedSplit.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StratifiedSplit.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`StratifiedSplit.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public StratifiedSplit.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`StratifiedSplit.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StratifiedSplit.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`StratifiedSplit.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public StratifiedSplit.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`StratifiedSplit.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setKey(String value)

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

Parameter
Name	Description
`value`	`String` The key to set.

Returns
Type	Description
`StratifiedSplit.Builder`	This builder for chaining.

setKeyBytes(ByteString value)

public StratifiedSplit.Builder setKeyBytes(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];

Parameter
Name	Description
`value`	`ByteString` The bytes for key to set.

Returns
Type	Description
`StratifiedSplit.Builder`	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public StratifiedSplit.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`StratifiedSplit.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setTestFraction(double value)

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;

Parameter
Name	Description
`value`	`double` The testFraction to set.

Returns
Type	Description
`StratifiedSplit.Builder`	This builder for chaining.

setTrainingFraction(double value)

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;

Parameter
Name	Description
`value`	`double` The trainingFraction to set.

Returns
Type	Description
`StratifiedSplit.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final StratifiedSplit.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`StratifiedSplit.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setValidationFraction(double value)

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;

Parameter
Name	Description
`value`	`double` The validationFraction to set.

Returns
Type	Description
`StratifiedSplit.Builder`	This builder for chaining.