d3x Commands¶

d3x commands are used for managing the user workspace, apikeys, ray clusters, user apps and deployments. This page provides information about all of the d3x commands that are currently available, along with their functions, usage syntax and available options.

Usage

d3x [OPTIONS] COMMAND [ARGS]...
Function

Group for d3x commands.
Options

Option

Description

-d, --debug

Enable requests debugging.

--profile TEXT

Cluster profile.

--help

Shows help for this section.

Option	Description
`-d`, `--debug`	Enable requests debugging.
`--profile TEXT`	Cluster profile.
`--help`	Shows help for this section.

Commands

Command	Description
`about`	Provides details about d3x CLI configuration such as Username, API Key, etc.
`apikey`	Set of commands to generate a new API key or to get the current API key
`apps`	Set of commands to control the user apps on DKubeX
`code`	Access the DKubeX VSCode application and connect to your DKubeX workspace
`fm`	Set of commands used for finetuning & RAG
`list`	List DKubeX workspaces
`llms`	Set of commands to list and/or deploy the LLMs registered with DKubeX
`login`	Login to your DKubeX workspace remotely
`mlflow`	Set of commands pertaining to MLFlow experiments & models
`models`	List and manage MLFlow models registry
`mount`	Mount an available S3 bucket in read-write model
`port-forward`	Forward port from any given DKubeX workspace to any specified remote system
`profile`	Group for profile commands
`ray`	Set of commands pertaining to Ray Dashboard and Cluster(s)
`reset`	Reset any given DKubeX workspace to default image
`scp`	Copy file(s)/directory from/to any given DKubeX workspace
`serve`	Set of commands pertaining to Ray Serve
`sky`	Set of commands pertaining to SkyPilot
`ssh`	SSH to any given DKubeX workspace
`ssh-copy-id`	Copy SSH public key to your DKubeX home
`start`	Start any given DKubeX workspace
`stop`	Stop any given DKubeX workspace
`top`	Show the workspace’s resource usage
`umount`	Unmount buckets that were previously mounted using the mount command
`version`	DKubeX version
`vnc`	VNC connection to any given DKubeX workspace

`d3x about`¶

Usage

d3x about [OPTIONS]
Function

Provides details about d3x CLI configuration such as Username, API Key, etc.
Options

Option

Description

--help

Shows help for this section

Option	Description
`--help`	Shows help for this section

`d3x apikey`¶

Usage

d3x apikey [OPTIONS] COMMAND [ARGS}...
Function

Set of commands to generate a new API key or to get the current API key.
Options

Option

Description

--help

Shows help for this section
Commands

Command

Description

generate

Generate user API key

get

Get user API key

Option	Description
`--help`	Shows help for this section

Command	Description
`generate`	Generate user API key
`get`	Get user API key

`d3x apps`¶

Usage

d3x apps [OPTIONS] COMMAND [ARGS]...
Function

Set of commands to control the user apps on DKubeX.
Options

Option

Description

--help

Shows help for this section

Option	Description
`--help`	Shows help for this section

Commands

Command	Description
`create`	Deploy the user app on DKubeX
`delete`	Delete user app
`list`	List user apps
`open`	Open user app in browser

Usage

d3x apps create [OPTIONS] IMAGE [COMMAND]...
Function

Deploy the user app on DKubeX.

Options

Option	Description
`--help`	Shows help for this section.
`--name TEXT`	App name
`--cpu INTEGER`	Number of CPU cores needed for deployment
`--gpu INTEGER`	Number of GPU cores needed for deployment
`--memory INTEGER`	Amount of memory in GB needed for deployment
`--publish TEXT`	Publish app globally
`--dockerserver TEXT`	Docker registry url for ingress
`--dockeruser TEXT`	Docker registry username for ingress
`--dockerpsw TEXT`	Docker registry password for ingress
`-e TEXT`	Set environment variables
`-p TEXT`	Publish a container’s port(s)
`-d TEXT`	Description of the deployment
`-rt TEXT`	Rewrite-target for ingress
`-cs TEXT`	Configuration-snippet for ingress
`-ip TEXT`	Ingress prefix for ingress

Usage

d3x apps delete [OPTIONS] NAME
Function

Deletes dev Ray cluster.
Options

Option

Description

--help

Shows help for this section.

Usage

d3x apps list [OPTIONS]
Function

Lists user apps.
Options

Option

Description

--help

Shows help for this section.

Usage

d3x apps open [OPTIONS] NAME
Function

Opens user apps in browser.
Options

Option

Description

--help

Shows help for this section.

`d3x code`¶

Usage

d3x code [OPTIONS] WORKSPACE_NAME
Function

Access the VSCode application and connect to your DKubeX workspace.
Options

Option

Description

--help

Shows help for this section

Option	Description
`--help`	Shows help for this section

`d3x fm`¶

Usage

d3x fm [OPTIONS] COMMAND [ARGS]...
Function

Set of commands used for finetuning & RAG.
Options

Option

Description

--help

Shows help for this section

