together 1.5.35__py3-none-any.whl → 2.0.0a6__py3-none-any.whl

together/{cli → lib/cli}/api/files.py

@@ -1,5 +1,6 @@
 import json
 import pathlib
+from typing import Any, Dict, List, get_args
 from textwrap import wrap
 
 import click
@@ -7,7 +8,9 @@ from tabulate import tabulate
 
 from together import Together
 from together.types import FilePurpose
-from together.utils import check_file, convert_bytes, convert_unix_timestamp
+
+# from together.utils import check_file, convert_bytes, convert_unix_timestamp
+from ...utils import check_file, convert_bytes, convert_unix_timestamp
 
 
 @click.group()
@@ -21,15 +24,13 @@ def files(ctx: click.Context) -> None:
 @click.pass_context
 @click.argument(
     "file",
-    type=click.Path(
-        exists=True, file_okay=True, resolve_path=True, readable=True, dir_okay=False
-    ),
+    type=click.Path(exists=True, file_okay=True, resolve_path=True, readable=True, dir_okay=False),
     required=True,
 )
 @click.option(
     "--purpose",
-    type=str,
-    default=FilePurpose.FineTune.value,
+    type=click.Choice(get_args(FilePurpose)),
+    default="fine-tune",
     help="Purpose of file upload. Acceptable values in enum `together.types.FilePurpose`. Defaults to `fine-tunes`.",
 )
 @click.option(
@@ -37,7 +38,7 @@ def files(ctx: click.Context) -> None:
     default=True,
     help="Whether to check the file before uploading.",
 )
-def upload(ctx: click.Context, file: pathlib.Path, purpose: str, check: bool) -> None:
+def upload(ctx: click.Context, file: pathlib.Path, purpose: FilePurpose, check: bool) -> None:
     """Upload file"""
 
     client: Together = ctx.obj
@@ -55,15 +56,13 @@ def list(ctx: click.Context) -> None:
 
     response = client.files.list()
 
