- tocdepth
2
Описание команд и параметров
В этом разделе сгруппированы описания команд и параметров, доступных в CLI-утилите.
Синтаксис утилиты в общем виде состоит из:
вызова;
команд;
подкоманд.
mlspace <command> <subcommand> [parameters]
Чтобы получить справочную информацию о конкретной команде используйте:
mlspace <command> --help
Чтобы проверить версию CLI-утилиты, используйте команду:
mlspace --version
Работа с S3
Ниже приведены команды и подкоманды, относящиеся к работе с S3.
mlspace s3 <subcommand> [parameters]
s3 add
(string) — добавляет новое S3-совместимое хранилище.Пример запроса для добавления бакетаmlspace s3 add -b <bucket> -ac <acces-key> -sc <secret_key> -ep <endpoint>
Параметры подкоманды add Параметр
Тип
Описание
--bucket_name
или-b
String
Обязательный
Название бакета
--access_key
или-ac
String
Обязательный
Ключ доступа
-sc
String
Обязательный
S3 secret key.
Для получения значений хранилищ платформы ML Space используйте инструкцию.
-ep
String
Обязательный
S3 endpoint
Для получения значений хранилищ платформы ML Space используйте инструкцию.
s3 list
(string) — выводит список всех S3-совместимых хранилищ, доступных для текущего пользователя.mlspace s3 list
s3 creds
(string) — выводит учетные данные для указанного S3-совместимого хранилища. Параметр-b
используется для указания названия бакета.Параметры подкоманды creds Параметр
Тип
Описание
--bucket_name
или-b
String
Обязательный
Название бакета
Пример запроса для получения учетных данных указанного S3 хранилищаmlspace s3 creds -b <bucket>
s3 get-default-creds
(string) — выводит учетные данные для хранилища, установленного по умолчанию.mlspace s3 get-default-creds
s3 get-default-name
(string) — выводит название бакета, установленного по умолчанию.mlspace s3 get-default-name
s3 remove
(string) — удаляет указанное S3-совместимое хранилище. Параметр-b
используется для указания названия бакета.При удалении бакета по умолчанию это свойство приобретает следующий бакет в списке. При удалении единственного бакета, удаляется бакет по умолчанию.
mlspace s3 remove
s3 set-default
(string) — устанавливает указанное S3-совместимое хранилище как хранилище по умолчанию. Параметр-b
используется для указания названия бакета.mlspace set-default -b <buket_name>
s3 --help
(string) — выводит справочную информацию по командам для работы с S3-совместимым хранилищем.
Работа с Environments
mlspace environments <subcommand> [parameters]
environments create
— используется для создания нового окружения. Окружение представляет собой изолированное пространство, где выполняются приложения или процессы, включая связанные с ними системные ресурсы и переменные среды.Вариант запуска с полными подкомандамиmlspace environments create --env env_name_classic --python 3.11 --cuda 11.7
Вариант запуска с краткими подкомандамиmlspace environments create -e env_name_classic -p 3.11 -c 11.7
Параметры подкоманды create Параметр
Тип
Описание
--env
или-e
String
Обязательный
Параметр для указания названия нового окружения.
--python
или-p
String
Обязательный
Параметр для указания версии Python, которую вы хотите использовать в новом окружении.
--cuda
или-c
String
Необязательный
Значение по умолчанию —
None
Параметр для указания версии CUDA, которую вы хотите использовать в новом окружении.
Доступные CUDA-версии приведены в документации Anaconda.
environments list
— используется для отображения списка всех окружений, созданных в рамках Jupyter Server.При выполнении этой команды вы получите список доступных окружений, для каждого из которых отобразится следующая информация:
название окружения;
путь к окружению;
версия Python, установленная в окружении;
версия CUDA, если она установлена в окружении.
Команда позволяет быстро оценить, какие окружения уже созданы и какие параметры в них установлены, что может помочь в организации и менеджменте ваших проектов.
environments list --remote
— позволяет получить список окружений, сохраненных в registry. Полезна для отображения доступных удаленных сред выполнения и их состояния.environments push
— позволяет создать и отправить окружение в registry. Полезна для обновления существующих сред выполнения или создания новых версий среды выполнения.environments pull
— скачивает указанное окружение с сервера.Параметры подкоманды pull Параметр
Тип
Описание
--env
String
Обязательный
Параметр для указания названия окружения.
--tag
String
Обязательный
Параметр для указания тега версии окружения.
Подключение по SSH к задаче обучения
mlspace ssh [options] [command] [args]...
Подключение по SSH к задаче обучения доступно для версии CLI-утилиты не ниже 0.23.2
.
ssh by-host
— подключиться по SSH к заданному хосту задачи обучения.Вариант подключения по SSH с помощью ssh by-hostmlspace ssh by-host lm-mpi-job-842ec184-4610-420e-9ca8-8198ddf9167e-mpiworker-1
ssh by-rank
— подключиться по SSH к заданному воркеру задачи обучения.Вариант подключения по SSH с помощью ssh by-rankmlspace ssh by-rank lm-mpi-job-842ec184-4610-420e-9ca8-8198ddf9167e --rank 1
Параметр |
Тип |
Описание |
---|---|---|
|
Text Обязательный |
Переменная для указания имени задачи обучения.
Например — |
|
Text Обязательный |
Хост вида |
|
Integer Необязательный Значение по умолчанию — |
Номер воркера, к которому нужно подключиться по SSH. Целое положительное число. Значения:
|
Была ли статья полезной?
для Dev & Test