Option	Description
`--help`	Shows help for this section

Commands

Command	Description
`delete`	Delete user app
`docs`	Run document processing job
`get`	Get fm job details
`jobs`	List fm jobs
`logs`	Show logs of given fm job
`query`	Run fm query job
`trainchunks`	Create Ray Training Chunks
`tune`	Run Document Processing Job

Usage

d3x fm delete [OPTIONS] JOB_NAME
Function

Delete job
Options

Option

Description

--help

Shows help for this section.

Usage

d3x fm docs [OPTIONS] COMMAND [ARGS]...
Function

Command group related to fm docs.
Options

Option

Description

--help

Shows help for this section.

Commands

Command	Description
`add`	Ingest documents
`backup`	Group for backup commands
`create-chunks`	Create chunks of documents
`create-dataset`	Create dataset out of chunks
`delete`	Group for delete commands
`show`	Group for list commands

Usage

d3x fm docs add [OPTIONS]
Function

Ingest documents.

Options

Option	Description
`-d`, `--dataset TEXT`	A name to represent the dataset created from docs ingestion [required]
`-s`, `--source TEXT`	The path where docs are sourced from for ingestion [required]
`-c`, `--chunks TEXT`	The path where document chunks are saved for training
`-emb`, `--embeddings [mpnet-v2\|openai\|bert]`	Use on of OpenAI, mpnet-v2 or Bert
`-nc`, `--no-citation`	Don’t derive citation. Use file name [True]
`--help`	Shows help for this section.

Usage

d3x fm docs backup [OPTIONS] COMMAND [ARGS]...
Function

Group for backup commands
Options

Option

Description

--help

Shows help for this section.

Commands

Command	Description
`create`	Creates backup of embeddings
`restore`	restores embeddings from backup

Usage

d3x fm docs backup create [OPTIONS]
Function

Creates backup of embeddings. Separate backups for each dataset

Options

Option	Description
`-d`, `--dataset TEXT`	A name to represent the ingested docs [required]
`-i`, `--id TEXT`	An ID for the backup [required]
`-b`, `--backend [filesystem\|s3]`	s3 or filesystem to save the backup [required]
`--help`	Shows help for this section.

Usage

d3x fm docs backup restore [OPTIONS]
Function

Restores embeddings from backup
Options

Option

Description

-i, --id TEXT

An ID for the backup [required]

-b, --backend [filesystem|s3]

s3 or filesystem to save the backup [required]

--help

Shows help for this section.

Option	Description
`-i`, `--id TEXT`	An ID for the backup [required]
`-b`, `--backend [filesystem\|s3]`	s3 or filesystem to save the backup [required]
`--help`	Shows help for this section.

Usage

d3x fm docs create-chunks [OPTIONS]
Function

Create chunks of documents

Options

Option	Description
`-s`, `--source TEXT`	The path where docs are sourced from for ingestion [required]
`-d`, `--destination TEXT`	The path where chunks are created [required]
`-c`, `--chunk-size INTEGER`	Chunk size
`--help`	Shows help for this section.

Usage

d3x fm docs create-dataset [OPTIONS]
Function

Create dataset out of chunks. Creates lists (groups) using grouper function, Where each list will have ‘n’ directory names. Use these lists for multiprocessing in embedding creation process.

Parameters: dataset_path (str):The directory path where directories associated with each file is there. dataset_name (str): Name of the dataset. embeddings_model_name (str):

Options

Option	Description
`-d`, `--dataset_path TEXT`	The path where docs are sourced from for ingestion [required]
`--dataset_name TEXT`	The path where chunks are created [required]
`-emb`, `--embeddings [mpnet-v2\|openai\|bert]`	Use on of OpenAI, mpnet-v2 or Bert
`--help`	Shows help for this section.

Usage

d3x fm docs delete [OPTIONS] COMMAND [ARGS]...
Function

Group for delete commands
Options

Option

Description

--help

Shows help for this section.

Commands

Command	Description
`dataset`	Deletes all docs for a given dataset
`docs`	Deletes specified docs from a dataset

Usage

d3x fm docs delete dataset [OPTIONS]
Function

Deletes all docs for a given dataset
Options

Option

Description

-d, --dataset TEXT

A name to represent the ingested docs [required]

--help

Shows help for this section.

Usage

d3x fm docs delete docs [OPTIONS]
Function

Deletes specified docs from a dataset

Options

Option	Description
`-d`, `--dataset TEXT`	A name to represent the ingested docs [required]
`-s`, `--source TEXT`	The path where the docs are sourced for ingestion [required]
`--help`	Shows help for this section.

Usage

d3x fm docs delete [OPTIONS] COMMAND [ARGS]...
Function

Group for list commands
Options

Option

Description

--help

Shows help for this section.
Commands

Command

Description

datasets

Lists all datasets in the vectordb

docs

Lists all documents in a dataset
- Usage
  
  d3x fm docs show datasets [OPTIONS]
- Function
  
  Lists all datasets in the vectordb
- Options
  
  Option
  
  Description
  
  --help
  
  Shows help for this section.
