together 1.2.11__py3-none-any.whl → 2.0.0a8__py3-none-any.whl

together/resources/finetune.py

@@ -1,489 +0,0 @@
-from __future__ import annotations
-
-from pathlib import Path
-
-from together.abstract import api_requestor
-from together.filemanager import DownloadManager
-from together.together_response import TogetherResponse
-from together.types import (
-    FinetuneDownloadResult,
-    FinetuneList,
-    FinetuneListEvents,
-    FinetuneRequest,
-    FinetuneResponse,
-    FullTrainingType,
-    LoRATrainingType,
-    TogetherClient,
-    TogetherRequest,
-    TrainingType,
-)
-from together.types.finetune import DownloadCheckpointType
-from together.utils import log_warn, normalize_key
-
-
-class FineTuning:
-    def __init__(self, client: TogetherClient) -> None:
-        self._client = client
-
-    def create(
-        self,
-        *,
-        training_file: str,
-        model: str,
-        n_epochs: int = 1,
-        validation_file: str | None = "",
-        n_evals: int | None = 0,
-        n_checkpoints: int | None = 1,
-        batch_size: int | None = 16,
-        learning_rate: float | None = 0.00001,
-        lora: bool = False,
-        lora_r: int | None = 8,
-        lora_dropout: float | None = 0,
-        lora_alpha: float | None = 8,
-        lora_trainable_modules: str | None = "all-linear",
-        suffix: str | None = None,
-        wandb_api_key: str | None = None,
-    ) -> FinetuneResponse:
-        """
-        Method to initiate a fine-tuning job
-
-        Args:
-            training_file (str): File-ID of a file uploaded to the Together API
-            model (str): Name of the base model to run fine-tune job on
-            n_epochs (int, optional): Number of epochs for fine-tuning. Defaults to 1.
-            validation file (str, optional): File ID of a file uploaded to the Together API for validation.
-            n_evals (int, optional): Number of evaluation loops to run. Defaults to 0.
-            n_checkpoints (int, optional): Number of checkpoints to save during fine-tuning.
-                Defaults to 1.
-            batch_size (int, optional): Batch size for fine-tuning. Defaults to 32.
-            learning_rate (float, optional): Learning rate multiplier to use for training
-                Defaults to 0.00001.
-            lora (bool, optional): Whether to use LoRA adapters. Defaults to True.
-            lora_r (int, optional): Rank of LoRA adapters. Defaults to 8.
-            lora_dropout (float, optional): Dropout rate for LoRA adapters. Defaults to 0.
-            lora_alpha (float, optional): Alpha for LoRA adapters. Defaults to 8.
-            lora_trainable_modules (str, optional): Trainable modules for LoRA adapters. Defaults to "all-linear".
-            suffix (str, optional): Up to 40 character suffix that will be added to your fine-tuned model name.
-                Defaults to None.
-            wandb_api_key (str, optional): API key for Weights & Biases integration.
-                Defaults to None.
-
-        Returns:
-            FinetuneResponse: Object containing information about fine-tuning job.
-        """
-
-        requestor = api_requestor.APIRequestor(
-            client=self._client,
-        )
-
-        training_type: TrainingType = FullTrainingType()
-        if lora:
-            training_type = LoRATrainingType(
-                lora_r=lora_r,
-                lora_alpha=lora_alpha,
-                lora_dropout=lora_dropout,
-                lora_trainable_modules=lora_trainable_modules,
-            )
-
-        parameter_payload = FinetuneRequest(
-            model=model,
-            training_file=training_file,
-            validation_file=validation_file,
-            n_epochs=n_epochs,
-            n_evals=n_evals,
-            n_checkpoints=n_checkpoints,
-            batch_size=batch_size,
-            learning_rate=learning_rate,
-            training_type=training_type,
-            suffix=suffix,
-            wandb_key=wandb_api_key,
-        ).model_dump(exclude_none=True)
-
-        response, _, _ = requestor.request(
-            options=TogetherRequest(
-                method="POST",
-                url="fine-tunes",
-                params=parameter_payload,
-            ),
-            stream=False,
-        )
-
-        assert isinstance(response, TogetherResponse)
-
-        # TODO: Remove it after the 21st of August
-        log_warn(
-            "The default value of batch size has been changed from 32 to 16 since together version >= 1.2.6"
-        )
-
-        # TODO: Remove after next LoRA default change
-        log_warn(
-            "Some of the jobs run _directly_ from the together-python library might be trained using LoRA adapters. "
-            "The version range when this change occurred is from 1.2.3 to 1.2.6."
-        )
-
-        return FinetuneResponse(**response.data)
-
-    def list(self) -> FinetuneList:
-        """
-        Lists fine-tune job history
-
-        Returns:
-            FinetuneList: Object containing a list of fine-tune jobs
-        """
-
-        requestor = api_requestor.APIRequestor(
-            client=self._client,
-        )
-
-        response, _, _ = requestor.request(
-            options=TogetherRequest(
-                method="GET",
-                url="fine-tunes",
-            ),
-            stream=False,
-        )
-
-        assert isinstance(response, TogetherResponse)
-
-        return FinetuneList(**response.data)
-
-    def retrieve(self, id: str) -> FinetuneResponse:
-        """
-        Retrieves fine-tune job details
-
-        Args:
-            id (str): Fine-tune ID to retrieve. A string that starts with `ft-`.
-
-        Returns:
-            FinetuneResponse: Object containing information about fine-tuning job.
-        """
-
-        requestor = api_requestor.APIRequestor(
-            client=self._client,
-        )
-
-        response, _, _ = requestor.request(
-            options=TogetherRequest(
-                method="GET",
-                url=f"fine-tunes/{id}",
-            ),
-            stream=False,
-        )
-
-        assert isinstance(response, TogetherResponse)
-
-        return FinetuneResponse(**response.data)
-
-    def cancel(self, id: str) -> FinetuneResponse:
-        """
-        Method to cancel a running fine-tuning job
-
-        Args:
-            id (str): Fine-tune ID to cancel. A string that starts with `ft-`.
-
-        Returns:
-            FinetuneResponse: Object containing information about cancelled fine-tuning job.
-        """
-
-        requestor = api_requestor.APIRequestor(
-            client=self._client,
-        )
-
-        response, _, _ = requestor.request(
-            options=TogetherRequest(
-                method="POST",
-                url=f"fine-tunes/{id}/cancel",
-            ),
-            stream=False,
-        )
-
-        assert isinstance(response, TogetherResponse)
-
-        return FinetuneResponse(**response.data)
-
-    def list_events(self, id: str) -> FinetuneListEvents:
-        """
-        Lists events of a fine-tune job
-
-        Args:
-            id (str): Fine-tune ID to list events for. A string that starts with `ft-`.
-
-        Returns:
-            FinetuneListEvents: Object containing list of fine-tune events
-        """
-
-        requestor = api_requestor.APIRequestor(
-            client=self._client,
-        )
-
-        response, _, _ = requestor.request(
-            options=TogetherRequest(
-                method="GET",
-                url=f"fine-tunes/{id}/events",
-            ),
-            stream=False,
-        )
-
-        assert isinstance(response, TogetherResponse)
-
-        return FinetuneListEvents(**response.data)
-
-    def download(
-        self,
-        id: str,
-        *,
-        output: Path | str | None = None,
-        checkpoint_step: int = -1,
-        checkpoint_type: DownloadCheckpointType = DownloadCheckpointType.DEFAULT,
-    ) -> FinetuneDownloadResult:
-        """
-        Downloads compressed fine-tuned model or checkpoint to local disk.
-
-        Defaults file location to `$PWD/{model_name}.{extension}`
-
-        Args:
-            id (str): Fine-tune ID to download. A string that starts with `ft-`.
-            output (pathlib.Path | str, optional): Specifies output file name for downloaded model.
-                Defaults to None.
-            checkpoint_step (int, optional): Specifies step number for checkpoint to download.
-                Defaults to -1 (download the final model)
-            checkpoint_type (CheckpointType, optional): Specifies which checkpoint to download.
-                Defaults to CheckpointType.DEFAULT.
-
-        Returns:
-            FinetuneDownloadResult: Object containing downloaded model metadata
-        """
-
-        url = f"finetune/download?ft_id={id}"
-
-        if checkpoint_step > 0:
-            url += f"&checkpoint_step={checkpoint_step}"
-
-        ft_job = self.retrieve(id)
-
-        if isinstance(ft_job.training_type, FullTrainingType):
-            if checkpoint_type != DownloadCheckpointType.DEFAULT:
-                raise ValueError(
-                    "Only DEFAULT checkpoint type is allowed for FullTrainingType"
-                )
-            url += f"&checkpoint=modelOutputPath"
-        elif isinstance(ft_job.training_type, LoRATrainingType):
-            if checkpoint_type == DownloadCheckpointType.DEFAULT:
-                checkpoint_type = DownloadCheckpointType.MERGED
-
-            if checkpoint_type == DownloadCheckpointType.MERGED:
-                url += f"&checkpoint={DownloadCheckpointType.MERGED.value}"
-            elif checkpoint_type == DownloadCheckpointType.ADAPTER:
-                url += f"&checkpoint={DownloadCheckpointType.ADAPTER.value}"
-            else:
-                raise ValueError(
-                    f"Invalid checkpoint type for LoRATrainingType: {checkpoint_type}"
-                )
-
-        remote_name = ft_job.output_name
-
-        download_manager = DownloadManager(self._client)
-
-        if isinstance(output, str):
-            output = Path(output)
-
-        downloaded_filename, file_size = download_manager.download(
-            url, output, normalize_key(remote_name or id), fetch_metadata=True
-        )
-
-        return FinetuneDownloadResult(
-            object="local",
-            id=id,
-            checkpoint_step=checkpoint_step,
-            filename=downloaded_filename,
-            size=file_size,
-        )
-
-
-class AsyncFineTuning:
-    def __init__(self, client: TogetherClient) -> None:
-        self._client = client
-
-    async def create(
-        self,
-        *,
-        training_file: str,
-        model: str,
-        n_epochs: int = 1,
-        validation_file: str | None = "",
-        n_evals: int = 0,
-        n_checkpoints: int | None = 1,
-        batch_size: int | None = 32,
-        learning_rate: float = 0.00001,
-        suffix: str | None = None,
-        wandb_api_key: str | None = None,
-    ) -> FinetuneResponse:
-        """
-        Async method to initiate a fine-tuning job
-
-        Args:
-            training_file (str): File-ID of a file uploaded to the Together API
-            model (str): Name of the base model to run fine-tune job on
-            n_epochs (int, optional): Number of epochs for fine-tuning. Defaults to 1.
-            validation file (str, optional): File ID of a file uploaded to the Together API for validation.
-            n_evals (int, optional): Number of evaluation loops to run. Defaults to 0.
-            n_checkpoints (int, optional): Number of checkpoints to save during fine-tuning.
-                Defaults to 1.
-            batch_size (int, optional): Batch size for fine-tuning. Defaults to 32.
-            learning_rate (float, optional): Learning rate multiplier to use for training
-                Defaults to 0.00001.
-            suffix (str, optional): Up to 40 character suffix that will be added to your fine-tuned model name.
-                Defaults to None.
-            wandb_api_key (str, optional): API key for Weights & Biases integration.
-                Defaults to None.
-
-        Returns:
-            FinetuneResponse: Object containing information about fine-tuning job.
-        """
-
-        requestor = api_requestor.APIRequestor(
-            client=self._client,
-        )
-
-        parameter_payload = FinetuneRequest(
-            model=model,
-            training_file=training_file,
-            validation_file=validation_file,
-            n_epochs=n_epochs,
-            n_evals=n_evals,
-            n_checkpoints=n_checkpoints,
-            batch_size=batch_size,
-            learning_rate=learning_rate,
-            suffix=suffix,
-            wandb_key=wandb_api_key,
-        ).model_dump(exclude_none=True)
-
-        response, _, _ = await requestor.arequest(
-            options=TogetherRequest(
-                method="POST",
-                url="fine-tunes",
-                params=parameter_payload,
-            ),
-            stream=False,
-        )
-
-        assert isinstance(response, TogetherResponse)
-
-        return FinetuneResponse(**response.data)
-
-    async def list(self) -> FinetuneList:
-        """
-        Async method to list fine-tune job history
-
-        Returns:
-            FinetuneList: Object containing a list of fine-tune jobs
-        """
-
-        requestor = api_requestor.APIRequestor(
-            client=self._client,
-        )
-
-        response, _, _ = await requestor.arequest(
-            options=TogetherRequest(
-                method="GET",
-                url="fine-tunes",
-            ),
-            stream=False,
-        )
-
-        assert isinstance(response, TogetherResponse)
-
-        return FinetuneList(**response.data)
-
-    async def retrieve(self, id: str) -> FinetuneResponse:
-        """
-        Async method to retrieve fine-tune job details
-
-        Args:
-            id (str): Fine-tune ID to retrieve. A string that starts with `ft-`.
-
-        Returns:
-            FinetuneResponse: Object containing information about fine-tuning job.
-        """
-
-        requestor = api_requestor.APIRequestor(
-            client=self._client,
-        )
-
-        response, _, _ = await requestor.arequest(
-            options=TogetherRequest(
-                method="GET",
-                url=f"fine-tunes/{id}",
-            ),
-            stream=False,
-        )
-
-        assert isinstance(response, TogetherResponse)
-
-        return FinetuneResponse(**response.data)
-
-    async def cancel(self, id: str) -> FinetuneResponse:
-        """
-        Async method to cancel a running fine-tuning job
-
-        Args:
-            id (str): Fine-tune ID to cancel. A string that starts with `ft-`.
-
-        Returns:
-            FinetuneResponse: Object containing information about cancelled fine-tuning job.
-        """
-
-        requestor = api_requestor.APIRequestor(
-            client=self._client,
-        )
-
-        response, _, _ = await requestor.arequest(
-            options=TogetherRequest(
-                method="POST",
-                url=f"fine-tunes/{id}/cancel",
-            ),
-            stream=False,
-        )
-
-        assert isinstance(response, TogetherResponse)
-
-        return FinetuneResponse(**response.data)
-
-    async def list_events(self, id: str) -> FinetuneListEvents:
-        """
-        Async method to lists events of a fine-tune job
-
-        Args:
-            id (str): Fine-tune ID to list events for. A string that starts with `ft-`.
-
-        Returns:
-            FinetuneListEvents: Object containing list of fine-tune events
-        """
-
-        requestor = api_requestor.APIRequestor(
-            client=self._client,
-        )
-
-        response, _, _ = await requestor.arequest(
-            options=TogetherRequest(
-                method="GET",
-                url=f"fine-tunes/{id}/events",
-            ),
-            stream=False,
-        )
-
-        assert isinstance(response, TogetherResponse)
-
-        return FinetuneListEvents(**response.data)
-
-    async def download(
-        self, id: str, *, output: str | None = None, checkpoint_step: int = -1
-    ) -> str:
-        """
-        TODO: Implement async download method
-        """
-
-        raise NotImplementedError(
-            "AsyncFineTuning.download not implemented. "
-            "Please use FineTuning.download function instead."
-        )