-    display_list = []
+    display_list: List[Dict[str, Any]] = []
     for i in response.data or []:
         display_list.append(
             {
                 "File name": "\n".join(wrap(i.filename or "", width=30)),
                 "File ID": i.id,
-                "Size": convert_bytes(
-                    float(str(i.bytes))
-                ),  # convert to string for mypy typing
+                "Size": convert_bytes(float(str(i.bytes))),  # convert to string for mypy typing
                 "Created At": convert_unix_timestamp(i.created_at or 0),
                 "Line Count": i.line_count,
             }
@@ -95,9 +94,15 @@ def retrieve_content(ctx: click.Context, id: str, output: str) -> None:
 
     client: Together = ctx.obj
 
-    response = client.files.retrieve_content(id=id, output=output)
+    response = client.files.content(id=id)
 
-    click.echo(json.dumps(response.model_dump(exclude_none=True), indent=4))
+    if output:
+        with open(output, "wb") as f:
+            f.write(response.read())
+        click.echo(f"File saved to {output}")
+
+    else:
+        click.echo(response.read().decode("utf-8"))
 
 
 @files.command()
@@ -117,12 +122,10 @@ def delete(ctx: click.Context, id: str) -> None:
 @click.pass_context
 @click.argument(
     "file",
-    type=click.Path(
-        exists=True, file_okay=True, resolve_path=True, readable=True, dir_okay=False
-    ),
+    type=click.Path(exists=True, file_okay=True, resolve_path=True, readable=True, dir_okay=False),
     required=True,
 )
-def check(ctx: click.Context, file: pathlib.Path) -> None:
+def check(_ctx: click.Context, file: pathlib.Path) -> None:
     """Check file for issues"""
 
     report = check_file(file)

together/{cli/api/finetune.py → lib/cli/api/fine_tuning.py}

@@ -1,54 +1,37 @@
 from __future__ import annotations
 
+import re
 import json
+from typing import Any, Dict, List, Union, Literal
+from pathlib import Path
 from datetime import datetime, timezone
 from textwrap import wrap
-from typing import Any, Literal
 
 import click
-from click.core import ParameterSource  # type: ignore[attr-defined]
 from rich import print as rprint
-from rich.json import JSON
 from tabulate import tabulate
+from click.core import ParameterSource  # type: ignore[attr-defined]
 
 from together import Together
-from together.cli.api.utils import BOOL_WITH_AUTO, INT_WITH_MAX, generate_progress_bar
-from together.types.finetune import DownloadCheckpointType, FinetuneTrainingLimits
-from together.utils import (
-    finetune_price_to_dollars,
-    format_timestamp,
-    log_warn,
-    parse_timestamp,
-)
-
+from together._types import NOT_GIVEN, NotGiven
+from together.lib.utils import log_warn
+from together.lib.utils.tools import format_timestamp, finetune_price_to_dollars
+from together.lib.cli.api.utils import INT_WITH_MAX, BOOL_WITH_AUTO
+from together.lib.resources.files import DownloadManager
+from together.lib.utils.serializer import datetime_serializer
+from together.types.finetune_response import TrainingTypeFullTrainingType, TrainingTypeLoRaTrainingType
+from together.lib.resources.fine_tuning import get_model_limits
 
 _CONFIRMATION_MESSAGE = (
     "You are about to create a fine-tuning job. "
-    "The estimated price of this job is {price}. "
-    "The actual cost of your job will be determined by the model size, the number of tokens "
+    "The cost of your job will be determined by the model size, the number of tokens "
     "in the training file, the number of tokens in the validation file, the number of epochs, and "
-    "the number of evaluations. Visit https://www.together.ai/pricing to learn more about fine-tuning pricing.\n"
-    "{warning}"
+    "the number of evaluations. Visit https://www.together.ai/pricing to get a price estimate.\n"
     "You can pass `-y` or `--confirm` to your command to skip this message.\n\n"
     "Do you want to proceed?"
 )
 
-_WARNING_MESSAGE_INSUFFICIENT_FUNDS = (
-    "The estimated price of this job is significantly greater than your current credit limit and balance combined. "
-    "It will likely get cancelled due to insufficient funds. "
-    "Consider increasing your credit limit at https://api.together.xyz/settings/profile\n"
-)
-
-
-class DownloadCheckpointTypeChoice(click.Choice):
-    def __init__(self) -> None:
-        super().__init__([ct.value for ct in DownloadCheckpointType])
-
-    def convert(
-        self, value: str, param: click.Parameter | None, ctx: click.Context | None
-    ) -> DownloadCheckpointType:
-        value = super().convert(value, param, ctx)
-        return DownloadCheckpointType(value)
+_FT_JOB_WITH_STEP_REGEX = r"^ft-[\dabcdef-]+:\d+$"
 
 
 @click.group(name="fine-tuning")
@@ -68,19 +51,11 @@ def fine_tuning(ctx: click.Context) -> None:
     help="Training file ID from Files API",
 )
 @click.option("--model", "-m", type=str, help="Base model name")
-@click.option(
-    "--n-epochs", "-ne", type=int, default=1, help="Number of epochs to train for"
-)
-@click.option(
-    "--validation-file", type=str, default="", help="Validation file ID from Files API"
-)
+@click.option("--n-epochs", "-ne", type=int, default=1, help="Number of epochs to train for")
+@click.option("--validation-file", type=str, default="", help="Validation file ID from Files API")
 @click.option("--n-evals", type=int, default=0, help="Number of evaluation loops")