- Usage
  
  d3x fm docs delete docs [OPTIONS]
- Function
  
  Lists all documents in a dataset
- Options
  
  Option
  
  Description
  
  -d, --dataset TEXT
  
  A name to represent the ingested docs [required]
  
  --help
  
  Shows help for this section.

Command	Description
`datasets`	Lists all datasets in the vectordb
`docs`	Lists all documents in a dataset

Usage

d3x fm get [OPTIONS] JOB_NAME
Function

Get Job details
Options

Option

Description

--help

Shows help for this section.

Usage

d3x fm jobs [OPTIONS]
Function

List fm jobs
Options

Option

Description

--help

Shows help for this section.

Usage

d3x fm logs [OPTIONS] JOB_NAME
Function

Show logs of given job
Options

Option

Description

--help

Shows help for this section.

Usage

d3x fm query [OPTIONS] COMMAND [ARGS]...
Function

Command group for fm query.
Options

Option

Description

--help

Shows help for this section.

Commands

Command	Description
`llm`	Delete user app
`openai`	Run document processing job

Usage

d3x fm query llm [OPTIONS]
Function

Queries the provided dataset with appropriate open-source LLM.

Options

Option		Description
`-d`, `--dataset TEXT`		A name to represent the ingested docs [required]
`-g`, `--securellm`		Use SecureLLM as the Gateway
`-emb`, `--embeddings [mpnet-v2\|openai\|bert]`		Use on of OpenAI, mpnet-v2 or Bert
`-dep`, `--deployment TEXT`		LLM deployment name [required]
`-n`, `--namespace TEXT`		Deployment namespace. Default: user namespace
`-f`, `--input TEXT`		Input file for batch Q&A
`-dep`, `--deployment TEXT`		Output file for batch Q&A
`-k`, `--k-neighbors INTEGER`		K nearest neighbors from vectordb
`-ms`, `--max-sources INTEGER`		Number of chunks/summarizations to use for final answer
`-mmr`, `--marginal-relevance`		Use marginal relevance default:similarity_search
`-ds`, `--disable-summarization`		Disable LLM Summarization of K chunks
`-v`, `--log-level [DEBUG\|INFO]`		log level DEBUG, INFO
`--help`		Show this message and exit

Usage

d3x fm query openai [OPTIONS]
Function

Queries the provided dataset with OpenAI.

Options

Option		Description
`-d`, `--dataset TEXT`		A name to represent the ingested docs [required]
`-g`, `--securellm`		Use SecureLLM as the Gateway
`-emb`, `--embeddings [mpnet-v2\|openai\|bert]`		Use on of OpenAI, mpnet-v2 or Bert
`-f`, `--input TEXT`		Input file for batch Q&A
`-dep`, `--deployment TEXT`		Output file for batch Q&A
`-k`, `--k-neighbors INTEGER`		K nearest neighbors from vectordb
`-ms`, `--max-sources INTEGER`		Number of chunks/summarizations to use for final answer
`-mmr`, `--marginal-relevance`		Use marginal relevance default:similarity_search
`-ds`, `--disable-summarization`		Disable LLM Summarization of K chunks
`-v`, `--log-level [DEBUG\|INFO]`		log level DEBUG, INFO
`--help`		Show this message and exit

Usage

d3x fm trainchunks [OPTIONS]
Function

Creates train and/or test chunks for finetuning

Options

Option	Description
`-s`, `--source TEXT`	The path where finetune chunks are sourced from [required]
`-d`, `--destination TEXT`	The path where chunks will be kept for training [required]
`--split [train\|test]`	Specify train or test. Default: both
`-p`, `--split-percent INTEGER`	Specify percentage of docs to go in train/test
`-l`, `--last`	pick documents from backwards
`--help`	Shows help for this section.

Usage

d3x fm tune [OPTIONS] COMMAND [ARGS]...
Function

Run Finetuning Job on the provided model
Options

Option

Description

--help

Shows help for this section.

Commands

Option	Description
`model`	Set of commands to finetune, merge or/and quantize model(s)

Usage

d3x fm tune model [OPTIONS] COMMAND [ARGS]...
Function

Set of commands to finetune, merge or/and quantize model(s)
Options

Option

Description

--help

Shows help for this section.

Commands

Option	Description
`finetune`	Command to finetune given model(s)
`merge`	Command to merge any model(s)
`quantize`	Command to quantize model(s)

Usage

d3x fm tune model finetune [OPTIONS]
Function

Command to finetune given model(s)

Options

