Skip to content

CLI🔗

Usage:

$ [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 create or get a compute spec, up- or download a docker build context, and to activate a compute spec.
  • datasets: Call apheris datasets list to show all datasets.
  • job: Use the sub-commands to run a job, check the status and get results.
  • login: Interactive login to the Apheris solution.
  • logout: Log out of the Apheris solution.
  • models: Interact with the model registry.

compute🔗

Use the sub-commands to create or get a compute spec, up- or download a docker build context, and to activate a compute spec.

Usage:

$ 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.

compute activate🔗

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

Usage:

$ compute activate [OPTIONS] [COMPUTE_SPEC_ID]

Arguments:

  • [COMPUTE_SPEC_ID]: The ID of the compute spec.

Options:

  • -f, --force: Do not prompt the user for confirmation.
  • --help: Show this message and exit.

compute activate-status🔗

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

Usage:

$ compute activate-status [OPTIONS] [COMPUTE_SPEC_ID]

Arguments:

  • [COMPUTE_SPEC_ID]: The ID of the compute spec.

Options:

  • --help: Show this message and exit .

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:

$ compute create [OPTIONS]

Options:

  • --dataset_ids TEXT: Comma-separated dataset IDs, e.g. -dataset_ids=id1,id2,id3
  • --with_custom_code / --without_custom_code: Use if you wish to submit custom code with this compute-spec. This will be injected into the pythonpath of the gateway container.
  • --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, in semver format e.g. 1.2.3
  • --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 prompt the user for confirmation.
  • --help: Show this message and exit.

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:

$ compute deactivate [OPTIONS] [COMPUTE_SPEC_ID]

Arguments:

  • [COMPUTE_SPEC_ID]: The ID of the compute spec.

Options:

  • -f, --force: Do not prompt the user for confirmation.
  • --help: Show this message and exit.

compute get🔗

Get a compute specification from the Apheris Orchestrator.

Usage:

$ compute get [OPTIONS] [COMPUTE_SPEC_ID]

Arguments:

  • [COMPUTE_SPEC_ID]: The ID of the compute spec.

Options:

  • --help: Show this message and exit.

compute list🔗

List all your compute specifications.

Usage:

$ compute list [OPTIONS]

Options:

  • -l, --limit INTEGER RANGE: The maximum number of compute specs to query in verbose mode (ignored without verbose). This will speed up the query if you have a long history of compute specs. [x>=1]
  • -v, --verbose: Show more detailed status information.
  • -vv, --very-verbose: If the table of verbose results is truncated, this forces the full column to print. Note: display may be poor on small screens. Sets --verbose when used.
  • --help: Show this message and exit.

compute status🔗

Get the status of a compute specification.

Usage:

$ compute status [OPTIONS] [COMPUTE_SPEC_ID]

Arguments:

  • [COMPUTE_SPEC_ID]: The ID of the compute spec.

Options:

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

datasets🔗

Call apheris datasets list to show all datasets. Then call apheris datasets describe <dataset_id> to show details for a particular one.

Usage:

$ 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.

datasets describe🔗

Show information on a single dataset.

Usage:

$ datasets describe [OPTIONS] DATASET_ID

Arguments:

  • DATASET_ID: [required]

Options:

  • --help: Show this message and exit.

datasets list🔗

List all datasets for which you are a beneficiary

Usage:

$ datasets list [OPTIONS]

Options:

  • --help: Show this message and exit.

job🔗

Use the sub-commands to run a job, check the status and get results.

Usage:

$ 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.

job abort🔗

Abort a currently running job.

Usage:

$ job abort [OPTIONS]

Options:

  • --job-id UUID: The ID of the job.
  • --compute-spec-id UUID: The ID of the compute spec.
  • -f, --force: Do not prompt the user for confirmation.
  • --help: Show this message and exit.

job download-results🔗

Download the results of a job.

Usage:

$ job download-results [OPTIONS] [DOWNLOAD_PATH]

Arguments:

  • [DOWNLOAD_PATH]: Directory to store the downloaded results.

Options:

  • --job-id UUID: The ID of the job.
  • --compute-spec-id UUID: The ID of the compute spec.
  • --help: Show this message and exit.

job list🔗

List jobs.

Usage:

$ job list [OPTIONS]

Options:

  • --compute-spec-id UUID: The ID of the compute spec.
  • --help: Show this message and exit.

job logs🔗

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

Usage:

$ job logs [OPTIONS]

Options:

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

job run🔗

Submit a job to run it.

Usage:

$ 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.
  • -f, --force: Do not prompt the user for confirmation.
  • -v, --verbose: Show more detailed information.
  • --help: Show this message and exit.

job status🔗

Get the status and details of a job.

Usage:

$ job status [OPTIONS]

Options:

  • --job-id UUID: The ID of the job.
  • --compute-spec-id UUID: The ID of the compute spec.
  • -v, --verbose: Show more detailed information.
  • --help: Show this message and exit.

login🔗

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

$ login [OPTIONS] [COMMAND]

Arguments:

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

Options:

  • --help: Show this message and exit.

logout🔗

Log out of the Apheris solution.

Usage:

$ logout [OPTIONS]

Options:

  • --help: Show this message and exit.

models🔗

Interact with the model registry.

Usage:

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

Options:

  • --help: Show this message and exit.

Commands:

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

models list🔗

List models that are available in the model registry.

Usage:

$ models list [OPTIONS]

Options:

  • --help: Show this message and exit.