-@click.option(
-    "--n-checkpoints", "-c", type=int, default=1, help="Number of checkpoints to save"
-)
-@click.option(
-    "--batch-size", "-b", type=INT_WITH_MAX, default="max", help="Train batch size"
-)
+@click.option("--n-checkpoints", "-c", type=int, default=1, help="Number of checkpoints to save")
+@click.option("--batch-size", "-b", type=INT_WITH_MAX, default="max", help="Train batch size")
 @click.option("--learning-rate", "-lr", type=float, default=1e-5, help="Learning rate")
 @click.option(
     "--lr-scheduler-type",
@@ -149,18 +124,14 @@ def fine_tuning(ctx: click.Context) -> None:
     "--dpo-normalize-logratios-by-length",
     type=bool,
     default=False,
-    help=(
-        "Whether to normalize logratios by sample length "
-        "(only used when '--training-method' is 'dpo')"
-    ),
+    help=("Whether to normalize logratios by sample length (only used when '--training-method' is 'dpo')"),
 )
 @click.option(
     "--rpo-alpha",
     type=float,
     default=None,
     help=(
-        "RPO alpha parameter of DPO training to include NLL in the loss "
-        "(only used when '--training-method' is 'dpo')"
+        "RPO alpha parameter of DPO training to include NLL in the loss (only used when '--training-method' is 'dpo')"
     ),
 )
 @click.option(
@@ -195,12 +166,6 @@ def fine_tuning(ctx: click.Context) -> None:
     help="Whether to mask the user messages in conversational data or prompts in instruction data. "
     "`auto` will automatically determine whether to mask the inputs based on the data format.",
 )