Option	Description
`-j`, `--job-name TEXT`	Job name
`-d`, `--docker-image TEXT`	docker image for the ray job
`-e`, `--epochs INTEGER`	number of epochs
`-b`, `--batch-size INTEGER`	batch size
`-l`, `--dataset-location TEXT`	dataset location
`-o`, `--output-location TEXT`	output location
`-n`, `--model-name TEXT`	model name (should contain complete hf path meta-llama/Llama-2-13b-chat-hf)
`-p`, `--model-path TEXT`	downloaded model location from huggingface
`-h`, `--hf-token TEXT`	huggingface token
`-c`, `--cpu INTEGER`	number of cpu
`-g`, `--gpu INTEGER`	number of gpu
`-t`, `--type TEXT`	instance type
`-m`, `--mem INTEGER`	number of memories
`--as-test`	As test
`--stop-perplexity FLOAT`	Target perplexity to reach after which to stoptraining. Default is 0. If 0, training will not stop on perplexity
`--ctx-len INTEGER`	Learning rate to use
`--experiment-name TEXT`	mlflow experiment name
`--help`	Show this message and exit

Usage

d3x fm tune model merge [OPTIONS]
Function

Command to merge any model(s)

Options

Option	Description
`-j`, `--job-name TEXT`	Ray Cluster name
`-d`, `--docker-image TEXT`	docker image for the ray job
`-o`, `--output-location TEXT`	output location
`-n`, `--model-name TEXT`	model name (should contain complete hf path). e.g. meta-llama/Llama-2-13b-chat-hf
`-p`, `--model-path TEXT`	downloaded model location from huggingface
`-cp`, `--checkpoint TEXT`	Path to checkpoint containing the LoRA weights
`-c`, `--cpu INTEGER`	number of cpu
`-g`, `--gpu INTEGER`	number of gpu
`-t`, `--type TEXT`	instance type
`-m`, `--mem INTEGER`	number of memories
`--help`	Show this message and exit

Usage

d3x fm tune model quantize [OPTIONS]
Function

Command to quantize model(s)

Options

Option	Description
`-j`, `--job-name TEXT`	Ray Cluster name
`-d`, `--docker-image TEXT`	docker image for the ray job
`-o`, `--output-location TEXT`	output location
`-p`, `--model-path TEXT`	downloaded model location from huggingface
`-c`, `--cpu INTEGER`	number of cpu
`-g`, `--gpu INTEGER`	number of gpu
`-t`, `--type TEXT`	instance type
`--help`	Show this message and exit

`d3x list`¶

Usage

d3x list [OPTIONS]
Function

List DKubeX workspaces.
Options

Option

Description

--help

Shows help for this section

Option	Description
`--help`	Shows help for this section

`d3x llms`¶

Usage

d3x llms [OPTIONS] COMMAND [ARGS]...
Function

Set of commands to list and/or deploy the LLMs registered with DKubeX.
Options

Option

Description

--help

Shows help for this section
Commands

Command

Description

deploy

Deploy a LLM on DKubex

list

List the supported LLMs

register

Register a model with DKubeX

Option	Description
`--help`	Shows help for this section

Command	Description
`deploy`	Deploy a LLM on DKubex
`list`	List the supported LLMs
`register`	Register a model with DKubeX

Usage

d3x llms deploy [OPTIONS]
Function

Deploy a LLM on DKubeX
Options

Options

Description

-n, --name TEXT

Name of the deployment (required)

-m, --model TEXT

Name of the model to deploy the serving (required)

--help

Shows help for this section

Usage

d3x llms list [OPTIONS]
Function

List the supported LLMs.
Options

Options

Description

--help

Shows help for this section

Usage

d3x llms register [OPTIONS]
Function

Register a model with DKubeX
Options

Options

Description

-n, --name TEXT

Name of the model for registration (required)

-f, --file TEXT

raw GitHub URL of model definition in .yaml (required)

--help

Shows help for this section

`d3x mlflow`¶

Usage

d3x mlflow [OPTIONS] COMMAND [ARGS}...
Function

Set of commands pertaining to MLFlow experiments & models.
Options

Option

Description

--help

Shows help for this section
Commands

Command

Description

experiments

Create, archive, delete or restore MLFlow experiments

models

Archive or delete MLFlow models
- Usage
  
  d3x mlflow experiments [OPTIONS] COMMAND [ARGS]...
- Function
  
  Create, archive, delete or restore MLFlow experiments.
- Options
  
  Option
  
  Description
  
  --help
  
  Shows help for this section.
- Commands
  
  Command
  
  Description
  
  archive
  
  Archive Experiment
  
  delete
  
  Delete Experiment
  
  list
  
  List experiments
  
  restore
  
  Restore Experiment
Usage

d3x mlflow experiments archive [OPTIONS] ID

Function

Archive experiment.

Options

Option

Description

--help

Shows help for this section.
Usage

d3x mlflow experiments delete [OPTIONS] ID

Function

Delete experiment.

Options

Option

Description

--help

Shows help for this section.
Usage

d3x mlflow experiments list [OPTIONS]

Function

List experiments.

Options

Option

Description

--help

Shows help for this section.
Usage

d3x mlflow experiments restore [OPTIONS] ID

Function

Restore deleted experiments.

Options

Option

Description

--help

Shows help for this section.
- Usage
  
  d3x mlflow models [OPTIONS] COMMAND [ARGS]...
- Function
  
  The set of commands to archive or delete existing MLFlow models.
