Reference documentation and code samples for the Document AI V1beta3 API class Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::FoundationModelTuningOptions.
Options to control foundation model tuning of the processor.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#learning_rate_multiplier
deflearning_rate_multiplier()->::Float
Returns
(::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.
#learning_rate_multiplier=
deflearning_rate_multiplier=(value)->::Float
Parameter
value (::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.
Returns
(::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.
#train_steps
deftrain_steps()->::Integer
Returns
(::Integer) — 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.
#train_steps=
deftrain_steps=(value)->::Integer
Parameter
value (::Integer) — 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
(::Integer) — 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.
[[["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,["# Document AI V1beta3 API - Class Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::FoundationModelTuningOptions (v0.43.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.43.1 (latest)](/ruby/docs/reference/google-cloud-document_ai-v1beta3/latest/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.43.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.43.0/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.42.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.42.0/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.41.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.41.0/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.40.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.40.0/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.39.1](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.39.1/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.38.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.38.0/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.37.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.37.0/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.36.1](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.36.1/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.35.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.35.0/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.34.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.34.0/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.33.1](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.33.1/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.32.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.32.0/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.31.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.31.0/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.30.2](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.30.2/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.29.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.29.0/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.28.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.28.0/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.27.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.27.0/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.26.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.26.0/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.25.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.25.0/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.24.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.24.0/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.23.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.23.0/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.22.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.22.0/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.21.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.21.0/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.20.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.20.0/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.19.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.19.0/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.18.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.18.0/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.17.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.17.0/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.16.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.16.0/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.15.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.15.0/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.14.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.14.0/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.13.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.13.0/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.12.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.12.0/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.11.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.11.0/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.10.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.10.0/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions)\n- [0.9.4](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.9.4/Google-Cloud-DocumentAI-V1beta3-TrainProcessorVersionRequest-FoundationModelTuningOptions) \nReference documentation and code samples for the Document AI V1beta3 API class Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::FoundationModelTuningOptions.\n\nOptions to control foundation model tuning of the processor. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #learning_rate_multiplier\n\n def learning_rate_multiplier() -\u003e ::Float\n\n**Returns**\n\n- (::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.\n\n### #learning_rate_multiplier=\n\n def learning_rate_multiplier=(value) -\u003e ::Float\n\n**Parameter**\n\n- **value** (::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. \n**Returns**\n\n- (::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.\n\n### #train_steps\n\n def train_steps() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- 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.\n\n### #train_steps=\n\n def train_steps=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- 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. \n**Returns**\n\n- (::Integer) --- 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."]]