Skip to content

apheris🔗

Usage:

$ apheris [OPTIONS] COMMAND [ARGS]...

Options:

  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Commands:

  • compute: Use the sub-commands to interact with compute specs.
  • datasets: Use the sub-commands to interact with datasets.
  • job: Use the sub-commands to interact with jobs.
  • login: Interactive login to the Apheris platform.
  • logout: Log out of the Apheris platform.
  • models: Interact with the model registry.
  • version: Print the version of the Apheris CLI.

apheris compute🔗

Use the sub-commands to interact with compute specs.

Usage:

$ apheris compute [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • activate: Activate a compute specification.
  • activate-status: Get information on the status of the activation of a compute specification.
  • create: Create a compute specification on the Apheris orchestrator.
  • deactivate: Deactivate a compute specification - stops any running jobs and shuts down any infrastructure that was brought up for this compute spec.
  • get: Get a compute specification from the Apheris orchestrator.
  • list: List all your compute specifications.
  • status: Get the status of a compute specification.

apheris compute activate🔗

Activate a compute specification. This will spin up a cluster of Compute Clients and Compute Aggregators.

Usage:

$ apheris compute activate [OPTIONS] [COMPUTE_SPEC_ID]

Arguments:

  • [COMPUTE_SPEC_ID]: The ID of the compute spec. If None, use the most recently used compute spec ID.

Options:

  • -f, --force: Do not ask if user is certain.
  • --help: Show this message and exit.

apheris compute activate-status🔗

Get information on the status of the activation of a compute specification.

Usage:

$ apheris compute activate-status [OPTIONS] [COMPUTE_SPEC_ID]

Arguments:

  • [COMPUTE_SPEC_ID]: The ID of the compute spec. If None, use the most recently used compute spec ID.

Options:

  • --help: Show this message and exit.

apheris compute create🔗

Create a compute specification on the Apheris orchestrator. All parameters that are not passed as command line arguments will be interactively queried.

Usage:

$ apheris compute create [OPTIONS]

Options:

  • --dataset_ids TEXT: Comma-separated dataset IDs, e.g. -dataset_ids=id1,id2,id3
  • --ignore_limits: The CLI sets some expected bounds for requested infrastructure resources. Use this flag to override the validation checks if your model requires more resources.
  • --client_n_cpu FLOAT: number of vCPUs of Compute Clients
  • --client_n_gpu INTEGER: number of GPUs of Compute Clients
  • --client_memory INTEGER: memory of Compute Clients [MByte]
  • --server_n_cpu FLOAT: number of vCPUs of Compute Aggregators
  • --server_n_gpu INTEGER: number of GPUs of Compute Aggregators
  • --server_memory INTEGER: memory of Compute Aggregators [MByte]
  • --model_id TEXT: A model ID, e.g. statistics
  • --model_version TEXT: The version of the model to use, e.g. v0.0.5
  • --json PATH: File path to json file that describes a compute spec. Please use the interactive workflow once to learn about the expected format. If specified, all other arguments (except for force) must be None to avoid clashes.
  • -f, --force: Do not ask if user is certain, and do not ask for arguments interactively.
  • --help: Show this message and exit.

apheris compute deactivate🔗

Deactivate a compute specification - stops any running jobs and shuts down any infrastructure that was brought up for this compute spec. Use this if you have spun up a cluster of Compute Clients and Compute Aggregators, and don't need it anymore. Provided the compute specification remains approved, you can use activate to reinstate the infrastructure if needed at a later time.

Usage:

$ apheris compute deactivate [OPTIONS] [COMPUTE_SPEC_ID]

Arguments:

  • [COMPUTE_SPEC_ID]: The ID of the compute spec. If None, use the most recently used compute spec ID.

Options:

  • -f, --force: Do not ask if user is certain.
  • --help: Show this message and exit.

apheris compute get🔗

Get a compute specification from the Apheris orchestrator.

Usage:

$ apheris compute get [OPTIONS] [COMPUTE_SPEC_ID]

Arguments:

  • [COMPUTE_SPEC_ID]: The ID of the compute spec. If None, use the most recently used compute spec ID.

Options:

  • --help: Show this message and exit.

apheris compute list🔗

List all your compute specifications.

Usage:

$ apheris compute list [OPTIONS]

Options:

  • -l, --limit INTEGER RANGE: The maximum number of compute specs to query. Lower value will speed up the query. [x>=1]
  • -v, --verbose: Show more detailed status information.
  • --help: Show this message and exit.

apheris compute status🔗

Get the status of a compute specification.

Usage:

$ apheris compute status [OPTIONS] [COMPUTE_SPEC_ID]

Arguments:

  • [COMPUTE_SPEC_ID]: The ID of the compute spec. If None, use the most recently used compute spec ID.

Options:

  • -v, --verbose: Show more information about compute spec status. Can be used to diagnose the issue when your compute spec is stuck in creating, forexample, due to capacity constraints.
  • --help: Show this message and exit.

apheris datasets🔗

Use the sub-commands to interact with datasets.

Usage:

$ apheris datasets [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • describe: Show information on a single dataset.
  • list: List all datasets that you have access to.

apheris datasets describe🔗

Show information on a single dataset.

Usage:

$ apheris datasets describe [OPTIONS] DATASET_ID

Arguments:

  • DATASET_ID: [required]

Options:

  • --help: Show this message and exit.

apheris datasets list🔗

List all datasets that you have access to.

Usage:

$ apheris datasets list [OPTIONS]

Options:

  • --help: Show this message and exit.

apheris job🔗

Use the sub-commands to interact with jobs.

Usage:

$ apheris job [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • abort: Abort a currently running job.
  • download-results: Download the results of a job.
  • list: List jobs.
  • logs: Download the logs for a job, which can be optionally written to a file.
  • run: Submit a job to run it.
  • status: Get the status and details of a job.

apheris job abort🔗

Abort a currently running job.

Usage:

$ apheris job abort [OPTIONS]

Options:

  • --job-id UUID: The ID of the job. If None, use the most recently used job ID.
  • --compute-spec-id UUID: The ID of the compute spec. If None, use the most recently used compute spec ID.
  • -f, --force: Do not ask if user is certain.
  • --help: Show this message and exit.

apheris job download-results🔗

Download the results of a job.

Usage:

$ apheris job download-results [OPTIONS] [DOWNLOAD_PATH]

Arguments:

  • [DOWNLOAD_PATH]: Directory to store the downloaded results

Options:

  • --job-id UUID: The ID of the job. If None, use the most recently used job ID.
  • --compute-spec-id UUID: The ID of the compute spec. If None, use the most recently used compute spec ID.
  • --help: Show this message and exit.

apheris job list🔗

List jobs.

Usage:

$ apheris job list [OPTIONS]

Options:

  • --compute-spec-id UUID: The ID of the compute spec. If None, returns all jobs
  • --help: Show this message and exit.

apheris job logs🔗

Download the logs for a job, which can be optionally written to a file.

Usage:

$ apheris job logs [OPTIONS]

Options:

  • --storage-path FILE: File in which to store logs (plaintext)
  • --job-id UUID: The ID of the job. If None, use the most recently used job ID.
  • --compute-spec-id UUID: The ID of the compute spec. If None, use the most recently used compute spec ID.
  • --help: Show this message and exit.

apheris job run🔗

Submit a job to run it.

Usage:

$ apheris job run [OPTIONS]

Options:

  • --payload TEXT: Arguments to provide to the job. You can either provide the filepath to a json-file, or a string that contains a json-compatible dictionary.
  • --compute-spec-id UUID: The ID of the compute spec. If None, use the most recently used compute spec ID.
  • -f, --force: Do not ask if user is certain.
  • -v, --verbose: Show more detailed information.
  • --help: Show this message and exit.

apheris job status🔗

Get the status and details of a job.

Usage:

$ apheris job status [OPTIONS]

Options:

  • --job-id UUID: The ID of the job. If None, use the most recently used job ID.
  • --compute-spec-id UUID: This argument is deprecated and will be removed in future releases.
  • -v, --verbose: Show more detailed information.
  • --help: Show this message and exit.

apheris login🔗

Interactive login to the Apheris platform. You will be forwarded to a website. For machine to machine applications (m2m), make sure the environment variables APH_SERVICE_USER_CLIENT_ID and APH_SERVICE_USER_CLIENT_SECRET are set. Call apheris login status to check your login status.

Usage:

$ apheris login [OPTIONS] [COMMAND]

Arguments:

  • [COMMAND]: Call apheris login status to show your login status.

Options:

  • --help: Show this message and exit.

apheris logout🔗

Log out of the Apheris platform.

Usage:

$ apheris logout [OPTIONS]

Options:

  • --help: Show this message and exit.

apheris models🔗

Interact with the model registry.

Usage:

$ apheris models [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • list: List models that are available in the model registry.

apheris models list🔗

List models that are available in the model registry.

Usage:

$ apheris models list [OPTIONS]

Options:

  • --help: Show this message and exit.

apheris version🔗

Print the version of the Apheris CLI.

Usage:

$ apheris version [OPTIONS]

Options:

  • --help: Show this message and exit.