- Options
  
  Option
  
  Description
  
  --help
  
  Shows help for this section.
- Commands
  
  Command
  
  Description
  
  archive
  
  Archive Experiment
  
  delete
  
  Delete Experiment
Usage

d3x mlflow models archive [OPTIONS] NAME VERSION

Function

Archive the model.

Options

Option

Description

--help

Shows help for this section.
Usage

d3x mlflow models delete [OPTIONS] NAME VERSION

Function

Delete the model.

Options

Option

Description

--help

Shows help for this section.

`d3x models`¶

Usage

d3x models [OPTIONS] COMMAND [ARGS}...
Function

List and manage MLFlow models registry.
Options

Option

Description

--help

Shows help for this section
Commands

Command

Description

import

Import saved model to MLFlow

list

List models registered in MLFlow registry

show

Get details of a specific model

`d3x mount`¶

Usage

d3x mount [OPTIONS] [BUCKET] [MOUNTPATH]
Function

Command to mount an available S3 bucket in read-write model.
Options

Option

Description

-a, --all

mount all the previous buckets

-d, --dry-run

do not mount the buckets

--help

Shows help for this section

`d3x port-forward`¶

Usage

d3x port-forward [OPTIONS] WORKSPACE_NAME SERVICE TARGET_PORT LOCAL_PORT
Function

Forward port from any given DKubeX workspace to any specified remote system.
Options

Option

Description

--help

Shows help for this section

`d3x profile`¶

Usage

d3x profile [OPTIONS] COMMAND [ARGS]...
Function

Group for profile commands.
Options

Option

Description

--help

Shows help for this section
Commands

Command

Description

configure

Configure profile

delete

Delete profile

list

List profiles

set

Set default profile

`d3x ray`¶

Usage

d3x ray [OPTIONS] COMMAND [ARGS]...
Function

Set of commands pertaining to Ray Dashboard and Cluster(s).
Options

Option

Description

--help

Shows help for this section

Commands

Command	Description
`activate`	Set Cluster
`address`	List Ray clusters
`create`	Create Dev Ray cluster
`dashboard`	Open Ray dashboard
`delete`	Delete Dev Ray cluster
`get`	Get a Ray cluster
`job`	Group commands for ray jobs
`list`	List ray clusters

Usage

d3x ray activate [OPTIONS] CLUSTER
Function

Set Cluster.
Options

Option

Description

--help

Shows help for this section.

Usage

d3x ray address [OPTIONS]
Function

List Ray clusters and also show the Ray address to those clusters and link to its dashboard.
Options

Option

Description

--help

Shows help for this section.

--all

List all compute templates from all users.

Usage

d3x ray create [OPTIONS]

</div>
Function

Create dev Ray cluster.

Options

Option	Description
`--help`	Shows help for this section.
`-n, --name TEXT`	Name of the Ray cluster (Required)
`-v, --version TEXT`	Version of the Ray cluster (Default 2.6.0)
`-i, --image TEXT`	Image of the Ray head/worker node
`--cpu INTEGER`	Ray worker node CPU (Default 2)
`--gpu INTEGER`	Ray worker node GPU (Default 0)
`--memory INTEGER`	Ray worker node memory in GB (Default 4)
`--hcpu INTEGER`	Ray head node CPU (Default 2)
`--hgpu INTEGER`	Ray head node GPU (Default 0)
`--hmemory INTEGER`	Ray head node memory in GB (Default 4)
`--htype TEXT`	Ray worker head node instance type
`--type TEXT`	Ray worker node instance type
`--dockerserver TEXT`	Docker registry URL
`--dockeruser TEXT`	Docker registry username
`--dockerpsw TEXT`	Docker registry password

Usage

d3x ray dashboard [OPTIONS]
Function

Open Ray dashboard.
Options

Option

Description

--help

Shows help for this section.

Usage

d3x ray delete [OPTIONS] NAME
Function

Delete dev Ray cluster.
Options

Option

Description

--help

Shows help for this section.

Usage

d3x ray get [OPTIONS]
Function

Get a Ray cluster.
Options

Option

Description

--help

Shows help for this section.

Usage

d3x ray job [OPTIONS] COMMAND [ARGS]...
Function

Group commands for Ray jobs.
Options

Option

Description

--help

Shows help for this section.

Commands

Command	Description
`delete`	Deletes a stopped job and its associated data from memory.
`list`	Lists all running jobs and their information.
`logs`	Gets the logs of a job.
`status`	Queries for the current status of a job.
`stop`	Attempts to stop a job.
`submit`	Submits a job to be run on the cluster.

Usage

d3x ray job delete [OPTIONS] JOB_ID
Function

Deletes a stopped job and its associated data from memory. Only supported for jobs that are already in a terminal state. Fails with exit code 1 if the job is not already stopped. Does not delete job logs from disk. Submitting a job with the same submission ID as a previously deleted job is not supported and may lead to unexpected behavior.
Example

ray job delete #my_job_id#
PublicAPI

This API is in alpha and may change before becoming stable.

Options

