anyscale 0.24.86__py3-none-any.whl

anyscale/commands/list_commands.py

@@ -0,0 +1,85 @@
+"""
+Defines and implements `anyscale list {resource}` commands.
+Supported resources: clouds, projects, sessions, ips
+"""
+
+from typing import Any, Optional
+
+import click
+
+from anyscale.cli_logger import BlockLogger
+from anyscale.controllers.list_controller import ListController
+
+
+log = BlockLogger()
+
+
+@click.group(
+    "list", hidden=True, help="List resources (projects, clusters) within Anyscale."
+)
+def list_cli() -> None:
+    pass
+
+
+@list_cli.command(
+    name="clouds",
+    help="[DEPRECATED] List the clouds currently available in your account.",
+    hidden=True,
+)
+@click.option("--json", "show_json", help="Return the results in json", is_flag=True)
+def list_clouds(show_json: bool) -> None:
+    log.warning(
+        "`anyscale list clouds` has been deprecated. Please use `anyscale cloud list` instead."
+    )
+    list_controller = ListController()
+    output = list_controller.list_clouds(json_format=show_json)
+    print(output)
+
+
+@list_cli.command(
+    name="projects", help="[DEPRECATED] List all accessible projects.", hidden=True
+)
+@click.option("--json", "show_json", help="Return the results in json", is_flag=True)
+@click.pass_context
+def project_list(ctx: Any, show_json: bool) -> None:  # noqa: ARG001
+    log.warning(
+        "`anyscale list projects` has been deprecated. Please use `anyscale project list` instead."
+    )
+    list_controller = ListController()
+    output = list_controller.list_projects(json_format=show_json)
+    print(output)
+
+
+@list_cli.command(
+    name="sessions",
+    help="[DEPRECATED] List all clusters within the current project.",
+    hidden=True,
+)
+@click.option(
+    "--name",
+    help="Name of the cluster. If provided, this prints the snapshots that "
+    "were applied and commands that ran for all clusters that match "
+    "this name.",
+    default=None,
+)
+@click.option("--all", help="List all clusters, including inactive ones.", is_flag=True)
+@click.option("--json", "show_json", help="Return the results in json", is_flag=True)
+def session_list(name: Optional[str], all: bool, show_json: bool) -> None:  # noqa: A002
+    log.warning(
+        "`anyscale list sessions` has been deprecated. Please use `anyscale cluster list` instead."
+    )
+    list_controller = ListController()
+    output = list_controller.list_sessions(
+        name=name, show_all=all, json_format=show_json
+    )
+    print(output)
+
+
+@list_cli.command(
+    name="ips",
+    help="[DEPRECATED] List IP addresses of head and worker nodes.",
+    context_settings={"ignore_unknown_options": True, "allow_extra_args": True,},
+)
+def list_ips() -> None:
+    """List IP addresses of head and worker nodes."""
+    raise click.ClickException("Listing IPs is not supported on Anyscale V2")

anyscale/commands/llm/dataset_commands.py

