Reference documentation and code samples for the Google Cloud Document Ai V1 Client class FoundationModelTuningOptions.
Options to control foundation model tuning of the processor.
Generated from protobuf message google.cloud.documentai.v1.TrainProcessorVersionRequest.FoundationModelTuningOptions
Namespace
Google \ Cloud \ DocumentAI \ V1 \ TrainProcessorVersionRequest
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ train_steps
int
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.
↳ learning_rate_multiplier
float
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.
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.
Returns
Type
Description
int
setTrainSteps
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.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
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.
Returns
Type
Description
float
setLearningRateMultiplier
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Document Ai V1 Client - Class FoundationModelTuningOptions (2.3.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.3.0 (latest)](/php/docs/reference/cloud-document-ai/latest/V1.TrainProcessorVersionRequest.FoundationModelTuningOptions)\n- [2.2.2](/php/docs/reference/cloud-document-ai/2.2.2/V1.TrainProcessorVersionRequest.FoundationModelTuningOptions)\n- [2.1.3](/php/docs/reference/cloud-document-ai/2.1.3/V1.TrainProcessorVersionRequest.FoundationModelTuningOptions)\n- [2.0.0](/php/docs/reference/cloud-document-ai/2.0.0/V1.TrainProcessorVersionRequest.FoundationModelTuningOptions)\n- [1.14.0](/php/docs/reference/cloud-document-ai/1.14.0/V1.TrainProcessorVersionRequest.FoundationModelTuningOptions)\n- [1.13.1](/php/docs/reference/cloud-document-ai/1.13.1/V1.TrainProcessorVersionRequest.FoundationModelTuningOptions)\n- [1.12.2](/php/docs/reference/cloud-document-ai/1.12.2/V1.TrainProcessorVersionRequest.FoundationModelTuningOptions)\n- [1.9.0](/php/docs/reference/cloud-document-ai/1.9.0/V1.TrainProcessorVersionRequest.FoundationModelTuningOptions)\n- [1.8.2](/php/docs/reference/cloud-document-ai/1.8.2/V1.TrainProcessorVersionRequest.FoundationModelTuningOptions)\n- [1.7.0](/php/docs/reference/cloud-document-ai/1.7.0/V1.TrainProcessorVersionRequest.FoundationModelTuningOptions)\n- [1.6.0](/php/docs/reference/cloud-document-ai/1.6.0/V1.TrainProcessorVersionRequest.FoundationModelTuningOptions)\n- [1.5.0](/php/docs/reference/cloud-document-ai/1.5.0/V1.TrainProcessorVersionRequest.FoundationModelTuningOptions)\n- [1.4.0](/php/docs/reference/cloud-document-ai/1.4.0/V1.TrainProcessorVersionRequest.FoundationModelTuningOptions)\n- [1.3.0](/php/docs/reference/cloud-document-ai/1.3.0/V1.TrainProcessorVersionRequest.FoundationModelTuningOptions)\n- [1.2.2](/php/docs/reference/cloud-document-ai/1.2.2/V1.TrainProcessorVersionRequest.FoundationModelTuningOptions)\n- [1.1.1](/php/docs/reference/cloud-document-ai/1.1.1/V1.TrainProcessorVersionRequest.FoundationModelTuningOptions)\n- [1.0.1](/php/docs/reference/cloud-document-ai/1.0.1/V1.TrainProcessorVersionRequest.FoundationModelTuningOptions) \nReference documentation and code samples for the Google Cloud Document Ai V1 Client class FoundationModelTuningOptions.\n\nOptions to control foundation model tuning of the processor.\n\nGenerated from protobuf message `google.cloud.documentai.v1.TrainProcessorVersionRequest.FoundationModelTuningOptions`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DocumentAI \\\\ V1 \\\\ TrainProcessorVersionRequest\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getTrainSteps\n\nOptional. The number of steps to run for model tuning. Valid values are\nbetween 1 and 400. If not provided, recommended steps will be used.\n\n### setTrainSteps\n\nOptional. The number of steps to run for model tuning. Valid values are\nbetween 1 and 400. If not provided, recommended steps will be used.\n\n### getLearningRateMultiplier\n\nOptional. The multiplier to apply to the recommended learning rate. Valid\nvalues are between 0.1 and 10. If not provided, recommended learning rate\nwill be used.\n\n### setLearningRateMultiplier\n\nOptional. The multiplier to apply to the recommended learning rate. Valid\nvalues are between 0.1 and 10. If not provided, recommended learning rate\nwill be used."]]
