Read workspace in the default organization. If you want to override the
default organization, then pass organization_name
as **kwargs
.
Args
workspace_id
(int) : Workspace ID.Example
List workspaces in the default organization. If you want to override the
default organization, then pass organization_name
as **kwargs
.
Args
cluster_id
(int) : Defaults to None.statuses
(List[str]) : A list of status filter. Defaults to None.mine
(bool) : True if list only my workspaces, False otherwise. Defaults
to True.Example
Create workspace in the default organization. If you want to override the
default organization, then pass organization_name
as **kwargs
.
Args
name
(str) : Workspace name.cluster_name
(str) : Cluster name(must be specified before other options).cluster_node_names
(List[str]) : A list of candidate cluster node names.
Defaults to None.kernel_resource_spec_name
(str) : Resource type to run an experiment (for
managed cluster only). Defaults to None.cpu_limit
(float) : Number of vCPUs (for custom cluster only). Defaults to
None.memory_limit
(str) : Memory limit in GiB (for custom cluster only).
Defaults to None.gpu_type
(str) : GPU type (for custom cluster only). Defaults to None.gpu_limit
(int) : Number of GPU cores (for custom cluster only). Defaults
to None.kernel_image_url
(str) : Kernel docker image URL. Defaults to None.max_hours
(int) : Max hours limit to run. Defaults to 24.dataset_mounts
(List[str]) : A list of dataset mounts. Defaults to None.local_files
(List[str]) : A list of local file mounts. Defaults to None.use_vesslignore
(bool) : True if local files matching glob patterns
in .vesslignore files should be ignored. Patterns apply relative to
the directory containing that .vesslignore file.root_volume_size
(str) : Root volume size. Defaults to “100Gi”.ports
(List[Dict[str, Any]]) : Port numbers to expose. Defaults to None.
processor_type(str) cpu or gpu (for custom cluster only). Defaults to
None.
init_script(str) Custom init script. Defaults to None.Example
List experiment logs in the default organization. If you want to override
the default organization, then pass organization_name
as **kwargs
.
Args
workspace_id
(int) : Workspace ID.tail
(int) : The number of lines to display from the end. Display all if
-1. Defaults to 200.Example
Start the workspace container in the default organization. If you want to
override the default organization, then pass organization_name
as
**kwargs
.
Args
workspace_id
(int) : Workspace ID.Example
Stop the workspace container in the default organization. If you want to
override the default organization, then pass organization_name
as
**kwargs
.
Args
workspace_id
(int) : Workspace ID.Example
Terminate the workspace container in the default organization. If you
want to override the default organization, then pass organization_name
as
**kwargs
.
Args
workspace_id
(int) : Workspace ID.Example
Backup the home directory of the workspace. This command should be called inside a workspace.
Example
Restore the home directory from the previous backup. This command should be called inside a workspace.
Example
Connect to a running workspace via SSH.
Args
private_key_path
(str) : SSH private key pathExample
Update .ssh/config file for VSCode Remote-SSH plugin.
Args
private_key_path
(str) : SSH private key pathExample