Class TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder (2.46.0)

public static final class TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder extends GeneratedMessageV3.Builder<TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder> implements TrainProcessorVersionRequest.FoundationModelTuningOptionsOrBuilder

Options to control foundation model tuning of the processor.

Protobuf type google.cloud.documentai.v1beta3.TrainProcessorVersionRequest.FoundationModelTuningOptions

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder
Overrides

build()

public TrainProcessorVersionRequest.FoundationModelTuningOptions build()
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions

buildPartial()

public TrainProcessorVersionRequest.FoundationModelTuningOptions buildPartial()
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions

clear()

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder clear()
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder
Overrides

clearLearningRateMultiplier()

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder clearLearningRateMultiplier()

Optional. The multiplier to apply to the recommended learning rate. Valid values are between 0.1 and 10. If not provided, recommended learning rate will be used.

float learning_rate_multiplier = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder
Overrides

clearTrainSteps()

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder clearTrainSteps()

Optional. The number of steps to run for model tuning. Valid values are between 1 and 400. If not provided, recommended steps will be used.

int32 train_steps = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder

This builder for chaining.

clone()

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder clone()
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder
Overrides

getDefaultInstanceForType()

public TrainProcessorVersionRequest.FoundationModelTuningOptions getDefaultInstanceForType()
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getLearningRateMultiplier()

public float getLearningRateMultiplier()

Optional. The multiplier to apply to the recommended learning rate. Valid values are between 0.1 and 10. If not provided, recommended learning rate will be used.

float learning_rate_multiplier = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
float

The learningRateMultiplier.

getTrainSteps()

public int getTrainSteps()

Optional. The number of steps to run for model tuning. Valid values are between 1 and 400. If not provided, recommended steps will be used.

int32 train_steps = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The trainSteps.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(TrainProcessorVersionRequest.FoundationModelTuningOptions other)

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder mergeFrom(TrainProcessorVersionRequest.FoundationModelTuningOptions other)
Parameter
Name Description
other TrainProcessorVersionRequest.FoundationModelTuningOptions
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder
Overrides

setLearningRateMultiplier(float value)

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder setLearningRateMultiplier(float value)

Optional. The multiplier to apply to the recommended learning rate. Valid values are between 0.1 and 10. If not provided, recommended learning rate will be used.

float learning_rate_multiplier = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value float

The learningRateMultiplier to set.

Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder

This builder for chaining.

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

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder
Overrides

setTrainSteps(int value)

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder setTrainSteps(int value)

Optional. The number of steps to run for model tuning. Valid values are between 1 and 400. If not provided, recommended steps will be used.

int32 train_steps = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The trainSteps to set.

Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder
Overrides