@@ -0,0 +1,269 @@
+import os
+from typing import Optional
+
+import click
+from dateutil import tz
+from rich import print as rprint
+import tabulate
+
+import anyscale
+from anyscale.commands import command_examples
+from anyscale.commands.util import AnyscaleCommand
+
+
+@click.group("dataset", help="Dataset files stored on your Anyscale cloud.")
+def dataset_cli():
+    pass
+
+
+@dataset_cli.command(
+    name="get",
+    short_help="Retrieves metadata about a dataset.",
+    cls=AnyscaleCommand,
+    is_alpha=True,
+    example=command_examples.LLM_DATASET_GET_EXAMPLE,
+)
+@click.argument(
+    "name", required=True,
+)
+@click.option(
+    "--version",
+    "-v",
+    required=False,
+    type=int,
+    help="Version of the dataset. "
+    "If a negative integer is provided, the dataset returned is this many versions back of the latest version. "
+    "Default: Latest version.",
+)
+@click.option(
+    "--project",
+    required=False,
+    help="Name of the Anyscale project that the dataset belongs to. "
+    "If not provided, all projects will be searched.",
+)
+def get_dataset(
+    name: str, version: Optional[int], project: Optional[str],
+):
+    """
+    Retrieves metadata about a dataset.
+
+    NAME = Name of the dataset
+
+    Example usage:
+
+        anyscale llm dataset get my_first_dataset
+
+    Retrieve the second latest version of the dataset:
+
+        anyscale llm dataset get my_first_dataset -v -1
+    """
+    dataset = anyscale.llm.dataset.get(name, version, project)
+    rprint(dataset)
+
+
+@dataset_cli.command(
+    name="upload",
+    short_help="Upload a dataset to your Anyscale cloud.",
+    cls=AnyscaleCommand,
+    is_alpha=True,
+    example=command_examples.LLM_DATASET_UPLOAD_EXAMPLE,
+)
+@click.argument("dataset_file", required=True)
+@click.option(
+    "--name",
+    "-n",
+    required=True,
+    help="Name of a new dataset, or an existing dataset, to upload a new version of.",
+)
+@click.option(
+    "--description", required=False, help="Description of the dataset version.",
+)
+@click.option(
+    "--cloud",
+    required=False,
+    help="Name of the Anyscale cloud to upload a new dataset to. "
+    "If not provided, the default cloud will be used.",
+)
+@click.option(
+    "--project",
+    required=False,
+    help="Name of the Anyscale project to upload a new dataset to. "
+    "If not provided, the default project of the cloud will be used.",
+)
+def upload_dataset(
+    dataset_file: str,
+    name: str,
+    description: Optional[str],
+    cloud: Optional[str],
+    project: Optional[str],
+):
+    """
+    Uploads a dataset, or a new version of a dataset, to your Anyscale cloud.
+
+    DATASET_FILE = Path to the dataset file to upload
+
+    Example usage:
+
+        anyscale llm dataset upload path/to/my_dataset.jsonl -n my_first_dataset
+
+        anyscale llm dataset upload my_dataset.jsonl -n second_dataset.jsonl
+
+        anyscale llm dataset upload my_dataset2.jsonl -n second_dataset.jsonl --description 'added 3 lines'
+
+    \b
+    NOTE:
+    If you are uploading a new version, have run this from within an Anyscale workspace,
+    and neither `--cloud` nor `--project` is provided, the cloud and project of the workspace will be used.
+    """
+    dataset = anyscale.llm.dataset.upload(
+        dataset_file, name, description=description, cloud=cloud, project=project,
+    )
+    rprint(dataset)
+
+
+@dataset_cli.command(
+    name="download",
+    short_help="Download a dataset.",
+    cls=AnyscaleCommand,
+    is_alpha=True,
+    example=command_examples.LLM_DATASET_DOWNLOAD_EXAMPLE,
+)
+@click.argument(
+    "name", required=True,
+)
+@click.option(
+    "--version",
+    "-v",
+    required=False,
+    type=int,
+    help="Version of the dataset to download. "
+    "If a negative integer is provided, the dataset returned is this many versions back of the latest version. "
+    "Default: Latest version.",
+)
+@click.option(
+    "--project",
+    required=False,
+    help="Name of the Anyscale project to download the dataset from. "
+    "If not provided, all projects will be searched.",
+)
+@click.option(
+    "--output",
+    "-o",
+    required=False,
+    help="Path to save the downloaded dataset to."
+    "If not provided, the dataset contents will be printed to the terminal.",
+)
+def download_dataset(
+    name: str, version: Optional[int], project: Optional[str], output: Optional[str],
+):
+    """
+    Downloads a dataset from your Anyscale cloud.
+
+    NAME = Name of the dataset to download
+
+    Prints the dataset contents to the terminal by default.
+
+    Example usage:
+
+        anyscale llm dataset download my_first_dataset.jsonl
+
+    Save the dataset to a file:
+
+        anyscale llm dataset download my_dataset.jsonl -o ~/Downloads/my_dataset.jsonl
+
+    Retrieve the second latest version of the dataset:
+
+        anyscale llm dataset download my_dataset.jsonl -v -1
+    """
+    if output:
+        output = os.path.expanduser(output)
+        if os.path.exists(output):
+            raise click.ClickException(f"File already exists at '{output}'")
+    downloaded_contents = anyscale.llm.dataset.download(name, version, project)
+    if output:
+        # Create the parent directory if it doesn't exist
+        parent_dir = os.path.dirname(output)
+        if parent_dir:
+            os.makedirs(parent_dir, exist_ok=True)
+        with open(output, "wb") as output_file:
+            output_file.write(downloaded_contents)
+        rprint(f"Dataset '{name}' downloaded to '{output}'")
+        return
+    print(downloaded_contents.decode())
+
+
+@dataset_cli.command(
+    name="list",
+    short_help="List datasets.",
+    cls=AnyscaleCommand,
+    is_alpha=True,
+    example=command_examples.LLM_DATASET_LIST_EXAMPLE,
+)
+@click.option(
+    "--limit",
+    "-l",
+    required=False,
+    default=10,
+    type=int,
+    help="Maximum number of datasets to return. Default: 10.",
+)
+@click.option(
+    "--after",
+    required=False,
+    help="ID of the dataset to start the listing from. If provided, the list will start from the dataset after this ID.",
+)
+@click.option(
+    "--name-contains",
+    "-n",
+    required=False,
+    help="Filter datasets by name. If provided, only datasets with name containing this string will be returned.",
+)
+@click.option(
+    "--cloud",
+    required=False,
+    help="Name of the Anyscale cloud to search in. If not provided, all clouds will be searched.",
+)
+@click.option(
+    "--project",
+    required=False,
+    help="Name of the Anyscale project to search in. If not provided, all projects will be searched.",
+)
+def list_datasets(
+    limit: int,
+    after: Optional[str],
+    name_contains: Optional[str],
+    cloud: Optional[str],
+    project: Optional[str],
+):
+    """
+    Lists datasets.
+
+    Example usage:
+
+        anyscale llm dataset list
+
+    List datasets in a specific project:
+
+        anyscale llm dataset list --project my_project
+    """
+    datasets = anyscale.llm.dataset.list(
+        limit=limit,
+        after=after,
+        name_contains=name_contains,
+        cloud=cloud,
+        project=project,
+    )
+    table = tabulate.tabulate(
+        [
+            (
+                d.id,
+                d.name,
+                d.description,
+                d.created_at.astimezone(tz=tz.tzlocal()).strftime("%m/%d/%Y %I:%M %p"),
+                d.num_versions,
+            )
+            for d in datasets
+        ],
+        headers=["ID", "Name", "Description", "Created At", "Num Versions"],
+    )
+    rprint(table)