Option	Description
`--help`	Shows help for this section.
`--address TEXT`	Address of the Ray cluster to connect to. Can also be specified using the RAY_ADDRESS environment variable.
`--verify BOOL \| TEXT`	Boolean indication to verify the server’s TLS certificate or a path to a file or directory of trusted certificates. [default: True]
`--log-style [auto\|record\|pretty]`	If ‘pretty’, outputs with formatting and color. If ‘record’, outputs record-style without formatting. ‘auto’ defaults to ‘pretty’, and disables pretty logging if stdin is not a TTY.
`--log-color [auto\|false\|true]`	Use color logging. Auto enables color logging if stdout is a TTY.
`-v`, `--verbose`

Usage

d3x ray job list [OPTIONS]
Function

Lists all running jobs and their information.
Example

ray job list
PublicAPI

This API is stable across releases.

Options

Option	Description
`--help`	Shows help for this section.
`--address TEXT`	Address of the Ray cluster to connect to. Can also be specified using the RAY_ADDRESS environment variable.
`--verify BOOL \| TEXT`	Boolean indication to verify the server’s TLS certificate or a path to a file or directory of trusted certificates. [default: True]
`--log-style [auto\|record\|pretty]`	If ‘pretty’, outputs with formatting and color. If ‘record’, outputs record-style without formatting. ‘auto’ defaults to ‘pretty’, and disables pretty logging if stdin is not a TTY.
`--log-color [auto\|false\|true]`	Use color logging. Auto enables color logging if stdout is a TTY.
`-v`, `--verbose`

Usage

d3x ray job logs [OPTIONS] JOB_ID
Function

Gets the logs of a job.
Example

ray job logs #my_job_id#
PublicAPI

This API is stable across Ray releases.

Options

Option	Description
`--help`	Shows help for this section.
`-f`, `--follow`	If set, follows the logs (like ‘tail -f’)
`--address TEXT`	Address of the Ray cluster to connect to. Can also be specified using the RAY_ADDRESS environment variable.
`--verify BOOL \| TEXT`	Boolean indication to verify the server’s TLS certificate or a path to a file or directory of trusted certificates. [default: True]
`--log-style [auto\|record\|pretty]`	If ‘pretty’, outputs with formatting and color. If ‘record’, outputs record-style without formatting. ‘auto’ defaults to ‘pretty’, and disables pretty logging if stdin is not a TTY.
`--log-color [auto\|false\|true]`	Use color logging. Auto enables color logging if stdout is a TTY.
`-v`, `--verbose`

Usage

d3x ray job status [OPTIONS] JOB_ID
Function

Queries for the current status of a job.
Example

ray job status #my_job_id#
PublicAPI

This API is stable across Ray releases.

Options

Option	Description
`--help`	Shows help for this section.
`--address TEXT`	Address of the Ray cluster to connect to. Can also be specified using the RAY_ADDRESS environment variable.
`--verify BOOL \| TEXT`	Boolean indication to verify the server’s TLS certificate or a path to a file or directory of trusted certificates. [default: True]
`--log-style [auto\|record\|pretty]`	If ‘pretty’, outputs with formatting and color. If ‘record’, outputs record-style without formatting. ‘auto’ defaults to ‘pretty’, and disables pretty logging if stdin is not a TTY.
`--log-color [auto\|false\|true]`	Use color logging. Auto enables color logging if stdout is a TTY.
`-v`, `--verbose`

Usage

d3x ray job stop [OPTIONS] JOB_ID
Function

Attempts to stop a job.
Example

ray job stop #my_job_id#
PublicAPI

This API is stable across Ray releases.

Options

Option	Description
`--help`	Shows help for this section.
`--no-wait`	If set, will not wait for the job to exit.
`--address TEXT`	Address of the Ray cluster to connect to. Can also be specified using the RAY_ADDRESS environment variable.
`--verify BOOL \| TEXT`	Boolean indication to verify the server’s TLS certificate or a path to a file or directory of trusted certificates. [default: True]
`--log-style [auto\|record\|pretty]`	If ‘pretty’, outputs with formatting and color. If ‘record’, outputs record-style without formatting. ‘auto’ defaults to ‘pretty’, and disables pretty logging if stdin is not a TTY.
`--log-color [auto\|false\|true]`	Use color logging. Auto enables color logging if stdout is a TTY.
`-v`, `--verbose`

Usage

d3x ray job submit [OPTIONS] ENTRYPOINT...
Function

Submits a job to be run on the cluster.
Example

ray job submit – python my_script.py –arg=val
PublicAPI

This API is stable across Ray releases.

Options