-@click.option(
-    "--train-vision",
-    type=bool,
-    default=False,
-    help="Whether to train the vision encoder. Only supported for multimodal models.",
-)
 @click.option(
     "--from-checkpoint",
     type=str,
@@ -239,7 +204,7 @@ def create(
     ctx: click.Context,
     training_file: str,
     validation_file: str,
-    model: str,
+    model: str | None,
     n_epochs: int,
     n_evals: int,
     n_checkpoints: int,
@@ -251,27 +216,26 @@ def create(
     warmup_ratio: float,
     max_grad_norm: float,
     weight_decay: float,
-    lora: bool,
-    lora_r: int,
-    lora_dropout: float,
-    lora_alpha: float,
-    lora_trainable_modules: str,
-    train_vision: bool,
-    suffix: str,
-    wandb_api_key: str,
-    wandb_base_url: str,
-    wandb_project_name: str,
-    wandb_name: str,
-    confirm: bool,
-    train_on_inputs: bool | Literal["auto"],
-    training_method: str,
+    lora: bool | None,
+    lora_r: int | None,
+    lora_dropout: float | None,
+    lora_alpha: float | None,
+    lora_trainable_modules: str | None,
+    suffix: str | None,
+    wandb_api_key: str | None,
+    wandb_base_url: str | None,
+    wandb_project_name: str | None,
+    wandb_name: str | None,
+    confirm: bool | None,
+    train_on_inputs: bool | Literal["auto"] | None,
+    training_method: str | None,
     dpo_beta: float | None,
-    dpo_normalize_logratios_by_length: bool,
+    dpo_normalize_logratios_by_length: bool | None,
     rpo_alpha: float | None,
     simpo_gamma: float | None,
-    from_checkpoint: str,
-    from_hf_model: str,
-    hf_model_revision: str,
+    from_checkpoint: str | None,
+    from_hf_model: str | None,
+    hf_model_revision: str | None,
     hf_api_token: str | None,
     hf_output_repo_name: str | None,
 ) -> None:
@@ -298,7 +262,6 @@ def create(
         lora_dropout=lora_dropout,
         lora_alpha=lora_alpha,
         lora_trainable_modules=lora_trainable_modules,
-        train_vision=train_vision,
         suffix=suffix,
         wandb_api_key=wandb_api_key,
         wandb_base_url=wandb_base_url,
@@ -324,15 +287,11 @@ def create(
     if from_checkpoint is not None:
         model_name = from_checkpoint.split(":")[0]
 
-    model_limits: FinetuneTrainingLimits = client.fine_tuning.get_model_limits(
-        model=model_name,
-    )
+    model_limits = get_model_limits(client, str(model_name))
 
     if lora:
         if model_limits.lora_training is None:
-            raise click.BadParameter(
-                f"LoRA fine-tuning is not supported for the model `{model}`"
-            )
+            raise click.BadParameter(f"LoRA fine-tuning is not supported for the model `{model}`")
         default_values = {
             "lora_r": model_limits.lora_training.max_rank,
             "learning_rate": 1e-3,
@@ -341,15 +300,13 @@ def create(
         for arg in default_values:
             arg_source = ctx.get_parameter_source("arg")  # type: ignore[attr-defined]
             if arg_source == ParameterSource.DEFAULT:
-                training_args[arg] = default_values[arg_source]
+                training_args[arg] = default_values[str(arg_source)]
 
         if ctx.get_parameter_source("lora_alpha") == ParameterSource.DEFAULT:  # type: ignore[attr-defined]
             training_args["lora_alpha"] = training_args["lora_r"] * 2
     else:
         if model_limits.full_training is None:
-            raise click.BadParameter(
-                f"Full fine-tuning is not supported for the model `{model}`"
-            )
+            raise click.BadParameter(f"Full fine-tuning is not supported for the model `{model}`")
 
         for param in ["lora_r", "lora_dropout", "lora_alpha", "lora_trainable_modules"]:
             param_source = ctx.get_parameter_source(param)  # type: ignore[attr-defined]
@@ -364,52 +321,18 @@ def create(
             "Warning: You have specified a validation file but the number of evaluation loops is set to 0. No evaluations will be performed."
         )
     elif n_evals > 0 and not validation_file:
-        raise click.BadParameter(
-            "You have specified a number of evaluation loops but no validation file."
-        )
+        raise click.BadParameter("You have specified a number of evaluation loops but no validation file.")
 
-    if model_limits.supports_vision:
-        # Don't show price estimation for multimodal models yet
-        confirm = True
-
-    finetune_price_estimation_result = client.fine_tuning.estimate_price(
-        training_file=training_file,
-        validation_file=validation_file,
-        model=model,
-        n_epochs=n_epochs,
-        n_evals=n_evals,
-        training_type="lora" if lora else "full",
-        training_method=training_method,
-    )
-
-    price = click.style(
-        f"${finetune_price_estimation_result.estimated_total_price:.2f}",
-        bold=True,
-    )
-
-    if not finetune_price_estimation_result.allowed_to_proceed:
-        warning = click.style(_WARNING_MESSAGE_INSUFFICIENT_FUNDS, fg="red", bold=True)
-    else:
-        warning = ""
-
-    confirmation_message = _CONFIRMATION_MESSAGE.format(
-        price=price,
-        warning=warning,
-    )
-
-    if confirm or click.confirm(confirmation_message, default=True, show_default=True):
+    if confirm or click.confirm(_CONFIRMATION_MESSAGE, default=True, show_default=True):
         response = client.fine_tuning.create(
             **training_args,
             verbose=True,
         )
+
         report_string = f"Successfully submitted a fine-tuning job {response.id}"
-        if response.created_at is not None:
-            created_time = datetime.strptime(
-                response.created_at, "%Y-%m-%dT%H:%M:%S.%f%z"
-            )
-            # created_at reports UTC time, we use .astimezone() to convert to local time
-            formatted_time = created_time.astimezone().strftime("%m/%d/%Y, %H:%M:%S")
-            report_string += f" at {formatted_time}"
+        # created_at reports UTC time, we use .astimezone() to convert to local time
+        formatted_time = response.created_at.astimezone().strftime("%m/%d/%Y, %H:%M:%S")
+        report_string += f" at {formatted_time}"
         rprint(report_string)
     else:
         click.echo("No confirmation received, stopping job launch")
@@ -427,22 +350,19 @@ def list(ctx: click.Context) -> None:
 
     # Use a default datetime for None values to make sure the key function always returns a comparable value
     epoch_start = datetime.fromtimestamp(0, tz=timezone.utc)
-    response.data.sort(key=lambda x: parse_timestamp(x.created_at or "") or epoch_start)
+    response.data.sort(key=lambda x: x.created_at or epoch_start)
 
-    display_list = []
+    display_list: List[Dict[str, Any]] = []
     for i in response.data:
         display_list.append(
             {
                 "Fine-tune ID": i.id,
-                "Model Output Name": "\n".join(wrap(i.output_name or "", width=30)),
+                "Model Output Name": "\n".join(wrap(i.x_model_output_name or "", width=30)),
                 "Status": i.status,
                 "Created At": i.created_at,
                 "Price": f"""${
                     finetune_price_to_dollars(float(str(i.total_price)))
                 }""",  # convert to string for mypy typing
-                "Progress": generate_progress_bar(
-                    i, datetime.now().astimezone(), use_rich=False
-                ),
             }
         )
     table = tabulate(display_list, headers="keys", tablefmt="grid", showindex=True)
@@ -462,23 +382,13 @@ def retrieve(ctx: click.Context, fine_tune_id: str) -> None:
     # remove events from response for cleaner output
     response.events = None
 
-    rprint(JSON.from_data(response.model_dump(exclude_none=True)))
-    progress_text = generate_progress_bar(
-        response, datetime.now().astimezone(), use_rich=True
-    )
-    status = "Unknown"
-    if response.status is not None:
-        status = response.status.value
-    prefix = f"Status: [bold]{status}[/bold],"
-    rprint(f"{prefix} {progress_text}")
+    click.echo(json.dumps(response.model_dump(exclude_none=True), indent=4))
 
 
 @fine_tuning.command()
 @click.pass_context
 @click.argument("fine_tune_id", type=str, required=True)
-@click.option(
-    "--quiet", is_flag=True, help="Do not prompt for confirmation before cancelling job"
-)
+@click.option("--quiet", is_flag=True, help="Do not prompt for confirmation before cancelling job")
 def cancel(ctx: click.Context, fine_tune_id: str, quiet: bool = False) -> None:
     """Cancel fine-tuning job"""
     client: Together = ctx.obj
@@ -492,7 +402,7 @@ def cancel(ctx: click.Context, fine_tune_id: str, quiet: bool = False) -> None:
             return
     response = client.fine_tuning.cancel(fine_tune_id)
 
-    click.echo(json.dumps(response.model_dump(exclude_none=True), indent=4))
+    click.echo(json.dumps(response.model_dump(exclude_none=True), indent=4, default=datetime_serializer))
 
 
 @fine_tuning.command()
@@ -506,13 +416,13 @@ def list_events(ctx: click.Context, fine_tune_id: str) -> None:
 
     response.data = response.data or []
 
-    display_list = []
+    display_list: List[Dict[str, Any]] = []
     for i in response.data:
         display_list.append(
             {
                 "Message": "\n".join(wrap(i.message or "", width=50)),
                 "Type": i.type,
-                "Created At": parse_timestamp(i.created_at or ""),
+                "Created At": i.created_at,
                 "Hash": i.hash,
             }
         )
@@ -530,13 +440,18 @@ def list_checkpoints(ctx: click.Context, fine_tune_id: str) -> None:
 
     checkpoints = client.fine_tuning.list_checkpoints(fine_tune_id)
 
-    display_list = []
-    for checkpoint in checkpoints:
+    display_list: List[Dict[str, Any]] = []
+    for checkpoint in checkpoints.data:
+        name = (
+            f"{fine_tune_id}:{checkpoint.step}"
+            if "intermediate" in checkpoint.checkpoint_type.lower()
+            else fine_tune_id
+        )
         display_list.append(
             {
-                "Type": checkpoint.type,
-                "Timestamp": format_timestamp(checkpoint.timestamp),
-                "Name": checkpoint.name,
+                "Type": checkpoint.checkpoint_type,
+                "Timestamp": format_timestamp(checkpoint.created_at),
+                "Name": name,
             }
         )
 
@@ -549,7 +464,7 @@ def list_checkpoints(ctx: click.Context, fine_tune_id: str) -> None:
         click.echo(f"No checkpoints found for job {fine_tune_id}")
 
 
-@fine_tuning.command()
+@fine_tuning.command(name="download")
 @click.pass_context
 @click.argument("fine_tune_id", type=str, required=True)
 @click.option(
@@ -570,48 +485,77 @@ def list_checkpoints(ctx: click.Context, fine_tune_id: str) -> None:
 )
 @click.option(
     "--checkpoint-type",
-    type=DownloadCheckpointTypeChoice(),
+    type=click.Choice(["merged", "adapter", "default"]),
     required=False,
-    default=DownloadCheckpointType.DEFAULT.value,
+    default="merged",
     help="Specifies checkpoint type. 'merged' and 'adapter' options work only for LoRA jobs.",
 )
 def download(
     ctx: click.Context,
     fine_tune_id: str,
-    output_dir: str,
-    checkpoint_step: int | None,
-    checkpoint_type: DownloadCheckpointType,
+    output_dir: str | None = None,
+    checkpoint_step: Union[int, NotGiven] = NOT_GIVEN,
+    checkpoint_type: Literal["default", "merged", "adapter"] | NotGiven = NOT_GIVEN,
 ) -> None:
     """Download fine-tuning checkpoint"""
     client: Together = ctx.obj
 
-    response = client.fine_tuning.download(
-        fine_tune_id,
-        output=output_dir,
-        checkpoint_step=checkpoint_step,
-        checkpoint_type=checkpoint_type,
+    if re.match(_FT_JOB_WITH_STEP_REGEX, fine_tune_id) is not None:
+        if checkpoint_step is NOT_GIVEN:
+            checkpoint_step = int(fine_tune_id.split(":")[1])
+            fine_tune_id = fine_tune_id.split(":")[0]
+        else:
+            raise ValueError(
+                "Fine-tuning job ID {fine_tune_id} contains a colon to specify the step to download, but `checkpoint_step` "
+                "was also set. Remove one of the step specifiers to proceed."
+            )
+
+    ft_job = client.fine_tuning.retrieve(fine_tune_id)
+
+    loosely_typed_checkpoint_type: str | NotGiven = checkpoint_type
+    if isinstance(ft_job.training_type, TrainingTypeFullTrainingType):
+        if checkpoint_type != "default":
+            raise ValueError("Only DEFAULT checkpoint type is allowed for FullTrainingType")
+        loosely_typed_checkpoint_type = "model_output_path"
+    elif isinstance(ft_job.training_type, TrainingTypeLoRaTrainingType):
+        if checkpoint_type == "default":
+            loosely_typed_checkpoint_type = "merged"
+
+        if checkpoint_type not in {
+            "merged",
+            "adapter",
+        }:
+            raise ValueError(f"Invalid checkpoint type for LoRATrainingType: {checkpoint_type}")
+
+    remote_name = ft_job.x_model_output_name
+
+    url = f"/finetune/download?ft_id={fine_tune_id}&checkpoint={loosely_typed_checkpoint_type}"
+    output: Path | None = None
+    if isinstance(output_dir, str):
+        output = Path(output_dir)
+
+    file_path, file_size = DownloadManager(client).download(
+        url=url,
+        output=output,
+        remote_name=remote_name,
+        fetch_metadata=True,
     )
 
-    click.echo(json.dumps(response.model_dump(exclude_none=True), indent=4))
+    click.echo(json.dumps({"object": "local", "id": fine_tune_id, "filename": file_path, "size": file_size}, indent=4))
 
 
 @fine_tuning.command()
 @click.pass_context
 @click.argument("fine_tune_id", type=str, required=True)
 @click.option("--force", is_flag=True, help="Force deletion without confirmation")
-@click.option(
-    "--quiet", is_flag=True, help="Do not prompt for confirmation before deleting job"
-)
-def delete(
-    ctx: click.Context, fine_tune_id: str, force: bool = False, quiet: bool = False
-) -> None:
+@click.option("--quiet", is_flag=True, help="Do not prompt for confirmation before deleting job")
+def delete(ctx: click.Context, fine_tune_id: str, force: bool = False, quiet: bool = False) -> None:
     """Delete fine-tuning job"""
     client: Together = ctx.obj
 
     if not quiet:
         confirm_response = input(
-            f"Are you sure you want to delete fine-tuning job {fine_tune_id}? "
-            "This action cannot be undone. [y/N] "
+            f"Are you sure you want to delete fine-tuning job {fine_tune_id}? This action cannot be undone. [y/N] "
         )
         if confirm_response.lower() != "y":
             click.echo("Deletion cancelled")