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:

  • login: Interactive login to Apheris.
  • logout: Log out of Apheris.
  • version: Print the version of the Apheris CLI.
  • datasets: Use the sub-commands to interact with datasets.
  • compute: Use the sub-commands to interact with Compute Specs.
  • job: Use the sub-commands to interact with jobs.
  • models: Interact with the Apheris Registry.

apheris login🔗

Interactive login to Apheris. 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 Apheris.

Usage:

$ apheris logout [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.

apheris datasets🔗

Use the sub-commands to interact with datasets.

Usage:

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

Options:

  • --help: Show this message and exit.

Commands:

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

apheris datasets list🔗

List all datasets that you have access to.

Usage:

$ apheris datasets list [OPTIONS]

Options:

  • --help: Show this message and exit.

apheris datasets describe🔗

Show information on a single dataset.

Usage:

$ apheris datasets describe [OPTIONS] DATASET_ID

Arguments:

  • DATASET_ID: ID of the dataset to show information on. [required]

Options:

  • --help: Show this message and exit.

apheris datasets policy🔗

Show the asset policy of a dataset that you have access to.

Usage:

$ apheris datasets policy [OPTIONS] DATASET_ID

Arguments:

  • DATASET_ID: ID of the dataset to get the policy for. [required]

Options:

  • --help: Show this message and exit.

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:

  • create: Create a Compute Spec on the Apheris orchestrator.
  • get: Get a Compute Spec from the Apheris orchestrator.
  • list: List all your Compute Specs.
  • activate: Activate a Compute Spec.
  • deactivate: Deactivate a Compute Spec - stops any running jobs and shuts down any infrastructure that was brought up for this Compute Spec.
  • activate-status: Get information on the status of the activation of a Compute Spec.
  • status: Get the status of a Compute Spec.
  • deactivate-all: Deactivate all Compute Specs that are in an active or transitional state.

apheris compute create🔗

Create a Compute Spec 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. apheris-statistics
  • --model_version TEXT: The version of the model to use, e.g. v0.0.5
  • --num_clients_per_gateway INTEGER: Number of compute clients to spawn (optional, for advanced users)
  • --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 get🔗

Get a Compute Spec 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 Specs.

Usage:

$ apheris compute list [OPTIONS]

Options:

  • -l, --limit INTEGER: Limit the number of Compute Specs shown. Set a negative number to show all [default: 10]
  • -v, --verbose: Show more detailed status information.
  • --active_only: List only active Compute Specs.
  • --help: Show this message and exit.

apheris compute activate🔗

Activate a Compute Spec. 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 deactivate🔗

Deactivate a Compute Spec - 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 Spec 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 activate-status🔗

Get information on the status of the activation of a Compute Spec.

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 status🔗

Get the status of a Compute Spec.

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, for example, due to capacity constraints.
  • --help: Show this message and exit.

apheris compute deactivate-all🔗

Deactivate all Compute Specs that are in an active or transitional state.

Usage:

$ apheris compute deactivate-all [OPTIONS]

Options:

  • -f, --force: Do not ask for confirmation.
  • --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:

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

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. This parameter is deprecated.
  • -f, --force: Do not ask if user is certain.
  • -v, --verbose: Show more detailed information.
  • --help: Show this message and exit.

apheris job schedule🔗

Schedule a job with specified datasets, model, and resources.

Usage:

$ apheris job schedule [OPTIONS]

Options:

  • --dataset_ids TEXT: Comma-separated dataset IDs, e.g. id1,id2,id3 [required]
  • --model_id TEXT: A model ID, e.g. statistics [required]
  • --model_version TEXT: The version of the model to use, e.g. 0.0.5 [required]
  • --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
  • --timeout FLOAT: Timeout in seconds for waiting for compute spec to be running. Default is 10 minutes (600 seconds). This can happen for big models.
  • -f, --force: Do not ask if user is certain.
  • --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]
  • --num_clients_per_gateway INTEGER: Number of compute clients to spawn (optional)
  • --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 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.
  • -v, --verbose: Show more detailed information.
  • --help: Show this message and exit.

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. This parameter is deprecated.
  • -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. This parameter is deprecated.
  • --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. This parameter is deprecated.
  • --help: Show this message and exit.

apheris models🔗

Interact with the Apheris Registry.

Usage:

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

Options:

  • --help: Show this message and exit.

Commands:

  • list: List models that are available in the Apheris Registry.
  • get: Get a model by its ID.
  • list-versions: Get a list of all versions available for a given model.
  • add-version: Add a new version to an existing model in the Apheris Registry.
  • add: Preview functionality: please speak to your Apheris representative to enable this feature.
  • show-robot: Preview functionality: please speak to your Apheris representative to enable this feature.

apheris models list🔗

List models that are available in the Apheris Registry. Note that only the 3 most recent versions of each model are shown.

Usage:

$ apheris models list [OPTIONS]

Options:

  • --help: Show this message and exit.

apheris models get🔗

Get a model by its ID.

Usage:

$ apheris models get [OPTIONS] MODEL_ID

Arguments:

  • MODEL_ID: Apheris ID of a model. Can be obtained via Apheris UI or CLI. [required]

Options:

  • -v, --verbose: Show more detailed status information.
  • --help: Show this message and exit.

apheris models list-versions🔗

Get a list of all versions available for a given model.

Usage:

$ apheris models list-versions [OPTIONS] MODEL_ID

Arguments:

  • MODEL_ID: Apheris ID of a model. Can be obtained via Apheris UI or CLI. [required]

Options:

  • --help: Show this message and exit.

apheris models add-version🔗

Add a new version to an existing model in the Apheris Registry.

Usage:

$ apheris models add-version [OPTIONS] MODEL_ID

Arguments:

  • MODEL_ID: Apheris ID of the model to which you want to add a version to. Obtainable via Apheris UI or CLI. [required]

Options:

  • --version TEXT: Version number for the new model version. Needs to match the repo that holds the built image. [required]
  • --digest TEXT: Digest for the new model. Needs to match the repository that holds the built image. [required]
  • --commit-hash TEXT: Hash for the new model version. [required]
  • --engine-version TEXT: Engine version, for example nvflare:2.6.0. For information on supported engines and versions, please contact your Apheris representative. [required]
  • --help: Show this message and exit.

apheris models add🔗

Preview functionality: please speak to your Apheris representative to enable this feature. Add a new model to the Apheris Registry.

Usage:

$ apheris models add [OPTIONS] MODEL_ID

Arguments:

  • MODEL_ID: ID of the model. Must be unique and contain only lowercase letters (a-z), digits (0-9), and single hyphens. No leading, trailing, or consecutive hyphens are allowed. [required]

Options:

  • --model-name TEXT: Name of the model. This is the human-readable name of the model. [required]
  • --source-repository-url TEXT: FQDN of the source repository. [required]
  • --model-description TEXT: Longer description of the model. Markdown is supported. Max 5000 characters.
  • --logo-url TEXT: URL to the logo of the model or base64 encoded image.
  • --help: Show this message and exit.

apheris models show-robot🔗

Preview functionality: please speak to your Apheris representative to enable this feature. Show user's robot account details to push model versions to the model's OCI repository.

Usage:

$ apheris models show-robot [OPTIONS]

Options:

  • --help: Show this message and exit.