Option	Description
`--help`	Shows help for this section.
`--address TEXT`	Address of the Ray cluster to connect to. Can also be specified using the RAY_ADDRESS environment variable.
`--job-id TEXT`	DEPRECATED: Use –submission-id instead.
`--submission-id TEXT`	Submission ID to specify for the job. If not provided, one will be generated.
`--runtime-env TEXT`	Path to a local YAML file containing a runtime_env definition.
`--runtime-env-json TEXT`	JSON-serialized runtime_env dictionary.
`--working-dir TEXT`	Directory containing files that your job will run in. Can be a local directory or a remote URI to a .zip file (S3, GS, HTTP). If specified, this overrides the option in –runtime-env.
`--entrypoint-num-cpus FLOAT`	The quantity of CPU cores to reserve for the entrypoint command, separately from any tasks or actors that are launched by it
`--entrypoint-num-gpus FLOAT`	The quantity of GPUs to reserve for the entrypoint command, separately from any tasks or actors that are launched by it.
`--entrypoint-resources TEXT`	A JSON-serialized dictionary mapping resource name to resource quantity describing resources to reserve for the entrypoint command, separately from any tasks or actors that are launched by it.
`--no-wait`	If set, will not stream logs and wait for the job to exit.
`--verify BOOL \| TEXT`	Boolean indication to verify the server’s TLS certificate or a path to a file or directory of trusted certificates. [default: True]
`--log-style [auto\|record\|pretty]`	If ‘pretty’, outputs with formatting and color. If ‘record’, outputs record-style without formatting. ‘auto’ defaults to ‘pretty’, and disables pretty logging if stdin is not a TTY.
`--log-color [auto\|false\|true]`	Use color logging. Auto enables color logging if stdout is a TTY.
`-v`, `--verbose`

Usage

d3x ray list [OPTIONS]
Function

List Ray clusters.
Options

Option

Description

--help

Shows help for this section.

--all

List all compute templates from all users.

`d3x reset`¶

Usage

d3x reset [OPTIONS] WORKSPACE_NAME
Function

Reset any given DKubeX workspace to default image
Options

Option

Description

--help

Shows help for this section

`d3x scp`¶

Usage

d3x scp [OPTIONS] SOURCE TARGET
Function

Copy file(s)/directory from/to any given DKubeX workspace.
Options

Option

Description

--help

Shows help for this section

`d3x serve`¶

Usage

d3x serve [OPTIONS] COMMAND [ARGS]...
Function

Set of commands pertaining to Ray Serve
Options

Option

Description

--help

Shows help for this section

Commands

Command	Description
`create`	Create Ray serve
`delete`	Delete deployment
`get`	Get deployments
`list`	List deployments

Usage

d3x serve create [OPTIONS]
Function

Set of commands pertaining to Ray Serve.

Options

Option	Description
`--help`	Shows help for this section.
`-n`, `--name TEXT`	Name of the Ray serve (Required)
`-r`, `--registry_type [hugging_face\|mlflow]`	Registry type (Required)
`--hface_repoid TEXT`	Hugging Face Repo ID
`--hface_tokenizer TEXT`	Hugging Face tokenizer
`--hface_classifier TEXT`	Hugging Face classifier
`--hface_token TEXT`	Hugging Face token
`--model TEXT`	MLFlow model name
`--model_version TEXT`	MLFlow model version
`--depfilepath TEXT`	Ray serve deployment file path
`--working_dir TEXT`	Local serving directory path
`--is_private_repo`	Private repo
`--repo_name TEXT`	GitHub repo name
`--username TEXT`	GitHub username of the repo owner
`--access_token TEXT`	Github access token of the user
`--branch_name TEXT`	GitHub branch name
`--commit_id TEXT`	GitHub Commit ID
`--unprotected`	Serving without token
`-e`, `--env TEXT`	Environment variable
`--ngpus TEXT`	Number of GPUs
`--min_cpu TEXT`	Minimum number of CPUs for cluster creation.
`--max_cpu TEXT`	Maximum number of CPUs for cluster creation
`--min_memory TEXT`	Minimum memory for cluster creation
`--max_memory TEXT`	Maximum memory for cluster creation.
`--min_replicas TEXT`	Minimum deployment replicas.
`--max_replicas TEXT`	Maximum deployment replicas.
`--max_concurrent_requests TEXT`	Maximum concurrent requests.
`--description TEXT`	Deployment description
`--image TEXT`	Cluster Image
`--no_rsrc_limits`	No resource limits
`--node_selector TEXT`	Node selector
`--timeout INTEGER`	Deployment timeout

Usage

d3x serve delete [OPTIONS] ID
Function

Delete deployment.
Options

Option

Description

--help

Shows help for this section.

Usage

d3x serve get [OPTIONS] ID
Function

Get deployment.
Options

Option

Description

--help

Shows help for this section.

Usage

d3x serve list [OPTIONS]
Function

List deployments.
Options

Option

Description

--help

Shows help for this section.

--all

Lists all the deployments.

`d3x sky`¶

Usage

sky [OPTIONS] COMMAND [ARGS]...
Function

Set of commands pertaining to SkyPilot.

Options

Options	Description
`--install-shell-completion [bash\|zsh\|fish\|auto]`	Install shell completion for the specified shell.
`--uninstall-shell-completion [bash\|zsh\|fish\|auto]`	Uninstall shell completion for the specified shell.
`-v`, `--version`	Show sky version.
`-h`, `--help`	Shows help for this section

