# Module sft (1.153.1)

1.153.1 (latest) 1.153.0 1.152.0 1.151.0 1.150.0 1.149.0 1.148.1 1.147.0 1.146.0 1.145.0 1.144.0 1.143.0 1.142.0 1.141.0 1.140.0 1.139.0 1.138.0 1.137.0 1.136.0 1.135.0 1.134.0 1.133.0 1.132.0 1.131.0 1.130.0 1.129.0 1.122.0 1.121.0 1.120.0 1.119.0 1.118.0 1.117.0 1.95.1 1.94.0 1.93.1 1.92.0 1.91.0 1.90.0 1.89.0 1.88.0 1.87.0 1.86.0 1.85.0 1.84.0 1.83.0 1.82.0 1.81.0 1.80.0 1.79.0 1.78.0 1.77.0 1.76.0 1.75.0 1.74.0 1.73.0 1.72.0 1.71.1 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 Classes for supervised tuning.

## Classes

### [SupervisedTuningJob](https://docs.cloud.google.com/python/docs/reference/vertexai/latest/vertexai.preview.tuning.sft.SupervisedTuningJob)

    SupervisedTuningJob(tuning_job_name: str)

Initializes class with project, location, and api_client.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `project` | `str` Project of the resource noun. |
| `location` | `str` The location of the resource noun. |
| `credentials` | `google.auth.credentials.Credentials` Optional custom credentials to use when accessing interacting with resource noun. |
| `resource_name` | `str` A fully-qualified resource name or ID. |

## Modules
Functions

### preview_train

    preview_train(
        *,
        source_model: typing.Union[
            str,
            vertexai.generative_models.GenerativeModel,
            vertexai.preview.tuning._tuning.SourceModel,
        ],
        train_dataset: typing.Union[
            str, google.cloud.aiplatform.preview.datasets.MultimodalDataset
        ],
        validation_dataset: typing.Optional[
            typing.Union[str, google.cloud.aiplatform.preview.datasets.MultimodalDataset]
        ] = None,
        tuned_model_display_name: typing.Optional[str] = None,
        tuning_mode: typing.Optional[typing.Literal["FULL", "PEFT_ADAPTER"]] = None,
        epochs: typing.Optional[int] = None,
        learning_rate: typing.Optional[float] = None,
        learning_rate_multiplier: typing.Optional[float] = None,
        adapter_size: typing.Optional[typing.Literal[1, 4, 8, 16, 32]] = None,
        labels: typing.Optional[typing.Dict[str, str]] = None,
        output_uri: typing.Optional[str] = None
    ) -> vertexai.preview.tuning._supervised_tuning.SupervisedTuningJob

Tunes a model using supervised training.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `source_model` | `str` Model name for tuning, e.g., "gemini-1.0-pro-002". |

### rebase_tuned_model

    rebase_tuned_model(
        tuned_model_ref: str,
        *,
        artifact_destination: typing.Optional[str] = None,
        deploy_to_same_endpoint: typing.Optional[bool] = False
    )

Re-runs fine tuning on top of a new foundational model.

Takes a legacy Tuned GenAI model Reference and creates a TuningJob based
on a new model.

### train

    train(
        *,
        source_model: typing.Union[
            str,
            vertexai.generative_models.GenerativeModel,
            vertexai.tuning._tuning.SourceModel,
        ],
        train_dataset: typing.Union[
            str, google.cloud.aiplatform.preview.datasets.MultimodalDataset
        ],
        validation_dataset: typing.Optional[
            typing.Union[str, google.cloud.aiplatform.preview.datasets.MultimodalDataset]
        ] = None,
        tuned_model_display_name: typing.Optional[str] = None,
        tuning_mode: typing.Optional[typing.Literal["FULL", "PEFT_ADAPTER"]] = None,
        epochs: typing.Optional[int] = None,
        learning_rate: typing.Optional[float] = None,
        learning_rate_multiplier: typing.Optional[float] = None,
        adapter_size: typing.Optional[typing.Literal[1, 4, 8, 16, 32]] = None,
        labels: typing.Optional[typing.Dict[str, str]] = None,
        output_uri: typing.Optional[str] = None
    ) -> vertexai.tuning._supervised_tuning.SupervisedTuningJob

Tunes a model using supervised training.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `source_model` | `str` Model name for tuning, e.g., "gemini-1.0-pro-002". |