together/together_response.py

@@ -1,50 +0,0 @@
-from __future__ import annotations
-
-from typing import Any, Dict
-
-
-class TogetherResponse:
-    """
-    API Response class. Stores headers and response data.
-    """
-
-    def __init__(self, data: Dict[str, Any], headers: Dict[str, Any]):
-        self._headers = headers
-        self.data = data
-
-    @property
-    def request_id(self) -> str | None:
-        """
-        Fetches request id from headers
-        """
-        if "cf-ray" in self._headers:
-            return str(self._headers["cf-ray"])
-        return None
-
-    @property
-    def requests_remaining(self) -> int | None:
-        """
-        Number of requests remaining at current rate limit
-        """
-        if "x-ratelimit-remaining" in self._headers:
-            return int(self._headers["x-ratelimit-remaining"])
-        return None
-
-    @property
-    def processed_by(self) -> str | None:
-        """
-        Processing host server name
-        """
-        if "x-hostname" in self._headers:
-            return str(self._headers["x-hostname"])
-        return None
-
-    @property
-    def response_ms(self) -> int | None:
-        """
-        Server request completion time
-        """
-        if "x-total-time" in self._headers:
-            h = self._headers["x-total-time"]
-            return None if h is None else round(float(h))
-        return None

together/types/abstract.py

@@ -1,26 +0,0 @@
-from __future__ import annotations
-
-from dataclasses import dataclass
-from typing import Dict
-
-import pydantic
-from pydantic import ConfigDict
-from typing_extensions import ClassVar
-
-from together.constants import BASE_URL, MAX_RETRIES, TIMEOUT_SECS
-
-
-PYDANTIC_V2 = pydantic.VERSION.startswith("2.")
-
-
-@dataclass
-class TogetherClient:
-    api_key: str | None = None
-    base_url: str | None = BASE_URL
-    timeout: float | None = TIMEOUT_SECS
-    max_retries: int | None = MAX_RETRIES
-    supplied_headers: Dict[str, str] | None = None
-
-
-class BaseModel(pydantic.BaseModel):
-    model_config: ClassVar[ConfigDict] = ConfigDict(extra="allow")