ClearML/clearml-session
1
0
Fork 0
mirror of https://github.com/clearml/clearml-session synced 2025-06-26 18:16:55 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
allegroai 2021-02-21 18:22:01 +02:00
parent 75aec95760
commit d5479b1cbe
2 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -219,6 +219,7 @@ usage: clearml-session [-h] [--version] [--attach [ATTACH]]
[--debugging DEBUGGING] [--queue QUEUE] [--debugging DEBUGGING] [--queue QUEUE]
[--docker DOCKER] [--public-ip [true/false]] [--docker DOCKER] [--public-ip [true/false]]
[--vscode-server [true/false]] [--vscode-server [true/false]]
[--jupyter-lab [true/false]]
[--git-credentials [true/false]] [--git-credentials [true/false]]
[--user-folder USER_FOLDER] [--user-folder USER_FOLDER]
[--packages [PACKAGES [PACKAGES ...]]] [--packages [PACKAGES [PACKAGES ...]]]
@ -231,6 +232,7 @@ usage: clearml-session [-h] [--version] [--attach [ATTACH]]
[--queue-excluded-tag [QUEUE_EXCLUDED_TAG [QUEUE_EXCLUDED_TAG ...]]] [--queue-excluded-tag [QUEUE_EXCLUDED_TAG [QUEUE_EXCLUDED_TAG ...]]]
[--queue-include-tag [QUEUE_INCLUDE_TAG [QUEUE_INCLUDE_TAG ...]]] [--queue-include-tag [QUEUE_INCLUDE_TAG [QUEUE_INCLUDE_TAG ...]]]
[--skip-docker-network] [--password PASSWORD] [--skip-docker-network] [--password PASSWORD]
[--username USERNAME]
clearml-session - CLI for launching JupyterLab / VSCode on a remote machine clearml-session - CLI for launching JupyterLab / VSCode on a remote machine
@ -254,8 +256,11 @@ optional arguments:
Set if running on the cloud. Default: false (use for Set if running on the cloud. Default: false (use for
local / on-premises) local / on-premises)
--vscode-server [true/false] --vscode-server [true/false]
Installing vscode server (code-server) on interactive Install vscode server (code-server) on interactive
session (default: true) session (default: true)
--jupyter-lab [true/false]
Install Jupyter-Lab on interactive session (default:
true)
--git-credentials [true/false] --git-credentials [true/false]
If true, local .git-credentials file is sent to the If true, local .git-credentials file is sent to the
interactive session. (default: false) interactive session. (default: false)
@ -277,10 +282,10 @@ optional arguments:
sessions. To clear the init-script do not pass a file sessions. To clear the init-script do not pass a file
--config-file CONFIG_FILE --config-file CONFIG_FILE
Advanced: Change the configuration file used to store Advanced: Change the configuration file used to store
the previous state (default: ~/.clearml_session.json the previous state (default: ~/.clearml_session.json)
--remote-gateway [REMOTE_GATEWAY] --remote-gateway [REMOTE_GATEWAY]
Advanced: Specify gateway ip/address to be passed to Advanced: Specify gateway ip/address to be passed to
interactive session (for use with k8s ingestion / ELB interactive session (for use with k8s ingestion / ELB)
--base-task-id BASE_TASK_ID --base-task-id BASE_TASK_ID
Advanced: Set the base task ID for the interactive Advanced: Set the base task ID for the interactive
session. (default: previously used Task). Use `none` session. (default: previously used Task). Use `none`
@ -301,8 +306,10 @@ optional arguments:
to docker (assumes k8s network ingestion) (default: to docker (assumes k8s network ingestion) (default:
false) false)
--password PASSWORD Advanced: Select ssh password for the interactive --password PASSWORD Advanced: Select ssh password for the interactive
session (default: previously used one) session (default: `randomly-generated` or previously
used one)
--username USERNAME Advanced: Select ssh username for the interactive
session (default: `root` or previously used one)
Notice! all arguments are stored as new defaults for the next session Notice! all arguments are stored as new defaults for the next session
``` ```

4
clearml_session/__main__.py
View File

@ -759,10 +759,10 @@ def setup_parser(parser):
'To clear the init-script do not pass a file') 'To clear the init-script do not pass a file')
parser.add_argument('--config-file', type=str, default='~/.clearml_session.json', parser.add_argument('--config-file', type=str, default='~/.clearml_session.json',
help='Advanced: Change the configuration file used to store the previous state ' help='Advanced: Change the configuration file used to store the previous state '
'(default: ~/.clearml_session.json') '(default: ~/.clearml_session.json)')
parser.add_argument('--remote-gateway', default=None, nargs='?', parser.add_argument('--remote-gateway', default=None, nargs='?',
help='Advanced: Specify gateway ip/address to be passed to interactive session ' help='Advanced: Specify gateway ip/address to be passed to interactive session '
'(for use with k8s ingestion / ELB') '(for use with k8s ingestion / ELB)')
parser.add_argument('--base-task-id', type=str, default=None, parser.add_argument('--base-task-id', type=str, default=None,
help='Advanced: Set the base task ID for the interactive session. ' help='Advanced: Set the base task ID for the interactive session. '
'(default: previously used Task). Use `none` for the default interactive session') '(default: previously used Task). Use `none` for the default interactive session')