Class _TunableModelMixin (1.95.1)
Stay organized with collections
Save and categorize content based on your preferences.
_TunableModelMixin(model_id: str, endpoint_name: typing.Optional[str] = None)
Model that can be tuned with supervised fine tuning (SFT).
Methods
_TunableModelMixin
_TunableModelMixin(model_id: str, endpoint_name: typing.Optional[str] = None)
Creates a LanguageModel.
This constructor should not be called directly.
Use LanguageModel.from_pretrained(model_name=...)
instead.
tune_model
tune_model(
training_data: typing.Union[str, pandas.core.frame.DataFrame],
*,
corpus_data: typing.Optional[str] = None,
queries_data: typing.Optional[str] = None,
test_data: typing.Optional[str] = None,
validation_data: typing.Optional[str] = None,
batch_size: typing.Optional[int] = None,
train_steps: typing.Optional[int] = None,
learning_rate: typing.Optional[float] = None,
learning_rate_multiplier: typing.Optional[float] = None,
tuning_job_location: typing.Optional[str] = None,
tuned_model_location: typing.Optional[str] = None,
model_display_name: typing.Optional[str] = None,
tuning_evaluation_spec: typing.Optional[
vertexai.language_models.TuningEvaluationSpec
] = None,
default_context: typing.Optional[str] = None,
task_type: typing.Optional[str] = None,
machine_type: typing.Optional[str] = None,
accelerator: typing.Optional[str] = None,
accelerator_count: typing.Optional[int] = None,
accelerator_type: typing.Optional[typing.Literal["TPU", "GPU"]] = None,
max_context_length: typing.Optional[str] = None,
output_dimensionality: typing.Optional[int] = None
) -> vertexai.language_models._language_models._LanguageModelTuningJob
Tunes a model based on training data.
This method launches and returns an asynchronous model tuning job.
Usage:
tuning_job = model.tune_model(...)
... do some other work
tuned_model = tuning_job.get_tuned_model() # Blocks until tuning is complete
Exceptions |
Type |
Description |
ValueError |
If the "tuning_job_location" value is not supported |
ValueError |
If the "tuned_model_location" value is not supported |
RuntimeError |
If the model does not support tuning |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-07 UTC.
[[["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-08-07 UTC."],[],[],null,["# Class _TunableModelMixin (1.95.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.95.1 (latest)](/python/docs/reference/vertexai/latest/vertexai.language_models._language_models._TunableModelMixin)\n- [1.94.0](/python/docs/reference/vertexai/1.94.0/vertexai.language_models._language_models._TunableModelMixin)\n- [1.93.1](/python/docs/reference/vertexai/1.93.1/vertexai.language_models._language_models._TunableModelMixin)\n- [1.92.0](/python/docs/reference/vertexai/1.92.0/vertexai.language_models._language_models._TunableModelMixin)\n- [1.91.0](/python/docs/reference/vertexai/1.91.0/vertexai.language_models._language_models._TunableModelMixin)\n- [1.90.0](/python/docs/reference/vertexai/1.90.0/vertexai.language_models._language_models._TunableModelMixin)\n- [1.89.0](/python/docs/reference/vertexai/1.89.0/vertexai.language_models._language_models._TunableModelMixin)\n- [1.88.0](/python/docs/reference/vertexai/1.88.0/vertexai.language_models._language_models._TunableModelMixin)\n- [1.87.0](/python/docs/reference/vertexai/1.87.0/vertexai.language_models._language_models._TunableModelMixin)\n- [1.86.0](/python/docs/reference/vertexai/1.86.0/vertexai.language_models._language_models._TunableModelMixin)\n- [1.85.0](/python/docs/reference/vertexai/1.85.0/vertexai.language_models._language_models._TunableModelMixin)\n- [1.84.0](/python/docs/reference/vertexai/1.84.0/vertexai.language_models._language_models._TunableModelMixin)\n- [1.83.0](/python/docs/reference/vertexai/1.83.0/vertexai.language_models._language_models._TunableModelMixin)\n- [1.82.0](/python/docs/reference/vertexai/1.82.0/vertexai.language_models._language_models._TunableModelMixin)\n- [1.81.0](/python/docs/reference/vertexai/1.81.0/vertexai.language_models._language_models._TunableModelMixin)\n- [1.80.0](/python/docs/reference/vertexai/1.80.0/vertexai.language_models._language_models._TunableModelMixin)\n- [1.79.0](/python/docs/reference/vertexai/1.79.0/vertexai.language_models._language_models._TunableModelMixin)\n- [1.78.0](/python/docs/reference/vertexai/1.78.0/vertexai.language_models._language_models._TunableModelMixin)\n- [1.77.0](/python/docs/reference/vertexai/1.77.0/vertexai.language_models._language_models._TunableModelMixin)\n- [1.76.0](/python/docs/reference/vertexai/1.76.0/vertexai.language_models._language_models._TunableModelMixin)\n- [1.75.0](/python/docs/reference/vertexai/1.75.0/vertexai.language_models._language_models._TunableModelMixin)\n- [1.74.0](/python/docs/reference/vertexai/1.74.0/vertexai.language_models._language_models._TunableModelMixin)\n- [1.73.0](/python/docs/reference/vertexai/1.73.0/vertexai.language_models._language_models._TunableModelMixin)\n- [1.72.0](/python/docs/reference/vertexai/1.72.0/vertexai.language_models._language_models._TunableModelMixin)\n- [1.71.1](/python/docs/reference/vertexai/1.71.1/vertexai.language_models._language_models._TunableModelMixin)\n- [1.70.0](/python/docs/reference/vertexai/1.70.0/vertexai.language_models._language_models._TunableModelMixin)\n- [1.69.0](/python/docs/reference/vertexai/1.69.0/vertexai.language_models._language_models._TunableModelMixin)\n- [1.68.0](/python/docs/reference/vertexai/1.68.0/vertexai.language_models._language_models._TunableModelMixin)\n- [1.67.1](/python/docs/reference/vertexai/1.67.1/vertexai.language_models._language_models._TunableModelMixin)\n- [1.66.0](/python/docs/reference/vertexai/1.66.0/vertexai.language_models._language_models._TunableModelMixin)\n- [1.65.0](/python/docs/reference/vertexai/1.65.0/vertexai.language_models._language_models._TunableModelMixin)\n- [1.63.0](/python/docs/reference/vertexai/1.63.0/vertexai.language_models._language_models._TunableModelMixin)\n- [1.62.0](/python/docs/reference/vertexai/1.62.0/vertexai.language_models._language_models._TunableModelMixin)\n- [1.60.0](/python/docs/reference/vertexai/1.60.0/vertexai.language_models._language_models._TunableModelMixin)\n- [1.59.0](/python/docs/reference/vertexai/1.59.0/vertexai.language_models._language_models._TunableModelMixin) \n\n _TunableModelMixin(model_id: str, endpoint_name: typing.Optional[str] = None)\n\nModel that can be tuned with supervised fine tuning (SFT).\n\nMethods\n-------\n\n### _TunableModelMixin\n\n _TunableModelMixin(model_id: str, endpoint_name: typing.Optional[str] = None)\n\nCreates a LanguageModel.\n\nThis constructor should not be called directly.\nUse `LanguageModel.from_pretrained(model_name=...)` instead.\n\n### tune_model\n\n tune_model(\n training_data: typing.Union[str, pandas.core.frame.DataFrame],\n *,\n corpus_data: typing.Optional[str] = None,\n queries_data: typing.Optional[str] = None,\n test_data: typing.Optional[str] = None,\n validation_data: typing.Optional[str] = None,\n batch_size: typing.Optional[int] = None,\n train_steps: typing.Optional[int] = None,\n learning_rate: typing.Optional[float] = None,\n learning_rate_multiplier: typing.Optional[float] = None,\n tuning_job_location: typing.Optional[str] = None,\n tuned_model_location: typing.Optional[str] = None,\n model_display_name: typing.Optional[str] = None,\n tuning_evaluation_spec: typing.Optional[\n vertexai.language_models.TuningEvaluationSpec\n ] = None,\n default_context: typing.Optional[str] = None,\n task_type: typing.Optional[str] = None,\n machine_type: typing.Optional[str] = None,\n accelerator: typing.Optional[str] = None,\n accelerator_count: typing.Optional[int] = None,\n accelerator_type: typing.Optional[typing.Literal[\"TPU\", \"GPU\"]] = None,\n max_context_length: typing.Optional[str] = None,\n output_dimensionality: typing.Optional[int] = None\n ) -\u003e vertexai.language_models._language_models._LanguageModelTuningJob\n\nTunes a model based on training data.\n\nThis method launches and returns an asynchronous model tuning job.\nUsage: \n\n tuning_job = model.tune_model(...)\n ... do some other work\n tuned_model = tuning_job.get_tuned_model() # Blocks until tuning is complete"]]