anyscale/commands/llm/group.py

@@ -0,0 +1,15 @@
+import click
+
+from anyscale.commands.llm.dataset_commands import dataset_cli
+from anyscale.commands.llm.models_commands import models_cli
+
+
+@click.group(
+    "llm", help="Interact with Anyscale's LLM APIs.",
+)
+def llm_cli():
+    pass
+
+
+llm_cli.add_command(dataset_cli)
+llm_cli.add_command(models_cli)

anyscale/commands/llm/models_commands.py

@@ -0,0 +1,123 @@
+from typing import Optional
+
+import click
+
+from anyscale.commands import command_examples
+from anyscale.commands.util import AnyscaleCommand
+from anyscale.controllers.llm.models_controller import ModelsController
+from anyscale.util import validate_non_negative_arg
+
+
+@click.group("model", help="Finetuned models stored on your Anyscale cloud.")
+def models_cli():
+    pass
+
+
+@models_cli.command(
+    name="get",
+    short_help="Retrieves information for a model in your Anyscale cloud.",
+    cls=AnyscaleCommand,
+    is_alpha=True,
+    example=command_examples.LLM_MODELS_GET_EXAMPLE,
+)
+@click.option(
+    "--model-id",
+    required=False,
+    type=str,
+    default=None,
+    help="ID for the model of interest",
+)
+@click.option(
+    "--job-id",
+    required=False,
+    type=str,
+    default=None,
+    help="ID for the Anyscale job corresponding to the fine-tuning run",
+)
+def get_model(model_id: Optional[str], job_id: Optional[str]) -> None:
+    """
+    Gets the model card for the given model ID or corresponding job ID.
+
+    Example usage:
+
+        anyscale llm model get --model-id my-model-id
+
+        anyscale llm model get --job-id job_123
+    """
+    ModelsController().get_model(model_id=model_id, job_id=job_id)
+
+
+@models_cli.command(
+    name="delete",
+    short_help="Delete a fine-tuned model in your Anyscale cloud.",
+    cls=AnyscaleCommand,
+    is_alpha=True,
+    example=command_examples.LLM_MODELS_DELETE_EXAMPLE,
+)
+@click.argument("model_id", required=True)
+def delete_model(model_id: str) -> None:
+    """
+    Deletes the model for the given model ID. Requires owner permission for the corresponding Anyscale project.
+
+    MODEL_ID = ID for the model of interest
+
+    Example usage:
+
+        anyscale llm model delete my-model-id
+    """
+    ModelsController().delete_model(model_id)
+
+
+@models_cli.command(
+    name="list",
+    short_help="Lists fine-tuned models available to the user.",
+    cls=AnyscaleCommand,
+    is_alpha=True,
+    example=command_examples.LLM_MODELS_LIST_EXAMPLE,
+)
+@click.option(
+    "--cloud-id",
+    required=False,
+    type=str,
+    help="Cloud ID to filter by. If not specified, all models from all visible clouds (filtered optionally by `project_id`) are listed.",
+)
+@click.option(
+    "--project-id",
+    required=False,
+    type=str,
+    help="Project ID to filter by. If not specified, all the models from all visible projects (filtered optionally by `cloud_id`) are listed.",
+)
+@click.option(
+    "--max-items",
+    required=False,
+    type=int,
+    default=20,
+    help="Maximum number of items to show in the list. By default, the 20 most recently created models are fetched.",
+    callback=validate_non_negative_arg,
+)
+def list_models(cloud_id: Optional[str], project_id: Optional[str], max_items: int):
+    """
+    Lists fine-tuned models available to the user.
+
+    By default, all models in all visible clouds under all visible projects to the user are listed. This is optionally filtered by `project_id` and/or `cloud_id`.
+
+    Example usage:
+
+        anyscale llm model list
+
+        anyscale llm model list --max-items 50
+
+        anyscale llm model list --cloud-id cld_123
+
+        anyscale llm model list --project-id prj_123
+
+        anyscale llm model list --cloud-id cld_123 --project-id prj_123
+
+
+    NOTE:
+    If you are running this from within an Anyscale workspace, and neither `cloud_id` nor `project_id` are provided, the cloud and project of the workspace will be used.
+    """
+    controller = ModelsController()
+    controller.list_models(
+        cloud_id=cloud_id, project_id=project_id, max_items=max_items
+    )

