Class TextGenerationModel (1.25.0)

Version 1.25.0

• 1.71.1 (latest)
• 1.71.0
• 1.70.0
• 1.69.0
• 1.68.0
• 1.67.1
• 1.66.0
• 1.65.0
• 1.63.0
• 1.62.0
• 1.60.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.1
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.39.0
• 1.38.1
• 1.37.0
• 1.36.4
• 1.35.0
• 1.34.0
• 1.33.1
• 1.32.0
• 1.31.1
• 1.30.1
• 1.29.0
• 1.28.1
• 1.27.1
• 1.26.1
• 1.25.0
• 1.24.1
• 1.23.0
• 1.22.1
• 1.21.0
• 1.20.0
• 1.19.1
• 1.18.3
• 1.17.1
• 1.16.1
• 1.15.1
• 1.14.0
• 1.13.1
• 1.12.1
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.1
• 1.7.1
• 1.6.2
• 1.5.0
• 1.4.3
• 1.3.0
• 1.2.0
• 1.1.1
• 1.0.1
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.1
• 0.4.0
• 0.3.1

TextGenerationModel(model_id: str, endpoint_name: Optional[str] = None)

TextGenerationModel represents a general language model.

.. rubric:: Examples

Getting answers:

model = TextGenerationModel.from_pretrained("text-bison@001") model.predict("What is life?")

Inheritance

builtins.object > vertexai.language_models._language_models._LanguageModel > TextGenerationModel

Methods

TextGenerationModel

TextGenerationModel(model_id: str, endpoint_name: Optional[str] = None)

Creates a LanguageModel.

This constructor should not be called directly. Use LanguageModel.from_pretrained(model_name=...) instead.

from_pretrained

from_pretrained(model_name: str)

Loads a LanguageModel.

Exceptions
Type	Description
ValueError	If model_name is unknown.
ValueError	If model does not support this class.

get_tuned_model

get_tuned_model(tuned_model_name: str)

Loads the specified tuned language model.

list_tuned_model_names

list_tuned_model_names()

Lists the names of tuned models.

predict

predict(
    prompt: str,
    *,
    max_output_tokens: int = 128,
    temperature: float = 0.0,
    top_k: int = 40,
    top_p: float = 0.95
)

Gets model response for a single prompt.

tune_model

tune_model(
    training_data: Union[str, pandas.core.frame.DataFrame],
    *,
    train_steps: int = 1000,
    tuning_job_location: Optional[str] = None,
    tuned_model_location: Optional[str] = None,
    model_display_name: Optional[str] = None
)

Tunes a model based on training data.

This method launches a model tuning job that can take some time.

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