together 2.0.0a15__py3-none-any.whl → 2.0.0a17__py3-none-any.whl

together/lib/cli/api/{evals.py → evals/create.py}

@@ -1,14 +1,10 @@
-import sys
 import json
-from typing import Any, Dict, List, Union, Literal, TypeVar, Callable, Optional, cast
-from functools import wraps
+from typing import Any, Dict, Union, Literal, Optional, cast
 
 import click
-from tabulate import tabulate
 
-from together import APIError, Together, TogetherError
-from together._types import omit
-from together.lib.utils.serializer import datetime_serializer
+from together import Together, TogetherError
+from together.lib.cli.api._utils import handle_api_errors
 from together.types.eval_create_params import (
     ParametersEvaluationScoreParameters,
     ParametersEvaluationCompareParameters,
@@ -23,51 +19,7 @@ from together.types.eval_create_params import (
 )
 
 
-def print_api_error(e: Union[APIError, TogetherError]) -> None:
-    if isinstance(e, APIError):
-        error_details = cast(Dict[str, Any], e.body)["error"]["message"]
-
-        if error_details and ("credentials" in error_details.lower() or "authentication" in error_details.lower()):
-            click.echo("Error: Invalid API key or authentication failed", err=True)
-        else:
-            click.echo(f"Error: {error_details}", err=True)
-
-    click.echo(f"Error: {e}", err=True)
-    return
-
-
-F = TypeVar("F", bound=Callable[..., Any])
-
-
-def handle_api_errors(f: F) -> F:
-    """Decorator to handle common API errors in CLI commands."""
-
-    @wraps(f)
-    def wrapper(*args: Any, **kwargs: Any) -> Any:
-        try:
-            return f(*args, **kwargs)
-        except APIError as e:
-            print_api_error(e)
-            sys.exit(1)
-        except TogetherError as e:
-            print_api_error(e)
-            sys.exit(1)
-        except Exception as e:
-            click.echo(f"Error: An unexpected error occurred - {str(e)}", err=True)
-            sys.exit(1)
-
-    return wrapper  # type: ignore
-
-
-@click.group()
-@click.pass_context
-def evals(ctx: click.Context) -> None:
-    """Evals API commands"""
-    pass
-
-
-@evals.command()
-@click.pass_context
+@click.command()
 @click.option(
     "--type",
     type=click.Choice(["classify", "score", "compare"]),
@@ -273,7 +225,8 @@ def evals(ctx: click.Context) -> None:
     type=str,
     help="Input template for model B.",
 )
-@handle_api_errors
+@click.pass_context
+@handle_api_errors("Evals")
 def create(
     ctx: click.Context,
     type: Literal["classify", "score", "compare"],
@@ -477,82 +430,6 @@ def create(
     click.echo(json.dumps(response.model_dump(exclude_none=True), indent=4))
 
 
-@evals.command()
-@click.pass_context
-@click.option(
-    "--status",
-    type=click.Choice(["pending", "queued", "running", "completed", "error", "user_error"]),
-    help="Filter by job status.",
-)
-@click.option(
-    "--limit",
-    type=int,
-    help="Limit number of results (max 100).",
-)
-def list(
-    ctx: click.Context,
-    status: Union[Literal["pending", "queued", "running", "completed", "error", "user_error"], None],
-    limit: Union[int, None],
-) -> None:
-    """List evals"""
-
-    client: Together = ctx.obj
-
-    response = client.evals.list(status=status or omit, limit=limit or omit)
-
-    display_list: List[Dict[str, Any]] = []
-    for job in response:
-        if job.parameters:
-            model = job.parameters.get("model_to_evaluate", "")
-            model_a = job.parameters.get("model_a", "")
-            model_b = job.parameters.get("model_b", "")
-        else:
-            model = ""
-            model_a = ""
-            model_b = ""
-
-        display_list.append(
-            {
-                "Workflow ID": job.workflow_id or "",
-                "Type": job.type,
-                "Status": job.status,
-                "Created At": job.created_at or 0,
-                "Model": model,
-                "Model A": model_a,
-                "Model B": model_b,
-            }
-        )
-
-    table = tabulate(display_list, headers="keys", tablefmt="grid", showindex=True)
-    click.echo(table)
-
-
-@evals.command()
-@click.pass_context
-@click.argument("evaluation_id", type=str, required=True)
-def retrieve(ctx: click.Context, evaluation_id: str) -> None:
-    """Get details of a specific evaluation job"""
-
-    client: Together = ctx.obj
-
-    response = client.evals.retrieve(evaluation_id)
-
-    click.echo(json.dumps(response.model_dump(exclude_none=True), default=datetime_serializer, indent=4))
-
-
-@evals.command()
-@click.pass_context
-@click.argument("evaluation_id", type=str, required=True)
-def status(ctx: click.Context, evaluation_id: str) -> None:
-    """Get the status and results of a specific evaluation job"""
-
-    client: Together = ctx.obj
-
-    response = client.evals.status(evaluation_id)
-
-    click.echo(json.dumps(response.model_dump(exclude_none=True), indent=4))
-
-
 def _build_judge(
     type: Literal["classify", "score", "compare"],
     judge_model: str,

together/lib/cli/api/evals/list.py

@@ -0,0 +1,58 @@
+from typing import Any, Dict, List, Union, Literal
+
+import click
+from tabulate import tabulate
+
+from together import Together, omit
+from together.lib.cli.api._utils import handle_api_errors
+
+
+@click.command()
+@click.option(
+    "--status",
+    type=click.Choice(["pending", "queued", "running", "completed", "error", "user_error"]),
+    help="Filter by job status.",
+)
+@click.option(
+    "--limit",
+    type=int,
+    help="Limit number of results (max 100).",
+)
+@click.pass_context
+@handle_api_errors("Evals")
+def list(
+    ctx: click.Context,
+    status: Union[Literal["pending", "queued", "running", "completed", "error", "user_error"], None],
+    limit: Union[int, None],
+) -> None:
+    """List evals"""
+
+    client: Together = ctx.obj
+
+    response = client.evals.list(status=status or omit, limit=limit or omit)
+
+    display_list: List[Dict[str, Any]] = []
+    for job in response:
+        if job.parameters:
+            model = job.parameters.get("model_to_evaluate", "")
+            model_a = job.parameters.get("model_a", "")
+            model_b = job.parameters.get("model_b", "")
+        else:
+            model = ""
+            model_a = ""
+            model_b = ""
+
+        display_list.append(
+            {
+                "Workflow ID": job.workflow_id or "",
+                "Type": job.type,
+                "Status": job.status,
+                "Created At": job.created_at or 0,
+                "Model": model,
+                "Model A": model_a,
+                "Model B": model_b,
+            }
+        )
+
+    table = tabulate(display_list, headers="keys", tablefmt="grid", showindex=True)
+    click.echo(table)

together/lib/cli/api/evals/retrieve.py

@@ -0,0 +1,21 @@
+import json
+
+import click
+
+from together import Together
+from together.lib.cli.api._utils import handle_api_errors
+from together.lib.utils.serializer import datetime_serializer
+
+
+@click.command()
+@click.pass_context
+@click.argument("evaluation_id", type=str, required=True)
+@handle_api_errors("Evals")
+def retrieve(ctx: click.Context, evaluation_id: str) -> None:
+    """Get details of a specific evaluation job"""
+
+    client: Together = ctx.obj
+
+    response = client.evals.retrieve(evaluation_id)
+
+    click.echo(json.dumps(response.model_dump(exclude_none=True), default=datetime_serializer, indent=4))

together/lib/cli/api/evals/status.py

@@ -0,0 +1,20 @@
+import json
+
+import click
+
+from together import Together
+from together.lib.cli.api._utils import handle_api_errors
+
+
+@click.command()
+@click.pass_context
+@click.argument("evaluation_id", type=str, required=True)
+@handle_api_errors("Evals")
+def status(ctx: click.Context, evaluation_id: str) -> None:
+    """Get the status and results of a specific evaluation job"""
+
+    client: Together = ctx.obj
+
+    response = client.evals.status(evaluation_id)
+
+    click.echo(json.dumps(response.model_dump(exclude_none=True), indent=4))

together/lib/cli/api/files/__init__.py

@@ -0,0 +1,23 @@
+import click
+
+from .list import list
+from .check import check
+from .delete import delete
+from .upload import upload
+from .retrieve import retrieve
+from .retrieve_content import retrieve_content
+
+
+@click.group()
+@click.pass_context
+def files(ctx: click.Context) -> None:
+    """File API commands"""
+    pass
+
+
+files.add_command(upload)
+files.add_command(list)
+files.add_command(retrieve)
+files.add_command(retrieve_content)
+files.add_command(delete)
+files.add_command(check)

together/lib/cli/api/files/check.py

@@ -0,0 +1,21 @@
+import json
+import pathlib
+
+import click
+
+from together.lib.utils import check_file
+
+
+@click.command()
+@click.pass_context
+@click.argument(
+    "file",
+    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:
+    """Check file for issues"""
+
+    report = check_file(file)
+
+    click.echo(json.dumps(report, indent=4))

together/lib/cli/api/files/delete.py

@@ -0,0 +1,20 @@
+import json
+
+import click
+
+from together import Together
+from together.lib.cli.api._utils import handle_api_errors
+
+
+@click.command()
+@click.pass_context
+@click.argument("id", type=str, required=True)
+@handle_api_errors("Files")
+def delete(ctx: click.Context, id: str) -> None:
+    """Delete remote file"""
+
+    client: Together = ctx.obj
+
+    response = client.files.delete(id=id)
+
+    click.echo(json.dumps(response.model_dump(exclude_none=True), indent=4))

together/lib/cli/api/files/list.py

@@ -0,0 +1,34 @@
+from typing import Any, Dict, List
+from textwrap import wrap
+
+import click
+from tabulate import tabulate
+
+from together import Together
+from together.lib.utils import convert_bytes, convert_unix_timestamp
+from together.lib.cli.api._utils import handle_api_errors
+
+
+@click.command()
+@click.pass_context
+@handle_api_errors("Files")
+def list(ctx: click.Context) -> None:
+    """List files"""
+    client: Together = ctx.obj
+
+    response = client.files.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
+                "Created At": convert_unix_timestamp(i.created_at or 0),
+                "Line Count": i.line_count,
+            }
+        )
+    table = tabulate(display_list, headers="keys", tablefmt="grid", showindex=True)
+
+    click.echo(table)

together/lib/cli/api/files/retrieve.py

@@ -0,0 +1,20 @@
+import json
+
+import click
+
+from together import Together
+from together.lib.cli.api._utils import handle_api_errors
+
+
+@click.command()
+@click.pass_context
+@click.argument("id", type=str, required=True)
+@handle_api_errors("Files")
+def retrieve(ctx: click.Context, id: str) -> None:
+    """Upload file"""
+
+    client: Together = ctx.obj
+
+    response = client.files.retrieve(id=id)
+
+    click.echo(json.dumps(response.model_dump(exclude_none=True), indent=4))

together/lib/cli/api/files/retrieve_content.py

@@ -0,0 +1,25 @@
+import click
+
+from together import Together
+from together.lib.cli.api._utils import handle_api_errors
+
+
+@click.command()
+@click.pass_context
+@click.argument("id", type=str, required=True)
+@click.option("--output", type=str, default=None, help="Output filename")
+@handle_api_errors("Files")
+def retrieve_content(ctx: click.Context, id: str, output: str) -> None:
+    """Retrieve file content and output to file"""
+
+    client: Together = ctx.obj
+
+    response = client.files.content(id=id)
+
+    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"))

together/lib/cli/api/files/upload.py

@@ -0,0 +1,38 @@
+import json
+import pathlib
+from typing import get_args
+
+import click
+
+from together import Together
+from together.types import FilePurpose
+from together.lib.cli.api._utils import handle_api_errors
+
+
+@click.command()
+@click.pass_context
+@click.argument(
+    "file",
+    type=click.Path(exists=True, file_okay=True, resolve_path=True, readable=True, dir_okay=False),
+    required=True,
+)
+@click.option(
+    "--purpose",
+    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(
+    "--check/--no-check",
+    default=True,
+    help="Whether to check the file before uploading.",
+)
+@handle_api_errors("Files")
+def upload(ctx: click.Context, file: pathlib.Path, purpose: FilePurpose, check: bool) -> None:
+    """Upload file"""
+
+    client: Together = ctx.obj
+
+    response = client.files.upload(file=file, purpose=purpose, check=check)
+
+    click.echo(json.dumps(response.model_dump(exclude_none=True), indent=4))

together/lib/cli/api/fine_tuning/__init__.py

@@ -0,0 +1,27 @@
+import click
+
+from .list import list
+from .cancel import cancel
+from .create import create
+from .delete import delete
+from .download import download
+from .retrieve import retrieve
+from .list_events import list_events
+from .list_checkpoints import list_checkpoints
+
+
+@click.group(name="fine-tuning")
+@click.pass_context
+def fine_tuning(ctx: click.Context) -> None:
+    """Fine-tunes API commands"""
+    pass
+
+
+fine_tuning.add_command(create)
+fine_tuning.add_command(list)
+fine_tuning.add_command(retrieve)
+fine_tuning.add_command(cancel)
+fine_tuning.add_command(list_events)
+fine_tuning.add_command(list_checkpoints)
+fine_tuning.add_command(download)
+fine_tuning.add_command(delete)

together/lib/cli/api/fine_tuning/cancel.py

@@ -0,0 +1,28 @@
+import json
+
+import click
+
+from together import Together
+from together.lib.cli.api._utils import handle_api_errors
+from together.lib.utils.serializer import datetime_serializer
+
+
+@click.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")
+@handle_api_errors("Fine-tuning")
+def cancel(ctx: click.Context, fine_tune_id: str, quiet: bool = False) -> None:
+    """Cancel fine-tuning job"""
+    client: Together = ctx.obj
+    if not quiet:
+        confirm_response = input(
+            "You will be billed for any completed training steps upon cancellation. "
+            f"Do you want to cancel job {fine_tune_id}? [y/N]"
+        )
+        if "y" not in confirm_response.lower():
+            click.echo({"status": "Cancel not submitted"})
+            return
+    response = client.fine_tuning.cancel(fine_tune_id)
+
+    click.echo(json.dumps(response.model_dump(exclude_none=True), indent=4, default=datetime_serializer))