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]...
d3x --help
Function¶
Group for d3x commands.
Options¶
Option |
Description |
|---|---|
|
enable requests debugging. |
|
cluster profile |
|
Show help for the command.. |
Commands¶
Command |
Description |
|---|---|
|
Details about d3x CLI configuration. |
|
Commands to generate and get DKubeX API keys. |
|
Commands regarding creating and managing user-defined applications. |
|
Commands for backing up datasets. |
|
Start local VSCode and connect to DKubeX workspace. |
|
Commands for creating, managing and using datasets. |
|
Commands regarding using foundation models. |
|
List DKubeX workspaces. |
|
Commands regarding using LLMs. |
|
Login to DKubeX with particular user profile in the CLI. |
|
Commands for using and managing experiments and models in MLFlow from CLI. |
|
List & Manage MLFlow models registry. |
|
Mount S3 bucket in read/write mode. |
|
Forward port from workspace to local computer. |
|
Commands regarding user profiles in DKubeX. |
|
Commands regarding Ray jobs and Ray clusters. |
|
Reset given workspace to default image |
|
Commands for restoring databases. |
|
Copy files(s)/directory from/to DKubeX workspace. |
|
Commands for creating model deployments. |
|
Commands for managing SkyPilot clusters, resources and jobs. |
|
SSH to DKubeX workspace. |
|
Copy ssh public key to DKubeX user’s home. |
|
Start given workspace. |
|
Start given workspace app. |
|
Stop given workspace. |
|
Stop given workspace app. |
|
Commands regarding using Tensorboard. |
|
Show workspace resource usage. |
|
Unmount bucket previously mounted using |
|
Show DKubeX version. |
|
VNC connection to DKubeX workspace. |
d3x about¶
Usage
d3x about [OPTIONS]d3x about --helpFunction
Details about d3x CLI config
Options
Option
Description
-o,--output [yaml|json]output format (supported- json, yaml)
--helpShow help for the command..
d3x apikey¶
Usage
d3x apikey [OPTIONS] COMMAND [ARGS]...d3x apikey --helpFunction
Commands to generate and get DKubeX API keys.
Options
Option
Description
--helpShow help for the command..
Commands
Command
Description
generateGenerate new user API key
getGet current user API key
Usage
d3x apikey generate [OPTIONS]d3x apikey generate --helpFunction
Generate new user API key.
Options
Option
Description
-o,--output [yaml|json]output format (supported- json, yaml)
--helpShow help for the command..
Usage
d3x apikey get [OPTIONS]d3x apikey get --helpFunction
Get current user API key.
Options
Option
Description
-o,--output [yaml|json]output format (supported- json, yaml)
--helpShow help for the command..
d3x apps¶
Usage
d3x apps [OPTIONS] COMMAND [ARGS]...d3x apps --helpFunction
Commands regarding creating and managing user-defined applications.
Options
Option
Description
--helpShow help for the command..
Commands
Command
Description
createLaunch user-defined application on DKubeX
deleteDelete user-defined application
listList user-defined applications
openOpen user-defined application in browser
Usage
d3x apps create [OPTIONS] [COMMAND]...d3x apps create --helpFunction
Launch user-defined application on DKubeX.
Options
Option
Description
-c,--config TEXTPath to the YAML configuration file [required]
--helpShow help for the command..
Usage
d3x apps delete [OPTIONS] NAMEd3x apps delete --helpFunction
Delete user-defined applications.
Options
Option
Description
-o,--output [yaml|json]supported only json,yaml
--helpShow help for the command..
Usage
d3x apps list [OPTIONS]d3x apps list --helpFunction
List user apps.
Options
Option
Description
-o,--output [yaml|json]supported only json,yaml
--helpShow help for the command..
Usage
d3x apps open [OPTIONS] NAMEd3x apps open --helpFunction
Open user app in browser.
Options
Option
Description
--helpShow help for the command..
d3x backup¶
Usage
d3x backup [OPTIONS] COMMAND [ARGS]...d3x backup --helpFunction
Commands for backing up datasets.
Options
Option
Description
--helpShow help for the command..
Commands
Command
Description
weaviatecommand for weaviate backup
Usage
d3x backup weaviate [OPTIONS]d3x backup weaviate --helpFunction
Command for dataset backup to Weaviate.
Options
Option
Description
-d,--dataset TEXTA name to represent the ingested docs [required]
-i,--id TEXTAn ID for the backup [required]
-b,--backend [filesystem|s3]s3 or filesystem to save the backup [required]
--helpShow help for the command..
d3x code¶
Usage
d3x code [OPTIONS] WORKSPACE_NAMEd3x code --helpFunction
Start local VSCode and connect to DKubeX workspace
Options
Option
Description
--helpShow help for the command..
d3x dataset¶
Usage
d3x dataset [OPTIONS] COMMAND [ARGS]...d3x dataset --helpFunction
Commands for creating, managing and using datasets.
Options
Option
Description
--helpShow help for the command..
Commands
Command
Description
deleteDeletes specified dataset if present from the database
evaluateRun evaluation pipeline over the given dataset.
ingestIngest the documents from provided source into the database.
listlists all the datasets present in database
queryQuery over documents using the selected pipeline.
showshows documents present in the specified dataset
Usage
d3x dataset delete [OPTIONS] DATASETd3x dataset delete --helpFunction
Deletes specified dataset if present from the database
Options
Option
Description
--helpShow help for the command..
Usage
d3x dataset evaluate [OPTIONS]d3x dataset evaluate --helpFunction
Run evaluation pipeline over the given dataset.
Options
Option
Description
-d,--dataset TEXTDataset on which the queries should be applied. [required]
-p,--pipeline TEXTRAG pipeline to be used.
-c,--config TEXTUser configuration for pipeline stages
-s,--remote-skyIf the ingestion should be scheduled on remote sky cluster.
-m,--remote-command TEXTsky/ray job command to run.
--dkubex-url TEXTURL of the dkubex for the remote clusters to reach.
-k,--dkubex-apikey TEXTAPI key for remote clusters to reach dkubex.
--helpShow help for the command..
Usage
d3x dataset ingest [OPTIONS]d3x dataset ingest --helpFunction
Ingest the documents from provided source into the vectorstore identified by given dataset name.
Note
SUPPORTED EXTRA OPTIONS: Make use of the options below to overwrite the individual values without need to copy config file.
--embedder.class=[HuggingfaceEmbedding/OpenAIEmbedding] --embedder.model=<embedding-model-name-for-the-above-class>
Options
Option
Description
-d,--dataset TEXTA name to represent the ingested docs [required]
-p,--pipeline TEXTIngestion pipeline to be used.
-c,--config TEXTUser configuration for pipeline stages
-s,--remote-skyIf the ingestion should be scheduled on remote sky cluster.
-r,--remote-rayIf the ingestion should be scheduled on remote ray cluster.
-m,--remote-command TEXTsky/ray job command to run.
--dkubex-url TEXTURL of the dkubex for the remote clusters to reach.
-k,--dkubex-apikey TEXTAPI key for remote clusters to reach dkubex.
-w,--num-workers INTEGERNumber of process to use for parallelization.
--helpShow help for the command..
Usage
d3x dataset list [OPTIONS]d3x dataset list --helpFunction
Lists all the datasets present in database
Options
Option
Description
--helpShow help for the command..
Usage
d3x dataset query [OPTIONS]d3x dataset query --helpFunction
Query over documents using the selected pipeline.
Note
SUPPORTED EXTRA OPTIONS: Make use of the options below to overwrite the individual values without need to copy config file.
--vectorstore_retriever.embedding_class=[HuggingfaceEmbedding/OpenAIEmbedding] --vectorstore_retriever.embedding_model= --vectorstore_retriever.top_k= --chat_engine.llm=[openai/dkubex] --chat_engine.url=<dkubex-dep-url> --chat_engine.llmkey=<llm-access-key> --chat_engine.max_tokens
Options
Option
Description
-d,--dataset TEXTDataset on which the question should be applied. [required]
-p,--pipeline TEXTRAG pipeline to be used.
-c,--config TEXTUser configuration for pipeline stages
-q,--question TEXTUser query to run through the pipeline
-b,--batch TEXTBatch of questions to run through the pipeline
-i,--interactiveRun this tool in cli mode
-k,--conversation TEXTName of the conversation to track all the questions for.
--helpShow help for the command..
Usage
d3x dataset show [OPTIONS]d3x dataset show --helpFunction
Shows documents present in the specified dataset
Options
Option
Description
-d,--dataset TEXTDataset name to list all the docs present in it [required]
--helpShow help for the command.
d3x fm¶
Usage
d3x fm [OPTIONS] COMMAND [ARGS]...d3x fm --helpFunction
Commands regarding using foundation models.
Options
Option
Description
--helpShow help for the command..
Commands
Command
Description
deleteDelete FM job.
getGet FM job details.
jobsList FM jobs.
logsShow logs of given FM job.
trainchunksCreate train and/or test chunks for finetuning.
tuneLLM Finetuning process related commands.
Usage
d3x fm delete [OPTIONS] JOB_NAMEd3x fm delete --helpFunction
Delete FM job.
Options
Option
Description
--helpShow help for the command..
Usage
d3x fm get [OPTIONS] JOB_NAMEd3x fm get --helpFunction
Get FM job details.
Options
Option
Description
--helpShow help for the command..
Usage
d3x fm jobs [OPTIONS]d3x fm jobs --helpFunction
List FM jobs.
Options
Option
Description
--helpShow help for the command..
Usage
d3x fm logs [OPTIONS] JOB_NAMEd3x fm logs --helpFunction
Show logs of given FM job.
Options
Option
Description
--helpShow help for the command..
Usage
d3x fm trainchunks [OPTIONS]d3x fm trainchunks --helpFunction
Create train and/or test chunks for finetuning.
Options
Option
Description
-s,--source TEXTThe path where finetune chunks are sourced from [required]
-d,--destination TEXTThe path where chunks will be kept for training [required]
--split [train|test]specify train or test. Default: both
-p,--split-percent INTEGERspecify percentage of docs to go in train/test
-l,--lastpick documents from backwards
--helpShow help for the command..
Usage
d3x fm tune [OPTIONS] COMMAND [ARGS]...d3x fm tune --helpFunction
LLM Finetuning process related commands.
Options
Option
Description
--helpShow help for the command..
Commands
Command
Description
modelCommands regarding model finetuning.
Usage
d3x fm tune model [OPTIONS] COMMAND [ARGS]...d3x fm tune model --helpFunction
Commands regarding model finetuning.
Options
Option
Description
--helpShow help for the command..
Commands
Command
Description
finetuneCommand to finetune a model.
mergeCommand to merge finetuned models.
quantizeCommand to quantize a model.
Usage
d3x fm tune model finetune [OPTIONS]d3x fm tune model finetune --helpFunction
Command to finetune a model.
Options
Option
Description
-j,--job-name TEXTjob name
-d,--docker-image TEXTdocker image for the ray job
-e,--epochs INTEGERnumber of epochs
-b,--batch-size INTEGERbatch size
-l,--dataset-location TEXTdataset location
-o,--output-location TEXToutput location
-n,--model-name TEXTmodel name(should contain complete hf path meta-llama/Llama-2-13b-chat-hf)
-p,--model-path TEXTdownloaded model location from huggingface
-h,--hf-token TEXThuggingface token
-c,--cpu INTEGERnumber of cpu
-g,--gpu INTEGERnumber of gpu
-t,--type TEXTinstance type
-m,--mem INTEGERnumber of memories
--as-testAs test
--stop-perplexity FLOATTarget perplexity to reach after which to stop training. Default is 0. If 0, training will not stop on perplexity.
--ctx-len INTEGERLearning rate to use.
--experiment-name TEXTmlflow experiment name
--helpShow help for the command..
Usage
d3x fm tune model merge [OPTIONS]d3x fm tune model merge --helpFunction
Command to merge finetuned models.
Options
Option
Description
-j,--job-name TEXTray cluster name
-d,--docker-image TEXTdocker image for the ray job
-o,--output-path TEXTPath to output directory. Defaults to the orginal checkpoint directory.
-n,--model-name TEXTmodel name(should contain complete hf path meta-llama/Llama-2-13b-chat-hf)
-p,--model-path TEXTdownloaded model location from huggingface
-cp,--checkpoint TEXTPath to checkpoint containing the LoRA weights.
-c,--cpu INTEGERnumber of cpu
-m,--mem INTEGERcpu memory
-g,--gpu INTEGERnumber of gpus
-t,--type TEXTinstance type
--helpShow help for the command..
Usage
d3x fm tune model quantize [OPTIONS]d3x fm tune model quantize --helpFunction
Command to quantize a model.
Options
Option
Description
-j,--job-name TEXTray cluster name [required]
-d,--docker-image TEXTdocker image for the ray job
-p,--model-path TEXTmerged model path [required]
-o,--output-path TEXTPath to output directory [required]
-c,--cpu INTEGERnumber of cpu
-m,--mem INTEGERcpu memory
-g,--gpu INTEGERnumber of gpu
-t,--type TEXTinstance type
--helpShow help for the command..
d3x list¶
Usage
d3x list [OPTIONS]d3x list --helpFunction
List d3x workspaces
Options
Option
Description
-o,--output [yaml|json]supported only json,yaml
--helpShow help for the command..
d3x llms¶
Usage
d3x llms [OPTIONS] COMMAND [ARGS]...d3x llms --helpFunction
Commands regarding using LLMs.
Options
Option
Description
--helpShow help for the command..
Commands
Command
Description
deployDeploy a LLM on dkubex.
listList the supported LLMs
Usage
d3x llms deploy [OPTIONS]d3x llms deploy --helpFunction
Deploy a LLM on dkubex.
Options
Option
Description
-n,--name TEXTname of the deployment [required]
-m,--model TEXTname or path of the model to deploy for serving
--base_model TEXTbase model name
--token TEXThugging face token
--config TEXTgithub raw content url or local config path
--mlflow TEXTname of the mlflow registered model along with version (example: diffusion:1)
--image TEXTcustomized docker image for llm deployment
--type TEXTinstance type
--min_replicas TEXTminimum replicas
--max_replicas TEXTmaximum replicas
--publishpublish the deployment
-o,--output [yaml|json]supported only json,yaml
-sky,--remote-skyIf the model should be deployed on remote sky cluster.
--sky-accelerator TEXTaccelerator for remote sky cluster
-k,--dkubex-apikey TEXTAPI key for remote clusters to reach dkubex.
--sky-yaml TEXTPath to custom yaml file for sky serve.
--helpShow help for the command..
Usage
d3x llms list [OPTIONS]d3x llms list --helpFunction
List the supported LLMs
Options
Option
Description
-o,--output [yaml|json]supported only json,yaml
--helpShow help for the command..
d3x login¶
Usage
d3x login [OPTIONS]d3x login --helpFunction
Login to DKubeX with particular user profile in the CLI.
Options
Option
Description
--helpShow help for the command..
d3x mlflow¶
Usage
d3x mlflow [OPTIONS] COMMAND [ARGS]...d3x mlflow --helpFunction
Commands for using and managing experiments and models in MLFlow from CLI.
Options
Option
Description
--helpShow help for the command..
Commands
Command
Description
experimentsCommands for managing experiments in MLFlow.
modelsCommands for managing models in MLFlow.
Usage
d3x mlflow experiments [OPTIONS] COMMAND [ARGS]...d3x mlflow experiments --helpFunction
Commands for managing experiments in MLFlow.
Options
Option
Description
--helpShow help for the command..
Commands
Command
Description
archiveArchive experiment in MLFlow
deleteDelete experiment in MLFlow
listList experiments in MLFlow
restoreRestore experiment in MLFlow
Usage
d3x mlflow experiments archive [OPTIONS] IDd3x mlflow experiments archive --helpFunction
Archive experiment in MLFlow.
Options
Option
Description
--helpShow help for the command..
Usage
d3x mlflow experiments delete [OPTIONS] IDd3x mlflow experiments delete --helpFunction
Delete experiment in MLFlow.
Options
Option
Description
--helpShow help for the command..
Usage
d3x mlflow experiments list [OPTIONS]d3x mlflow experiments list --helpFunction
List experiments in MLFlow.
Options
Option
Description
--helpShow help for the command..
Usage
d3x mlflow experiments restore [OPTIONS] IDd3x mlflow experiments restore --helpFunction
Restore experiment in MLFlow.
Options
Option
Description
--helpShow help for the command..
Usage
d3x mlflow models [OPTIONS] COMMAND [ARGS]...d3x mlflow models --helpFunction
Commands for managing models in MLFlow.
Options
Option
Description
--helpShow help for the command..
Commands
Command
Description
archiveArchive model in MLFlow
deleteDelete model in MLFlow
Usage
d3x mlflow models archive [OPTIONS] NAME VERSIONd3x mlflow models archive --helpFunction
Archive model in MLFlow.
Options
Option
Description
--helpShow help for the command..
Usage
d3x mlflow models delete [OPTIONS] NAME VERSIONd3x mlflow models delete --helpFunction
Delete model in MLFlow.
Options
Option
Description
--helpShow help for the command..
d3x models¶
Usage
d3x models [OPTIONS] COMMAND [ARGS]...d3x models --helpFunction
List & Manage MLFlow models registry.
Options
Option
Description
--helpShow help for the command..
Commands
Command
Description
importImport saved model to MLFlow.
listList models registered in MLFlow.
Usage
d3x models import [OPTIONS] NAME {pytorch|tensorflow|sklearn|xgboost|custom_model} SAVED_MODEL_PATHd3x models import --helpFunction
Import saved model to MLFlow.
Options
Option
Description
--class_path TEXTpytorch class file path
--class_instance TEXTclass instance
-o,--output [yaml|json]supported only json,yaml
--helpShow help for the command..
Usage
d3x models list [OPTIONS]d3x models list --helpFunction
List models registered in MLFlow registry.
Options
Option
Description
-o,--output [yaml|json]supported only json,yaml
--helpShow help for the command..
d3x mount¶
Usage
d3x mount [OPTIONS] [BUCKET] [MOUNTPATH]d3x mount --helpFunction
Mount S3 bucket in read/write mode.
Options
Option
Description
-a,--allMounts all the previous buckets.
-d,--dry-runRuns a dry run of mounting bucket, does not mount the buckets.
--helpShow help for the command..
d3x port-forward¶
Usage
d3x port-forward [OPTIONS] WORKSPACE_NAME SERVICE TARGET_PORT LOCAL_PORTd3x port-forward --helpFunction
Forward port from workspace to local computer.
Options
Option
Description
--helpShow help for the command..
d3x profile¶
Usage
d3x profile [OPTIONS] COMMAND [ARGS]...d3x profile --helpFunction
Commands regarding user profiles in DKubeX.
Options
Option
Description
--helpShow help for the command..
Commands
Command
Description
configureConfigure user profile.
deleteDelete user profile.
listList user profiles.
setSet default user profile.
Usage
d3x profile configure [OPTIONS]d3x profile configure --helpFunction
Configure user profile.
Options
Option
Description
--helpShow help for the command..
Usage
d3x profile delete [OPTIONS] PROFILEd3x profile delete --helpFunction
Delete user profile.
Options
Option
Description
-o,--output [yaml|json]supported only json,yaml
--helpShow help for the command..
Usage
d3x profile list [OPTIONS]d3x profile list --helpFunction
List user profiles.
Options
Option
Description
-o,--output [yaml|json]supported only json,yaml
--helpShow help for the command..
Usage
d3x profile set [OPTIONS] PROFILEd3x profile set --helpFunction
Set default user profile.
Options
Option
Description
-o,--output [yaml|json]supported only json,yaml
--helpShow help for the command..
d3x ray¶
Usage
d3x ray [OPTIONS] COMMAND [ARGS]...d3x ray --helpFunction
Commands regarding Ray jobs and Ray clusters.
Options
Option
Description
--helpShow help for the command..
Commands
Command
Description
activateSet Ray cluster as active cluster.
addressList Ray clusters along with their cluster Ray address.
createCreate Ray cluster.
dashboardOpen Ray dashboard.
deleteDelete Ray cluster.
getGet a Ray cluster.
jobCommands regarding managing Ray jobs in currently active Ray cluster.
listList Ray clusters.
Usage
d3x ray activate [OPTIONS] CLUSTERd3x ray activate --helpFunction
Set Ray cluster as active cluster.
Options
Option
Description
-o,--output [yaml|json]supported only json,yaml
--helpShow help for the command..
Usage
d3x ray address [OPTIONS]d3x ray address --helpFunction
List Ray clusters along with their cluster Ray address.
Options
Option
Description
--allList all compute templates from all users
-o,--output [yaml|json]supported only json,yaml
--helpShow help for the command..
Usage
d3x ray create [OPTIONS]d3x ray create --helpFunction
Create Ray cluster.
Options
Option
Description
-n,--name TEXTname of the ray cluster [required]
-v,--version TEXTversion of the ray cluster (default 2.8.0)
-i,--image TEXTimage of ray head/worker node
--cpu INTEGERray worker node CPU (default 2)
--gpu INTEGERray worker node GPU (default 0)
--memory INTEGERray worker node memory in GB (default 4)
--hcpu INTEGERray head node CPU (default 2)
--hgpu INTEGERray head node GPU (default 0)
--hmemory INTEGERray head node memory in GB (default 4)
--htype TEXTray worker head node instance type
--type TEXTray worker node instance type
--dockerserver TEXTdocker registry url
--dockeruser TEXTdocker registry username
--dockerpsw TEXTdocker registry password
-o,--output [yaml|json]supported only json,yaml
--helpShow help for the command..
Usage
d3x ray dashboard [OPTIONS]d3x ray dashboard --helpFunction
Open Ray dashboard.
Options
Option
Description
--helpShow help for the command..
Usage
d3x ray delete [OPTIONS] NAMEd3x ray delete --helpFunction
Delete Ray cluster.
Options
Option
Description
-o,--output [yaml|json]supported only json,yaml
--helpShow help for the command..
Usage
d3x ray get [OPTIONS]d3x ray get --helpFunction
Get a Ray Cluster.
Options
Option
Description
-o,--output [yaml|json]supported only json,yaml
--helpShow help for the command..
Usage
d3x ray job [OPTIONS] COMMAND [ARGS]...d3x ray job --helpFunction
Commands regarding managing Ray jobs in currently active Ray cluster.
Options
Option
Description
--helpShow help for the command..
Commands
Command
Description
deleteDeletes a stopped job and its associated data from memory.
listLists all running jobs and their information.
logsGets the logs of a job.
showQueries for show details of job.
statusQueries for the current status of a job.
stopAttempts to stop a job.
submitSubmits a job to be run on the cluster.
Usage
d3x ray job delete [OPTIONS] JOB_IDd3x ray job delete --helpFunction
Deletes a stopped job and its associated data from memory.
Note
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.
PublicAPI (alpha): This API is in alpha and may change before becoming stable.
Options
Option
Description
--address TEXTAddress of the Ray cluster to connect to. Can also be specified using the RAY_ADDRESS environment variable.
--verify BOOL | TEXTBoolean indication to verify the server’s TLS certificate or a path to a file or directory of trusted certificates. [default: True]
--headers TEXTUsed to pass headers through http/s to the Ray Cluster. Please follow JSON formatting.
--log-style [auto|record|pretty]If ‘pretty’, outputs with formatting and color. If ‘record’, outputs record-style ‘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,--verboseActivates verbose logging.
--helpShow help for the command..
Usage
d3x ray job list [OPTIONS]d3x ray job list --helpFunction
Lists all running jobs and their information.
Options
Option
Description
--address TEXTAddress of the Ray cluster to connect to. Can also be specified using the RAY_ADDRESS environment variable.
--verify BOOL | TEXTBoolean indication to verify the server’s TLS certificate or a path to a file or directory of trusted certificates. [default: True]
--headers TEXTUsed to pass headers through http/s to the Ray Cluster. Please follow JSON formatting.
--log-style [auto|record|pretty]If ‘pretty’, outputs with formatting and color. If ‘record’, outputs record-style ‘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,--verboseActivates verbose logging.
-o,--output [yaml|json]supported only json,yaml
--helpShow help for the command..
Usage
d3x ray job logs [OPTIONS] JOB_IDd3x ray job logs --helpFunction
Gets the logs of a job.
Options
Option
Description
--address TEXTAddress of the Ray cluster to connect to. Can also be specified using the RAY_ADDRESS environment variable.
-f,--followIf set, follow the logs (like tail -f).
--verify BOOL | TEXTBoolean indication to verify the server’s TLS certificate or a path to a file or directory of trusted certificates. [default: True]
--headers TEXTUsed to pass headers through http/s to the Ray Cluster. Please follow JSON formatting.
--log-style [auto|record|pretty]If ‘pretty’, outputs with formatting and color. If ‘record’, outputs record-style ‘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,--verboseActivates verbose logging.
--helpShow help for the command..
Usage
d3x ray job show [OPTIONS] JOB_IDd3x ray job show --helpFunction
Queries for show details of job.
Options
Option
Description
-o,--output [yaml|json]supported only json,yaml
--helpShow help for the command..
Usage
d3x ray job status [OPTIONS] JOB_IDd3x ray job status --helpFunction
Queries for the current status of a job.
Options
Option
Description
--address TEXTAddress of the Ray cluster to connect to. Can also be specified using the RAY_ADDRESS environment variable.
--verify BOOL | TEXTBoolean indication to verify the server’s TLS certificate or a path to a file or directory of trusted certificates. [default: True]
--headers TEXTUsed to pass headers through http/s to the Ray Cluster. Please follow JSON formatting.
--log-style [auto|record|pretty]If ‘pretty’, outputs with formatting and color. If ‘record’, outputs record-style ‘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,--verboseActivates verbose logging.
--helpShow help for the command..
Usage
d3x ray job stop [OPTIONS] JOB_IDd3x ray job stop --helpFunction
Attempts to stop a job.
Options
Option
Description
--address TEXTAddress of the Ray cluster to connect to. Can also be specified using the RAY_ADDRESS environment variable.
--no-waitIf set, will not wait for the job to exit.
--verify BOOL | TEXTBoolean indication to verify the server’s TLS certificate or a path to a file or directory of trusted certificates. [default: True]
--headers TEXTUsed to pass headers through http/s to the Ray Cluster. Please follow JSON formatting.
--log-style [auto|record|pretty]If ‘pretty’, outputs with formatting and color. If ‘record’, outputs record-style ‘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,--verboseActivates verbose logging.
--helpShow help for the command..
Usage
d3x ray job submit [OPTIONS] ENTRYPOINT...d3x ray job submit --helpFunction
Submits a job to be run on the cluster.
Options
Option
Description
--address TEXTAddress of the Ray cluster to connect to. Can also be specified using the RAY_ADDRESS environment variable.
--job-id TEXTDEPRECATED: Use –submission-id instead.
--submission-id TEXTSubmission ID to specify for the job. If not provided, one will be generated.
--runtime-env TEXTPath to a local YAML file containing a runtime_env definition.
--runtime-env-json TEXTJSON-serialized runtime_env dictionary.
--working-dir TEXTDirectory 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.
--metadata-json TEXTJSON-serialized dictionary of metadata to attach to the job.
--entrypoint-num-cpus FLOATthe quantity of CPU cores to reserve for the entrypoint command, separately from any tasks or actors that are launched by it
--entrypoint-num-gpus FLOATthe quantity of GPUs to reserve for the entrypoint command, separately from any tasks or actors that are launched by it
--entrypoint-resources TEXTa 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-waitIf set, will not stream logs and wait for the job to exit.
--verify BOOL | TEXTBoolean indication to verify the server’s TLS certificate or a path to a file or directory of trusted certificates. [default: True]
--headers TEXTUsed to pass headers through http/s to the Ray Cluster. Please follow JSON formatting
--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,--verboseActivates verbose logging.
--helpShow help for the command..
Usage
d3x ray list [OPTIONS]d3x ray list --helpFunction
List Ray Clusters
Options
Option
Description
--allList all compute templates from all users
-o,--output [yaml|json]supported only json,yaml
--helpShow help for the command..
d3x reset¶
Usage
d3x reset [OPTIONS]d3x reset --helpFunction
Reset given workspace to default image.
Options
Option
Description
--helpShow help for the command..
d3x restore¶
Usage
d3x restore [OPTIONS] COMMAND [ARGS]...d3x restore --helpFunction
Commands for restoring databases.
Options
Option
Description
--helpShow help for the command..
Commands
Command
Description
weaviateCommand for Weaviate restore.
Usage
d3x restore weaviate [OPTIONS]d3x restore weaviate --helpFunction
Command for Weaviate restore.
Options
Option
Description
-i,--id TEXTAn ID for the backup [required]
-b,--backend [filesystem|s3]s3 or filesystem to save the backup [required]
--helpShow help for the command..
d3x scp¶
Usage
d3x scp [OPTIONS] SOURCE TARGETd3x scp --helpFunction
Copy files(s)/directory from/to DKubeX workspace.
Options
Option
Description
--helpShow help for the command..
d3x serve¶
Usage
d3x serve [OPTIONS] COMMAND [ARGS]...d3x serve --helpFunction
Commands for creating model deployments.
Options
Option
Description
--helpShow help for the command..
Commands
Command
Description
createCreate deployment
deleteDelete deployment
getGet Deployment
listList Deployments
statusCheck deployment Status
Usage
d3x serve create [OPTIONS]d3x serve create --helpFunction
Create deployment.
Options
Option
Description
-n,--name TEXTname of the ray serve [required]
-r,--registry_type [hugging_face|mlflow|local|none]registry type [required]
--hface_repoid TEXThugging face repo id
--hface_tokenizer TEXThugging face tokenizer
--hface_classifier TEXThugging face classifier
--hface_token TEXThugging face token
--model TEXTmlflow model name
--model_version TEXTmlflow model version
--depfilepath TEXTdeployment filepath
--working_dir TEXTlocal serving directory path
--is_private_repoprivate repo
--repo_name TEXTgithub repo name
--repo_org TEXTgithub personal/organization account
--access_token TEXTgithub access token
--branch_name TEXTgithub branch name
--commit_id TEXTgithub commit id
--unprotectedserving without token
-e,--env TEXTenvironment variable
--ngpus TEXTnumber of gpus
--min_cpu TEXTmin number of cpus for cluster creation
--max_cpu TEXTmax number of cpus per cluster creation
--min_memory TEXTmin memory for cluster cluster creation
--max_memory TEXTmax memory for cluster cluster creation
--min_replicas TEXTmin deployment replicas
--max_replicas TEXTmax deployment replicas
--max_concurrent_requests TEXTmax concurrent requests
--description TEXTdeployment description
--image TEXTcluster image
--publishpublish the deployment
--no_rsrc_limitsno resource limits
--type TEXTnode selector
--timeout INTEGERdeployment timeout
--kserveenable kserve deployment
--model_format [tensorflow|sklearn|pytorch|xgboost|pmml|lightgbm|paddle|mlflow|custom]model format in case of kserve deployment
--model_path TEXTlocal path of model for kserve deployment
--protocol_version [v1|v2]dataplane protocol
-o,--output [yaml|json]supported only json,yaml
--helpShow help for the command..
Usage
d3x serve delete [OPTIONS] NAMEd3x serve delete --helpFunction
Delete deployment.
Options
Option
Description
-o,--output [yaml|json]supported only json,yaml
--helpShow help for the command..
Usage
d3x serve get [OPTIONS] NAMEd3x serve get --helpFunction
Get deployment.
Options
Option
Description
-o,--output [yaml|json]supported only json,yaml
--helpShow help for the command..
Usage
d3x serve list [OPTIONS]d3x serve list --helpFunction
List deployments.
Options
Option
Description
--allList all the deployments
-o,--output [yaml|json]supported only json,yaml
--helpShow help for the command..
Usage
d3x serve status [OPTIONS] NAMESPACE IDd3x serve status --helpFunction
Check deployment Status.
Options
Option
Description
--helpShow help for the command..
d3x sky¶
Usage
d3x sky [OPTIONS] COMMAND [ARGS]...d3x sky --helpFunction
Commands for managing SkyPilot clusters, resources and jobs.
Options
Option
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,--versionShow the version and exit.
-c,--commitShow the commit hash and exit
-h,--helpShow help for the command..
Commands
Command
Description
launchLaunch a cluster or task.
execExecute a task or command on an existing cluster.
statusShow clusters.
cost-reportShow estimated costs for launched clusters.
queueShow the job queue for cluster(s).
logsTail the log of a job.
cancelCancel job(s).
stopStop cluster(s).
autostopSchedule an autostop or autodown for cluster(s).
startRestart cluster(s).
downTear down cluster(s).
checkCheck which clouds are available to use.
show-gpusShow supported GPU/TPU/accelerators and their prices.
storageCommands for using SkyPilot Storage CLI.
benchCommands for usingSkyPilot Benchmark CLI.
spotCommands for using managed Spot CLI (spot instances with auto-recovery).
serveCommands for using SkyServe CLI (multi-region, multi-cloud serving).
Usage
d3x sky launch [OPTIONS] [ENTRYPOINT]...d3x sky launch --helpFunction
Launch a cluster or task. If ENTRYPOINT points to a valid YAML file, it is read in as the task specification. Otherwise, it is interpreted as a bash command. In both cases, the commands are run under the task’s workdir (if specified) and they undergo job queue scheduling.
Options
Option
Description
-c,--cluster TEXTA cluster name. If provided, either reuse an existing cluster with that name or provision a new cluster with that name. Otherwise provision a new cluster with an autogenerated name.
--dryrunIf True, do not actually run the job.
-s,--detach-setupIf True, run setup in non-interactive mode as part of the job itself. You can safely ctrl-c to detach from logging, and it will not interrupt the setup process. To see the logs again after detaching, use sky logs. To cancel setup, cancel the job via sky cancel. Useful for long-running setup commands.
-d,--detach-runIf True, as soon as a job is submitted, return from this call and do not stream execution logs.
--dockerIf used, runs locally inside a docker container.
-n,--name TEXTTask name. Overrides the ‘name’ config in the YAML if both are supplied.
--workdir DIRECTORYIf specified, sync this dir to the remote working directory, where the task will be invoked. Overrides the ‘workdir’ config in the YAML if both are supplied.
--cloud TEXTThe cloud to use. If specified, overrides the ‘resources.cloud’ config. Passing ‘none’ resets the config.
--region TEXTThe region to use. If specified, overrides the ‘resources.region’ config. Passing ‘none’ resets the config.
--zone TEXTThe zone to use. If specified, overrides the ‘resources.zone’ config. Passing ‘none’ resets the config.
--num-nodes INTEGERNumber of nodes to execute the task on. Overrides the ‘num_nodes’ config in the YAML if both are supplied.
--cpus TEXTNumber of vCPUs each instance must have (e.g.,
--cpus=4(exactly 4) or--cpus=4+(at least 4)). This is used to automatically select the instance type.--memory TEXTAmount of memory each instance must have (e.g.,
--memory=4(exactly 4 GB) or--memory=4+(at least 4 GB)). This is used to automatically select the instance type.--hcpu INTEGERHead node CPU. Overrides the ‘resources.head_cpu’ config in the YAML if both are supplied.
--hmemory INTEGERHead node memory in GB. Overrides the ‘resources.head_memory’ config in the YAML if both are supplied.
--htype TEXTHead node instance type. Overrides the ‘resources.head_instance_type’ config in the YAML if both are supplied.
--disk-size INTEGEROS disk size in GBs.
--disk-tier [low|medium|high|best|none]OS disk tier. Could be one of low, medium, high, best, none. If best is specified, use the best possible disk tier. If none is specified, enforce to use default value and override the option in task YAML. Default: medium
--use-spot / --no-use-spotWhether to request spot instances. If specified, overrides the ‘resources.use_spot’ config.
--image-id TEXTCustom image id for launching the instances. Passing ‘none’ resets the config.
--env-file DOTENV_VALUESPath to a dotenv file with environment variables to set on the remote node.
--env _PARSE_ENV_VAREnvironment variable to set on the remote node. It can be specified multiple times. Examples: 1.
--env MY_ENV=1: set$MY_ENVon the cluster to be 1. 2.--env MY_ENV2=$HOME: set$MY_ENV2on the cluster to be the same value of$HOMEin the local environment where the CLI command is run. 3.--env MY_ENV3: set$MY_ENV3on the cluster to be the same value of$MY_ENV3in the local environment.--gpus TEXTType and number of GPUs to use. Example values: ‘V100:8’, ‘V100’ (short for a count of 1), or ‘V100:0.5’ (fractional counts are supported by the scheduling framework). If a new cluster is being launched by this command, this is the resources to provision. If an existing cluster is being reused, this is seen as the task demand, which must fit the cluster’s total resources and is used for scheduling the task. Overrides the ‘accelerators’ config in the YAML if both are supplied. Passing ‘none’ resets the config.
-t,--instance-type TEXTThe instance type to use. If specified, overrides the ‘resources.instance_type’ config. Passing ‘none’ resets the config.
--ports TEXTPorts to open on the cluster. If specified, overrides the ‘ports’ config in the YAML.
-i,--idle-minutes-to-autostop INTEGERAutomatically stop the cluster after this many minutes of idleness, i.e., no running or pending jobs in the cluster’s job queue. Idleness gets reset whenever setting-up/running/pending jobs are found in the job queue. Setting this flag is equivalent to running
sky launch -d ...and thensky autostop -i <minutes>. If not set, the cluster will not be autostopped.--downAutodown the cluster: tear down the cluster after all jobs finish (successfully or abnormally). If –idle-minutes-to-autostop is also set, the cluster will be torn down after the specified idle time. Note that if errors occur during provisioning/data syncing/setting up, the cluster will not be torn down for debugging purposes.
-r,--retry-until-upWhether to retry provisioning infinitely until the cluster is up, if we fail to launch the cluster on any possible region/cloud due to unavailability errors.
-y,--yesSkip confirmation prompt.
--no-setupSkip setup phase when (re-)launching cluster.
--clone-disk-from,--clone TEXT[Experimental] Clone disk from an existing cluster to launch a new one. This is useful when the new cluster needs to have the same data on the boot disk as an existing cluster.
-h,--helpShow help for the command..
Usage
d3x sky exec [OPTIONS] CLUSTER ENTRYPOINT...d3x sky exec --helpFunction
Execute a task or command on an existing cluster. If ENTRYPOINT points to a valid YAML file, it is read in as the task specification. Otherwise, it is interpreted as a bash command.
Options
Option
Description
-d,--detach-runIf True, as soon as a job is submitted, return from this call and do not stream execution logs.
-n,--name TEXTTask name. Overrides the ‘name’ config in the YAML if both are supplied.
--workdir DIRECTORYIf specified, sync this dir to the remote working directory, where the task will be invoked. Overrides the ‘workdir’ config in the YAML if both are supplied.
--cloud TEXTThe cloud to use. If specified, overrides the ‘resources.cloud’ config. Passing ‘none’ resets the config.
--region TEXTThe region to use. If specified, overrides the ‘resources.region’ config. Passing ‘none’ resets the config.
--zone TEXTThe zone to use. If specified, overrides the ‘resources.zone’ config. Passing ‘none’ resets the config.
--num-nodes INTEGERNumber of nodes to execute the task on. Overrides the ‘num_nodes’ config in the YAML if both are supplied.
--cpus TEXTNumber of vCPUs each instance must have (e.g.,
--cpus=4(exactly 4) or--cpus=4+(at least 4)). This is used to automatically select the instance type.--memory TEXTAmount of memory each instance must have in GB (e.g.,
--memory=16(exactly 16GB),--memory=16+(at least 16GB))--disk-size INTEGEROS disk size in GBs.
--disk-tier [low|medium|high|best|none]OS disk tier. Could be one of low, medium, high, best, none. If best is specified, use the best possible disk tier. If none is specified, enforce to use default value and override the option in task YAML. Default: medium
--use-spot / --no-use-spotWhether to request spot instances. If specified, overrides the ‘resources.use_spot’ config.
--image-id TEXTCustom image id for launching the instances. Passing ‘none’ resets the config.
--env-file DOTENV_VALUESPath to a dotenv file with environment variables to set on the remote node.
--env _PARSE_ENV_VAREnvironment variable to set on the remote node. It can be specified multiple times. Examples: 1.
--env MY_ENV=1: set$MY_ENVon the cluster to be 1. 2.--env MY_ENV2=$HOME: set$MY_ENV2on the cluster to be the same value of$HOMEin the local environment where the CLI command is run. 3.--env MY_ENV3: set$MY_ENV3on the cluster to be the same value of$MY_ENV3in the local environment.--gpus TEXTType and number of GPUs to use. Example values: ‘V100:8’, ‘V100’ (short for a count of 1), or ‘V100:0.5’ (fractional counts are supported by the scheduling framework). If a new cluster is being launched by this command, this is the resources to provision. If an existing cluster is being reused, this is seen as the task demand, which must fit the cluster’s total resources and is used for scheduling the task. Overrides the ‘accelerators’ config in the YAML if both are supplied. Passing ‘none’ resets the config.
-t,--instance-type TEXTThe instance type to use. If specified, overrides the ‘resources.instance_type’ config. Passing ‘none’ resets the config.
--ports TEXTPorts to open on the cluster. If specified, overrides the ‘ports’ config in the YAML.
-h,--helpShow help for the command..
Usage
d3x sky status [OPTIONS] [CLUSTERS]...d3x sky status --helpFunction
Show sky clusters. If CLUSTERS is given, show those clusters. Otherwise, show all clusters. If –ip is specified, show the IP address of the head node of the cluster. Only available when CLUSTERS contains exactly one cluster, e.g.
sky status --ip mycluster. If –endpoints is specified, show all exposed endpoints in the cluster. Only available when CLUSTERS contains exactly one cluster, e.g.sky status --endpoints mycluster. To query a single endpoint, you can usesky status mycluster --endpoint 8888.Options
Option
Description
-a,--allShow all information in full.
-r,--refreshQuery the latest cluster statuses from the cloud provider(s).
--ipGet the IP address of the head node of a cluster. This option will override all other options. For Kubernetes clusters, the returned IP address is the internal IP of the head pod, and may not be accessible from outside the cluster.
--endpointsGet all exposed endpoints and corresponding URLs for acluster. This option will override all other options.
--endpoint INTEGERGet the endpoint URL for the specified port number on the cluster. This option will override all other options.
--show-spot-jobs / --no-show-spot-jobsAlso show recent in-progress spot jobs, if any.
--show-services / --no-show-servicesAlso show sky serve services, if any.
-h,--helpShow help for the command..
Usage
d3x sky cost-report [OPTIONS]d3x sky cost-report --helpFunction
Show estimated costs for launched Skypilot clusters.
Options
Option
Description
-a,--allShow all information in full.
-h,--helpShow help for the command..
Usage
d3x sky queue [OPTIONS] [CLUSTERS]...d3x sky queue --helpFunction
Show the job queue for cluster(s).
Options
Option
Description
-a,--all-usersShow all users’ information in full.
-s,--skip-finishedShow only pending/running jobs’ information.
-h,--helpShow help for the command..
Usage
d3x sky logs [OPTIONS] CLUSTER [JOB_IDS]...d3x sky logs --helpFunction
Tail the log of a job.
Options
Option
Description
-s,--sync-downSync down the logs of a job to the local machine. For a distributed job, a separate log file from each worker will be downloaded.
--statusIf specified, do not show logs but exit with a status code for the job’s status: 0 for succeeded, or 1 for all other statuses.
--follow / --no-followFollow the logs of a job. If –no-follow is specified, print the log so far and exit. [default: –follow]
-h,--helpShow help for the command..
Usage
d3x sky cancel [OPTIONS] CLUSTER [JOBS]...d3x sky cancel --helpFunction
Cancel Skypilot job(s).
Options
Option
Description
-a,--allCancel all jobs on the specified cluster.
-y,--yesSkip confirmation prompt.
-h,--helpShow help for the command..
Usage
d3x sky stop [OPTIONS] [CLUSTERS]...d3x sky stop --helpFunction
Stop Skypilot cluster(s).
Options
Option
Description
-a,--allStop all existing clusters.
-y,--yesSkip confirmation prompt.
-h,--helpShow help for the command..
Usage
d3x sky autostop [OPTIONS] [CLUSTERS]...d3x sky autostop --helpFunction
Schedule an autostop or autodown for cluster(s). Autostop/autodown will automatically stop or teardown a cluster when it becomes idle for a specified duration. Idleness means there are no in-progress (pending/running) jobs in a cluster’s job queue.
Options
Option
Description
-a,--allApply this command to all existing clusters.
-i,--idle-minutes INTEGERSet the idle minutes before autostopping the cluster. See the doc above for detailed semantics.
--cancelCancel any currently active auto{stop,down} setting for the cluster. No-op if there is no active setting.
--downUse autodown (tear down the cluster; non-restartable), instead of autostop (restartable).
-y,--yesSkip confirmation prompt.
-h,--helpShow help for the command..
Usage
d3x sky start [OPTIONS] [CLUSTERS]...d3x sky start --helpFunction
Restart Skypilot cluster(s). If a cluster is previously stopped (status is STOPPED) or failed in provisioning/runtime installation (status is INIT), this command will attempt to start the cluster. In the latter case, provisioning and runtime installation will be retried.
Options
Option
Description
-a,--allStart all existing clusters.
-y,--yesSkip confirmation prompt.
-i,--idle-minutes-to-autostop INTEGERAutomatically stop the cluster after this many minutes of idleness, i.e., no running or pending jobs in the cluster’s job queue. Idleness gets reset whenever setting-up/running/pending jobs are found in the job queue. Setting this flag is equivalent to running
sky launch -d ...and thensky autostop -i <minutes>. If not set, the cluster will not be autostopped.--downAutodown the cluster: tear down the cluster after specified minutes of idle time after all jobs finish (successfully or abnormally). Requires –idle-minutes-to-autostop to be set.
-r,--retry-until-upRetry provisioning infinitely until the cluster is up, if we fail to start the cluster due to unavailability errors.
-f,--forceForce start the cluster even if it is already UP. Useful for upgrading the SkyPilot runtime on the cluster.
-h,--helpShow help for the command..
Usage
d3x sky down [OPTIONS] [CLUSTERS]...d3x sky down --helpFunction
Tear down Skypilot cluster(s).
Options
Option
Description
-a,--allTear down all existing clusters.
-y,--yesSkip confirmation prompt.
-p,--purgeIgnore cloud provider errors (if any). Useful for cleaning up manually deleted cluster(s).
-h,--helpShow help for the command..
Usage
d3x sky check [OPTIONS]d3x sky check --helpFunction
Check which clouds are available to use by Skypilot.
Options
Option
Description
-v,--verboseShow the activated account for each cloud.
-h,--helpShow help for the command..
Usage
d3x sky show-gpus [OPTIONS] [ACCELERATOR_STR]d3x sky show-gpus --helpFunction
Show GPU/TPU/accelerators supported by Skypilot and their prices.
Options
Option
Description
-a,--allShow details of all GPU/TPU/accelerator offerings.
--cloud TEXTCloud provider to query.
--region TEXTThe region to use. If not specified, shows accelerators from all regions.
--all-regionsShow pricing and instance details for a specified accelerator across all regions and clouds.
-h,--helpShow help for the command..
Usage
d3x sky storage [OPTIONS] COMMAND [ARGS]...d3x sky storage --helpFunction
Commands for using SkyPilot storage CLI.
Options
Option
Description
-h,--helpShow help for the command..
Commands
Command
Description
lsList storage objects managed by SkyPilot.
deleteDelete storage objects.
Usage
d3x sky storage ls [OPTIONS]d3x sky storage ls --helpFunction
List storage objects managed by SkyPilot.
Options
Option
Description
-a,--allShow all information in full.
-h,--helpShow help for the command..
Usage
d3x sky storage delete [OPTIONS] [NAMES]...d3x sky storage delete --helpFunction
Delete storage objects in Skypilot storage.
Options
Option
Description
-a,--allDelete all storage objects.
-y,--yesSkip confirmation prompt.
-h,--helpShow help for the command..
Usage
d3x sky bench [OPTIONS] COMMAND [ARGS]...d3x sky bench --helpFunction
Commands for using SkyPilot Benchmark CLI.
Options
Option
Description
-h,--helpShow help for the command..
Commands
Command
Description
launchBenchmark a task on different resources.
lsList the benchmark history.
showShow a benchmark report.
downTear down all clusters belonging to a benchmark.
deleteDelete benchmark reports from the history.
Usage
d3x sky bench launch [OPTIONS] ENTRYPOINT...d3x sky bench launch --helpFunction
Benchmark a task on different resources.
Options
Option
Description
-b,--benchmark TEXTBenchmark name. [required]
-n,--name TEXTTask name. Overrides the ‘name’ config in the YAML if both are supplied.
--workdir DIRECTORYIf specified, sync this dir to the remote working directory, where the task will be invoked. Overrides the ‘workdir’ config in the YAML if both are supplied.
--cloud TEXTThe cloud to use. If specified, overrides the ‘resources.cloud’ config. Passing ‘none’ resets the config.
--region TEXTThe region to use. If specified, overrides the ‘resources.region’ config. Passing ‘none’ resets the config.
--zone TEXTThe zone to use. If specified, overrides the ‘resources.zone’ config. Passing ‘none’ resets the config.
--num-nodes INTEGERNumber of nodes to execute the task on. Overrides the ‘num_nodes’ config in the YAML if both are supplied.
--cpus TEXTNumber of vCPUs each instance must have (e.g.,
--cpus=4(exactly 4) or--cpus=4+(at least 4)). This is used to automatically select the instance type.--memory TEXTAmount of memory each instance must have in GB (e.g.,
--memory=16(exactly 16GB),--memory=16+(at least 16GB))--disk-size INTEGEROS disk size in GBs.
--disk-tier [low|medium|high|best|none]OS disk tier. Could be one of low, medium, high, best, none. If best is specified, use the best possible disk tier. If none is specified, enforce to use default value and override the option in task YAML. Default: medium
--use-spot / --no-use-spotWhether to request spot instances. If specified, overrides the ‘resources.use_spot’ config.
--image-id TEXTCustom image id for launching the instances. Passing ‘none’ resets the config.
--env-file DOTENV_VALUESPath to a dotenv file with environment variables to set on the remote node.
--env _PARSE_ENV_VAREnvironment variable to set on the remote node. It can be specified multiple times. Examples: 1.
--env MY_ENV=1: set$MY_ENVon the cluster to be 1. 2.--env MY_ENV2=$HOME: set$MY_ENV2on the cluster to be the same value of$HOMEin the local environment where the CLI command is run. 3.--env MY_ENV3: set$MY_ENV3on the cluster to be the same value of$MY_ENV3in the local environment.--gpus TEXTComma-separated list of GPUs to run benchmark on. Example values: ‘T4:4,V100:8’ (without blank spaces).
--ports TEXTPorts to open on the cluster. If specified, overrides the ‘ports’ config in the YAML.
-i,--idle-minutes-to-autostop INTEGERAutomatically stop the cluster after this many minutes of idleness after setup/file_mounts. This is equivalent to running sky launch -d … and then sky autostop -i <minutes>. If not set, the cluster will not be autostopped.
-y,--yesSkip confirmation prompt.
-h,--helpShow help for the command..
Usage
d3x sky bench ls [OPTIONS]d3x sky bench ls --helpFunction
List the benchmark history.
Options
Option
Description
-h,--helpShow help for the command..
Usage
d3x sky bench show [OPTIONS] BENCHMARKd3x sky bench show --helpFunction
Show a benchmark report.
Options
Option
Description
-h,--helpShow help for the command..
Usage
d3x sky bench down [OPTIONS] BENCHMARKd3x sky bench down --helpFunction
Tear down all clusters belonging to a benchmark.
Options
Option
Description
-e,--exclude TEXTCluster name(s) to exclude from termination. Typically, you might want to see the benchmark results in sky bench show and exclude a ‘winner’ cluster from termination to finish the running task.
-y,--yesSkip confirmation prompt.
-h,--helpShow help for the command..
Usage
d3x sky bench delete [OPTIONS] [BENCHMARKS]...d3x sky bench delete --helpFunction
Delete benchmark reports from the history.
Options
Option
Description
-a,--allDelete all benchmark reports from the history.
-y,--yesSkip confirmation prompt.
-h,--helpShow help for the command..
Usage
d3x sky spot [OPTIONS] COMMAND [ARGS]...d3x sky spot --helpFunction
Commands for using managed Spot CLI (spot instances with auto-recovery).
Options
Option
Description
-h,--helpShow help for the command..
Commands
Command
Description
launchLaunch a managed spot job from a YAML or a command.
queueShow statuses of managed spot jobs.
cancelCancel managed spot jobs.
logsTail the log of a managed spot job.
dashboardOpens a dashboard for spot jobs (needs controller to be UP).
Usage
d3x sky spot launch [OPTIONS] ENTRYPOINT...d3x sky spot launch --helpFunction
Launch a managed spot job from a YAML or a command.
Options
Option
Description
-n,--name TEXTTask name. Overrides the ‘name’ config in the YAML if both are supplied.
--workdir DIRECTORYIf specified, sync this dir to the remote working directory, where the task will be invoked. Overrides the ‘workdir’ config in the YAML if both are supplied.
--cloud TEXTThe cloud to use. If specified, overrides the ‘resources.cloud’ config. Passing ‘none’ resets the config.
--region TEXTThe region to use. If specified, overrides the ‘resources.region’ config. Passing ‘none’ resets the config.
--zone TEXTThe zone to use. If specified, overrides the ‘resources.zone’ config. Passing ‘none’ resets the config.
--num-nodes INTEGERNumber of nodes to execute the task on. Overrides the ‘num_nodes’ config in the YAML if both are supplied.
--cpus TEXTNumber of vCPUs each instance must have (e.g.,
--cpus=4(exactly 4) or--cpus=4+(at least 4)). This is used to automatically select the instance type.--memory TEXTAmount of memory each instance must have in GB (e.g.,
--memory=16(exactly 16GB),--memory=16+(at least 16GB))--disk-size INTEGEROS disk size in GBs.
--disk-tier [low|medium|high|best|none]OS disk tier. Could be one of low, medium, high, best, none. If best is specified, use the best possible disk tier. If none is specified, enforce to use default value and override the option in task YAML. Default: medium
--use-spot / --no-use-spotWhether to request spot instances. If specified, overrides the ‘resources.use_spot’ config.
--image-id TEXTCustom image id for launching the instances. Passing ‘none’ resets the config.
--env-file DOTENV_VALUESPath to a dotenv file with environment variables to set on the remote node.
--env _PARSE_ENV_VAREnvironment variable to set on the remote node. It can be specified multiple times. Examples: 1.
--env MY_ENV=1: set$MY_ENVon the cluster to be 1. 2.--env MY_ENV2=$HOME: set$MY_ENV2on the cluster to be the same value of$HOMEin the local environment where the CLI command is run. 3.--env MY_ENV3: set$MY_ENV3on the cluster to be the same value of$MY_ENV3in the local environment.--gpus TEXTType and number of GPUs to use. Example values: ‘V100:8’, ‘V100’ (short for a count of 1), or ‘V100:0.5’ (fractional counts are supported by the scheduling framework). If a new cluster is being launched by this command, this is the resources to provision. If an existing cluster is being reused, this is seen as the task demand, which must fit the cluster’s total resources and is used for scheduling the task. Overrides the ‘accelerators’ config in the YAML if both are supplied. Passing ‘none’ resets the config.
-t,--instance-type TEXTThe instance type to use. If specified, overrides the ‘resources.instance_type’ config. Passing ‘none’ resets the config.
--ports TEXTPorts to open on the cluster. If specified, overrides the ‘ports’ config in the YAML.
--spot-recovery TEXTSpot recovery strategy to use for the managed spot task.
-d,--detach-runIf True, as soon as a job is submitted, return from this call and do not stream execution logs.
-r,--retry-until-up / -no-retry-until-up(Default: True; this flag is deprecated and will be removed in a future release.) Whether to retry provisioning infinitely until the cluster is up, if unavailability errors are encountered. This applies to launching the spot clusters (both the initial and any recovery attempts), not the spot controller.
-y,--yesSkip confirmation prompt.
-h,--helpShow help for the command..
Usage
d3x sky spot queue [OPTIONS]d3x sky spot queue --helpFunction
Show statuses of managed spot jobs.
Options
Option
Description
-a,--allShow all information in full.
-r,--refreshQuery the latest statuses, restarting the spot controller if stopped.
-s,--skip-finishedShow only pending/running jobs’ information.
-h,--helpShow help for the command..
Usage
d3x sky spot cancel [OPTIONS] [JOB_IDS]...d3x sky spot cancel --helpFunction
Cancel managed spot jobs.
Options
Option
Description
-n,--name TEXTManaged spot job name to cancel.
-a,--allCancel all managed spot jobs.
-y,--yesSkip confirmation prompt.
-h,--helpShow help for the command..
Usage
d3x sky spot logs [OPTIONS] [JOB_ID]d3x sky spot logs --helpFunction
Tail the log of a managed spot job.
Options
Option
Description
-n,--name TEXTManaged spot job name.
--follow / --no-followFollow the logs of the job. [default: –follow] If –no-follow is specified, print the log so far and exit.
--controllerShow the controller logs of this job; useful for debugging launching/recoveries, etc.
-h,--helpShow help for the command..
Usage
d3x sky spot dashboard [OPTIONS]d3x sky spot dashboard --helpFunction
Opens a dashboard for spot jobs (needs controller to be UP).
Options
Option
Description
-p,--port INTEGERLocal port to use for the dashboard. If None, a free port is automatically chosen.
-h,--helpShow help for the command..
Usage
d3x sky serve [OPTIONS] COMMAND [ARGS]...d3x sky serve --helpFunction
Commands for using SkyServe CLI (multi-region, multi-cloud serving).
Options
Option
Description
-h,--helpShow help for the command..
Commands
Command
Description
upLaunch a SkyServe service.
updateUpdate a SkyServe service.
statusShow statuses of SkyServe services.
downTeardown service(s).
logsTail the log of a service.
Usage
d3x sky serve up [OPTIONS] SERVICE_YAML...d3x sky serve up --helpFunction
Launch a SkyServe service.
Options
Option
Description
-n,--service-name TEXTA service name. Unique for each service. If not provided, a unique name is autogenerated.
--workdir DIRECTORYIf specified, sync this dir to the remote working directory, where the task will be invoked. Overrides the ‘workdir’ config in the YAML if both are supplied.
--cloud TEXTThe cloud to use. If specified, overrides the ‘resources.cloud’ config. Passing ‘none’ resets the config.
--region TEXTThe region to use. If specified, overrides the ‘resources.region’ config. Passing ‘none’ resets the config.
--zone TEXTThe zone to use. If specified, overrides the ‘resources.zone’ config. Passing ‘none’ resets the config.
--num-nodes INTEGERNumber of nodes to execute the task on. Overrides the ‘num_nodes’ config in the YAML if both are supplied.
--cpus TEXTNumber of vCPUs each instance must have (e.g.,
--cpus=4(exactly 4) or--cpus=4+(at least 4)). This is used to automatically select the instance type.--memory TEXTAmount of memory each instance must have in GB (e.g.,
--memory=16(exactly 16GB),--memory=16+(at least 16GB))--disk-size INTEGEROS disk size in GBs.
--disk-tier [low|medium|high|best|none]OS disk tier. Could be one of low, medium, high, best, none. If best is specified, use the best possible disk tier. If none is specified, enforce to use default value and override the option in task YAML. Default: medium
--use-spot / --no-use-spotWhether to request spot instances. If specified, overrides the ‘resources.use_spot’ config.
--image-id TEXTCustom image id for launching the instances. Passing ‘none’ resets the config.
--env-file DOTENV_VALUESPath to a dotenv file with environment variables to set on the remote node.
--env _PARSE_ENV_VAREnvironment variable to set on the remote node. It can be specified multiple times. Examples: 1.
--env MY_ENV=1: set$MY_ENVon the cluster to be 1. 2.--env MY_ENV2=$HOME: set$MY_ENV2on the cluster to be the same value of$HOMEin the local environment where the CLI command is run. 3.--env MY_ENV3: set$MY_ENV3on the cluster to be the same value of$MY_ENV3in the local environment.--gpus TEXTType and number of GPUs to use. Example values: ‘V100:8’, ‘V100’ (short for a count of 1), or ‘V100:0.5’ (fractional counts are supported by the scheduling framework). If a new cluster is being launched by this command, this is the resources to provision. If an existing cluster is being reused, this is seen as the task demand, which must fit the cluster’s total resources and is used for scheduling the task. Overrides the ‘accelerators’ config in the YAML if both are supplied. Passing ‘none’ resets the config.
-t,--instance-type TEXTThe instance type to use. If specified, overrides the ‘resources.instance_type’ config. Passing ‘none’ resets the config.
--ports TEXTPorts to open on the cluster. If specified, overrides the ‘ports’ config in the YAML.
-y,--yesSkip confirmation prompt.
-h,--helpShow help for the command..
Usage
d3x sky serve update [OPTIONS] SERVICE_NAME SERVICE_YAML...d3x sky serve update --helpFunction
Update a SkyServe service.
Options
Option
Description
--workdir DIRECTORYIf specified, sync this dir to the remote working directory, where the task will be invoked. Overrides the ‘workdir’ config in the YAML if both are supplied.
--cloud TEXTThe cloud to use. If specified, overrides the ‘resources.cloud’ config. Passing ‘none’ resets the config.
--region TEXTThe region to use. If specified, overrides the ‘resources.region’ config. Passing ‘none’ resets the config.
--zone TEXTThe zone to use. If specified, overrides the ‘resources.zone’ config. Passing ‘none’ resets the config.
--num-nodes INTEGERNumber of nodes to execute the task on. Overrides the ‘num_nodes’ config in the YAML if both are supplied.
--cpus TEXTNumber of vCPUs each instance must have (e.g.,
--cpus=4(exactly 4) or--cpus=4+(at least 4)). This is used to automatically select the instance type.--memory TEXTAmount of memory each instance must have in GB (e.g.,
--memory=16(exactly 16GB),--memory=16+(at least 16GB))--disk-size INTEGEROS disk size in GBs.
--disk-tier [low|medium|high|best|none]OS disk tier. Could be one of low, medium, high, best, none. If best is specified, use the best possible disk tier. If none is specified, enforce to use default value and override the option in task YAML. Default: medium
--use-spot / --no-use-spotWhether to request spot instances. If specified, overrides the ‘resources.use_spot’ config.
--image-id TEXTCustom image id for launching the instances. Passing ‘none’ resets the config.
--env-file DOTENV_VALUESPath to a dotenv file with environment variables to set on the remote node.
--env _PARSE_ENV_VAREnvironment variable to set on the remote node. It can be specified multiple times. Examples: 1.
--env MY_ENV=1: set$MY_ENVon the cluster to be 1. 2.--env MY_ENV2=$HOME: set$MY_ENV2on the cluster to be the same value of$HOMEin the local environment where the CLI command is run. 3.--env MY_ENV3: set$MY_ENV3on the cluster to be the same value of$MY_ENV3in the local environment.--gpus TEXTType and number of GPUs to use. Example values: ‘V100:8’, ‘V100’ (short for a count of 1), or ‘V100:0.5’ (fractional counts are supported by the scheduling framework). If a new cluster is being launched by this command, this is the resources to provision. If an existing cluster is being reused, this is seen as the task demand, which must fit the cluster’s total resources and is used for scheduling the task. Overrides the ‘accelerators’ config in the YAML if both are supplied. Passing ‘none’ resets the config.
-t,--instance-type TEXTThe instance type to use. If specified, overrides the ‘resources.instance_type’ config. Passing ‘none’ resets the config.
--ports TEXTPorts to open on the cluster. If specified, overrides the ‘ports’ config in the YAML.
-y,--yesSkip confirmation prompt.
-h,--helpShow help for the command..
Usage
d3x sky serve status [OPTIONS] [SERVICE_NAMES]...d3x sky serve status --helpFunction
Show statuses of SkyServe services.
Options
Option
Description
-a,--allShow all information in full.
--endpointShow service endpoint.
-h,--helpShow help for the command..
Usage
d3x sky serve down [OPTIONS] [SERVICE_NAMES]...d3x sky serve down --helpFunction
Teardown service(s).
Options
Option
Description
-a,--allTear down all services.
-p,--purgeTear down services in failed status.
-y,--yesSkip confirmation prompt.
-h,--helpShow help for the command..
Usage
d3x sky serve logs [OPTIONS] SERVICE_NAME [REPLICA_ID]d3x sky serve logs --helpFunction
Tail the log of a service.
Options
Option
Description
--follow / --no-followFollow the logs of the job. [default: –follow] If –no-follow is specified, print the log so far and exit.
--controllerShow the controller logs of this service.
--load-balancerShow the load balancer logs of this service.
-h,--helpShow help for the command..
d3x ssh¶
Usage
d3x ssh [OPTIONS] [COMMAND]...d3x ssh --helpFunction
SSH to DKubeX workspace.
Options
Option
Description
-w TEXTworkspace name
--helpShow help for the command..
d3x ssh-copy-id¶
Usage
d3x ssh-copy-id [OPTIONS] PUBLIC_KEYd3x ssh-copy-id --helpFunction
Copy ssh public key to DKubeX user’s home.
Options
Option
Description
--helpShow help for the command..
d3x start¶
Usage
d3x start [OPTIONS]d3x start --helpFunction
Start given workspace.
Options
Option
Description
--helpShow help for the command..
d3x start-app¶
Usage
d3x start-app [OPTIONS] APP_NAMEd3x start-app --helpFunction
Start given workspace app.
Options
Option
Description
--helpShow help for the command..
d3x stop¶
Usage
d3x stop [OPTIONS]d3x stop --helpFunction
Stop given workspace.
Options
Option
Description
--helpShow help for the command..
d3x stop-app¶
Usage
d3x stop-app [OPTIONS] APP_NAMEd3x stop-app --helpFunction
Stop given workspace App.
Options
Option
Description
--helpShow help for the command..
d3x tensorboard¶
Usage
d3x tensorboard [OPTIONS] COMMAND [ARGS]...d3x tensorboard --helpFunction
Commands regarding using Tensorboard.
Options
Option
Description
--helpShow help for the command..
Commands
Command
Description
get-logdirGetting log directory for tensorboard.
set-logdirSetting log directory for tensorboard app inside workspace.
Usage
d3x tensorboard get-logdir [OPTIONS]d3x tensorboard get-logdir --helpFunction
Getting log directory for tensorboard.
Options
Option
Description
-o,--output [yaml|json]supported only json,yaml
--helpShow help for the command..
Usage
d3x tensorboard set-logdir [OPTIONS] LOGDIRd3x tensorboard set-logdir --helpFunction
Setting log directory for tensorboard app inside workspace.
Options
Option
Description
-o,--output [yaml|json]supported only json,yaml
--helpShow help for the command..
d3x top¶
Usage
d3x top [OPTIONS] [WORKSPACE]d3x top --helpFunction
Show workspace resource usage.
Options
Option
Description
--helpShow help for the command..
d3x umount¶
Usage
d3x umount [OPTIONS] MOUNTPATHd3x umount --helpFunction
Unmount bucket previously mounted using
d3x mountcommand.Options
Option
Description
--helpShow help for the command..
d3x version¶
Usage
d3x version [OPTIONS]d3x version --helpFunction
Show DKubeX version.
Options
Option
Description
-o,--output [yaml|json]supported only json,yaml
--helpShow help for the command..
d3x vnc¶
Usage
d3x vnc [OPTIONS] WORKSPACE_NAMEd3x vnc --helpFunction
VNC connection to DKubeX workspace.
Options
Option
Description
--helpShow help for the command..