anyscale/commands/login_commands.py

@@ -0,0 +1,79 @@
+import contextlib
+import os
+import time
+import webbrowser
+
+import click
+
+from anyscale.api import ApiClientWrapperInternal
+from anyscale.cli_logger import BlockLogger
+from anyscale.client import openapi_client
+from anyscale.controllers.auth_controller import AuthController
+from anyscale.shared_anyscale_utils.conf import ANYSCALE_HOST
+
+
+log = BlockLogger()
+
+
+def get_unauthenticated_openapi_client():
+    conf = openapi_client.Configuration(host=ANYSCALE_HOST)
+    conf.proxy = os.environ.get("https_proxy")
+    conf.connection_pool_maxsize = 100
+    return openapi_client.DefaultApi(ApiClientWrapperInternal(conf))
+
+
+@click.command(name="login", help="Log in to Anyscale using a URL.")
+@click.option(
+    "--no-expire", is_flag=True, default=False, help="Do not expire the token.",
+)
+@click.option(
+    "--expire-in-days",
+    type=int,
+    default=7,
+    help="Expire the token after this many days.",
+)
+def anyscale_login(no_expire: bool, expire_in_days: int) -> None:
+    """Log in to Anyscale using a URL
+    This is the only unauthenticated API usage in the CLI."""
+    if expire_in_days < 0 or no_expire:
+        duration_seconds = 0  # no expiration
+    else:
+        duration_seconds = expire_in_days * 24 * 60 * 60  # seconds
+
+    api_client = get_unauthenticated_openapi_client()
+
+    r = api_client.create_one_time_password_api_v2_users_create_otp_token_get(
+        duration_seconds=duration_seconds
+    ).result
+    token = r.otp
+
+    log.info("Please log in to Anyscale using the following URL:")
+    log.info(r.url)
+
+    # Open the URL in the browser. This will work on most platforms.
+    # OK to suppress any uncaught exceptions, because the URL will be printed out anyway.
+    with contextlib.suppress(Exception):
+        webbrowser.open(r.url)
+
+    # give user 3 minutes to log in (3 seconds per attempt)
+    for _i in range(60):
+        check_result = api_client.check_one_time_password_api_v2_users_request_otp_token_otp_get(
+            token
+        ).result
+        if check_result.valid:
+            AuthController().set(check_result.server_session_id)
+            log.info("Successfully logged in to Anyscale.")
+            if duration_seconds > 0:
+                log.info(f"The authentication will expire in {expire_in_days} days.")
+            return
+        time.sleep(3)
+
+    log.info("Failed to log in to Anyscale. Please try again.")
+
+
+@click.command(
+    name="logout", help="Log out from Anyscale. You CLI token will be revoked."
+)
+def anyscale_logout() -> None:
+    AuthController().remove(ask=False)
+    log.info("Successfully logged out from Anyscale.")