Commands

Commands	Description
`launch`	Launch a task from a YAML or a command (rerun setup if…
`exec`	Execute a task or a command on a cluster (skip setup).
`status`	Show clusters.
`cost-report`	Show estimated costs for launched clusters.
`queue`	Show the job queue for cluster(s).
`logs`	Tail the log of a job.
`cancel`	Cancel job(s).
`stop`	Stop cluster(s).
`autostop`	Schedule an autostop or autodown for cluster(s).
`start`	Restart cluster(s).
`down`	Tear down cluster(s).
`gpunode`	Launch or attach to an interactive GPU node.
`cpunode`	Launch or attach to an interactive CPU node.
`tpunode`	Launch or attach to an interactive TPU node.
`check`	Check which clouds are available to use.
`show-gpus`	Show supported GPU/TPU/accelerators and their prices.
`storage`	SkyPilot Storage CLI.
`admin`	SkyPilot On-prem administrator CLI.
`spot`	Managed Spot commands (spot instances with auto-recovery).
`bench`	SkyPilot Benchmark CLI.

`d3x ssh`¶

Usage

d3x ssh [OPTIONS] WORKSPACE_NAME [COMMAND]...
Function

SSH to any given DKubeX workspace.
Options

Option

Description

--help

Shows help for this section

`d3x ssh-copy-id`¶

Usage

d3x ssh-copy-id [OPTIONS] PUBLIC_KEY
Function

Copy SSH public key to your DKubeX home.
Options

Option

Description

--help

Shows help for this section

`d3x start`¶

Usage

d3x start [OPTIONS] WORKSPACE_NAME
Function

Start any given DKubeX workspace.
Options

Option

Description

--help

Shows help for this section

`d3x stop`¶

Usage

d3x stop [OPTIONS] WORKSPACE_NAME
Function

Stop any given DKubeX workspace.
Options

Option

Description

--help

Shows help for this section

`d3x top`¶

Usage

d3x top [OPTIONS] [WORKSPACE]
Function

Show the workspace’s resource usage.
Options

Option

Description

--help

Shows help for this section

`d3x umount`¶

Usage

d3x umount [OPTIONS] MOUNTPATH
Function

Unmount buckets that were previously mounted using the mount command.
Options

Option

Description

--help

Shows help for this section

`d3x version`¶

Usage

d3x version [OPTIONS]
Function

DKubeX version.
Options

Option

Description

--help

Shows help for this section

`d3x vnc`¶

Usage

d3x vnc [OPTIONS] WORKSPACE_NAME
Function

VNC connection to any given DKubeX workspace.
Options

Option

Description

--help

Shows help for this section

Options	Description
`-n`, `--name TEXT`	Name of the deployment (required)
`-m`, `--model TEXT`	Name of the model to deploy the serving (required)
`--help`	Shows help for this section

Options	Description
`-n`, `--name TEXT`	Name of the model for registration (required)
`-f`, `--file TEXT`	raw GitHub URL of model definition in .yaml (required)
`--help`	Shows help for this section

Command	Description
`experiments`	Create, archive, delete or restore MLFlow experiments
`models`	Archive or delete MLFlow models

Command	Description
`archive`	Archive Experiment
`delete`	Delete Experiment
`list`	List experiments
`restore`	Restore Experiment

Command	Description
`import`	Import saved model to MLFlow
`list`	List models registered in MLFlow registry
`show`	Get details of a specific model

Option	Description
`-a`, `--all`	mount all the previous buckets
`-d`, `--dry-run`	do not mount the buckets
`--help`	Shows help for this section

Command	Description
`configure`	Configure profile
`delete`	Delete profile
`list`	List profiles
`set`	Set default profile

Option	Description
`--help`	Shows help for this section.
`--all`	List all compute templates from all users.

d3x Commands¶

d3x about¶

d3x apikey¶

d3x apps¶

d3x code¶

d3x fm¶

d3x list¶

d3x llms¶

d3x login¶

d3x mlflow¶

d3x models¶

d3x mount¶

d3x port-forward¶

d3x profile¶

d3x ray¶

d3x reset¶

d3x scp¶

d3x serve¶

d3x sky¶

d3x ssh¶

d3x ssh-copy-id¶

d3x start¶

d3x stop¶

d3x top¶

d3x umount¶

d3x version¶

d3x vnc¶

`d3x about`¶

`d3x apikey`¶

`d3x apps`¶

`d3x code`¶

`d3x fm`¶

`d3x list`¶

`d3x llms`¶

`d3x login`¶

`d3x mlflow`¶

`d3x models`¶

`d3x mount`¶

`d3x port-forward`¶

`d3x profile`¶

`d3x ray`¶

`d3x reset`¶

`d3x scp`¶

`d3x serve`¶

`d3x sky`¶

`d3x ssh`¶

`d3x ssh-copy-id`¶

`d3x start`¶

`d3x stop`¶

`d3x top`¶

`d3x umount`¶

`d3x version`¶

`d3x vnc`¶