Class TrainProcessorVersionRequest.FoundationModelTuningOptions (2.48.0)

public static final class TrainProcessorVersionRequest.FoundationModelTuningOptions extends GeneratedMessageV3 implements TrainProcessorVersionRequest.FoundationModelTuningOptionsOrBuilder

Options to control foundation model tuning of the processor.

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

Inheritance

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

Static Fields

LEARNING_RATE_MULTIPLIER_FIELD_NUMBER

public static final int LEARNING_RATE_MULTIPLIER_FIELD_NUMBER
Field Value
Type Description
int

TRAIN_STEPS_FIELD_NUMBER

public static final int TRAIN_STEPS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TrainProcessorVersionRequest.FoundationModelTuningOptions getDefaultInstance()
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions

getDescriptor()

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

newBuilder()

public static TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder newBuilder()
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder

newBuilder(TrainProcessorVersionRequest.FoundationModelTuningOptions prototype)

public static TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder newBuilder(TrainProcessorVersionRequest.FoundationModelTuningOptions prototype)
Parameter
Name Description
prototype TrainProcessorVersionRequest.FoundationModelTuningOptions
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder

parseDelimitedFrom(InputStream input)

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<TrainProcessorVersionRequest.FoundationModelTuningOptions> parser()
Returns
Type Description
Parser<FoundationModelTuningOptions>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

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

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.

getParserForType()

public Parser<TrainProcessorVersionRequest.FoundationModelTuningOptions> getParserForType()
Returns
Type Description
Parser<FoundationModelTuningOptions>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder newBuilderForType()
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder toBuilder()
Returns
Type Description
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException