Class TextGenerationModel (1.25.0)

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