az ml component

Note

Эта ссылка входит в расширение ml для Azure CLI (версия 2.15.0 или более поздней). Расширение будет автоматически устанавливаться при первом запуске команды az ml component. Подробнее о расширениях.

Управление компонентами машинного обучения Azure.

компонент машинного обучения Azure определяет конфигурацию компонента для заданий конвейера. Вы можете настроить порты ввода и вывода, среду выполнения и команду компонента. После создания компонента можно ссылаться на компоненты в задании конвейера, чтобы выполнить их в контейнерах Docker.

Команды

Имя Описание Тип Состояние
az ml component archive

Архивируйте компонент.

 Extension GA
az ml component create

Создайте компонент.

 Extension GA
az ml component list

Вывод списка компонентов в рабочей области.

 Extension GA
az ml component prepare-for-sign

Подготовьте компонент для подписывания.

 Extension GA
az ml component restore

Восстановление архивированного компонента.

 Extension GA
az ml component show

Отображение сведений о компоненте.

 Extension GA
az ml component update

Обновите компонент. В настоящее время поддерживается обновление только нескольких полей (описание, display_name).

 Extension GA

az ml component archive

Архивируйте компонент.

Архивация компонента по умолчанию будет скрыта из запросов списка (az ml component list). Вы по-прежнему можете ссылаться на архивный компонент в конвейерах и использовать его. Можно архивировать контейнер компонентов или определенную версию компонента. Архивация контейнера компонентов будет архивировать все версии компонента в соответствии с указанным именем. Архивный компонент можно восстановить с помощью az ml component restore. Если весь контейнер компонентов архивирован, вы не сможете восстановить отдельные версии компонента. Необходимо восстановить контейнер компонентов.

az ml component archive --name
                        [--acquire-policy-token]
                        [--change-reference]
                        [--label]
                        [--registry-name]
                        [--resource-group]
                        [--version]
                        [--workspace-name]

Примеры

Архивируйте контейнер компонентов (архивирует все версии этого компонента)

az ml component archive --name my-component --resource-group my-resource-group --workspace-name my-workspace

Архивация определенной версии компонента

az ml component archive --name my-component --version 1 --resource-group my-resource-group --workspace-name my-workspace

Обязательные параметры

--name -n

Имя компонента.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--label -l

Метка компонента.

--registry-name

Если это указано, команда будет нацелена на реестр вместо рабочей области. Поэтому не требуется группа ресурсов и рабочая область.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--version -v

Версия компонента.

--workspace-name -w

Имя рабочей области Azure машинного обучения. Вы можете настроить рабочую область по умолчанию с помощью az configure --defaults workspace=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az ml component create

Создайте компонент.

az ml component create --file
                       [--acquire-policy-token]
                       [--change-reference]
                       [--name]
                       [--registry-name]
                       [--resource-group]
                       [--set]
                       [--skip-validation]
                       [--version]
                       [--workspace-name]

Примеры

Создание компонента из файла спецификации YAML

az ml component create --file my_component.yml --resource-group my-resource-group --workspace-name my-workspace

Создание компонента из файла спецификации YAML с указанной версией

az ml component create --file my_component.yml --version 1 --resource-group my-resource-group --workspace-name my-workspace

Создание компонента в реестре из файла спецификации YAML

az ml component create --file my_component.yml --registry-name my-registry-name --resource-group my-resource-group

Создание компонента в реестре из файла спецификации YAML с указанной версией

az ml component create --file my_component.yml --version 1 --registry-name my-registry-name --resource-group my-resource-group

Обязательные параметры

--file -f

Локальный путь к ФАЙЛу YAML, содержаному спецификацию компонента Azure машинного обучения. Справочные документы YAML для компонента можно найти по адресу: https://aka.ms/ml-cli-v2-component-command-yaml-reference.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--name -n

Имя компонента.

--registry-name

Если это указано, команда будет нацелена на реестр вместо рабочей области. Поэтому не требуется группа ресурсов и рабочая область.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--set

Обновите объект, указав путь к свойству и значение для задания. Пример: --set property1.property2=value.

--skip-validation

Пропустить проверку при создании ресурса. Обратите внимание, что зависимые ресурсы не пропускают проверку при создании.

Свойство Значение
Default value: False
--version -v

Версия компонента.

--workspace-name -w

Имя рабочей области Azure машинного обучения. Вы можете настроить рабочую область по умолчанию с помощью az configure --defaults workspace=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az ml component list

Вывод списка компонентов в рабочей области.

az ml component list [--archived-only]
                     [--include-archived]
                     [--max-results]
                     [--name]
                     [--registry-name]
                     [--resource-group]
                     [--workspace-name]

Примеры

Вывод списка всех компонентов в рабочей области

az ml component list --resource-group my-resource-group --workspace-name my-workspace

Список всех версий компонентов для указанного имени в рабочей области

az ml component list --name my-component --resource-group my-resource-group --workspace-name my-workspace

Вывод списка всех компонентов в рабочей области с помощью аргумента --query для выполнения запроса JMESPath в результатах команд.

az ml component list --query "[].{Name:name}"  --output table --resource-group my-resource-group --workspace-name my-workspace

Перечисление всех компонентов в реестре

az ml component list --registry-name my-registry-name --resource-group my-resource-group

Список всех версий компонентов для указанного имени в реестре

az ml component list --name my-component --registry-name my-registry-name --resource-group my-resource-group

Вывод списка всех компонентов в реестре с помощью аргумента --query для выполнения запроса JMESPath в результатах команд.

az ml component list --query "[].{Name:name}"  --output table --registry-name my-registry-name --resource-group my-resource-group

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--archived-only

Список только архивированных компонентов.

Свойство Значение
Default value: False
--include-archived

Вывод списка архивированных компонентов и активных компонентов.

Свойство Значение
Default value: False
--max-results -r

Максимальное количество возвращаемых результатов.

--name -n

Имя компонента.

--registry-name

Если это указано, команда будет нацелена на реестр вместо рабочей области. Поэтому не требуется группа ресурсов и рабочая область.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--workspace-name -w

Имя рабочей области Azure машинного обучения. Вы можете настроить рабочую область по умолчанию с помощью az configure --defaults workspace=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az ml component prepare-for-sign

Подготовьте компонент для подписывания.

Подготовка компонента для подписи создает 2 файла: catalog.json и catalog.jsonSIG, эти файлы содержат SHA256, созданные для каждого файла, содержащегося в целевой папке. Если файлы уже присутствуют, они будут удалены, а новые файлы будут созданы с обновленной подписью.

az ml component prepare-for-sign --file
                                 [--acquire-policy-token]
                                 [--change-reference]
                                 [--registry-name]
                                 [--resource-group]
                                 [--workspace-name]

Примеры

Подготовка компонента из файла спецификации YAML для подписывания

az ml component prepare-for-sign --file my_component.yml --resource-group my-resource-group --workspace-name my-workspace

Подготовка компонента в реестре из файла спецификации YAML для подписывания

az ml component prepare-for-sign --file my_component.yml --registry-name my-registry-name --resource-group my-resource-group

Обязательные параметры

--file -f

Локальный путь к ФАЙЛу YAML, содержаному спецификацию компонента Azure машинного обучения. Справочные документы YAML для компонента можно найти по адресу: https://aka.ms/ml-cli-v2-component-command-yaml-reference.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--registry-name

Если это указано, команда будет нацелена на реестр вместо рабочей области. Поэтому не требуется группа ресурсов и рабочая область.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--workspace-name -w

Имя рабочей области Azure машинного обучения. Вы можете настроить рабочую область по умолчанию с помощью az configure --defaults workspace=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az ml component restore

Восстановление архивированного компонента.

При восстановлении архивного компонента он больше не будет скрыт из запросов списка (az ml component list). Если архивируется весь контейнер компонентов, можно восстановить архивированный контейнер. При этом будут восстановлены все версии компонента в соответствии с указанным именем. Вы не можете восстановить только определенную версию компонента, если весь контейнер компонентов архивирован, необходимо восстановить весь контейнер. Если архивирована только отдельная версия компонента, можно восстановить эту конкретную версию.

az ml component restore --name
                        [--acquire-policy-token]
                        [--change-reference]
                        [--label]
                        [--registry-name]
                        [--resource-group]
                        [--version]
                        [--workspace-name]

Примеры

Восстановление архивированного контейнера компонентов (восстанавливает все версии этого компонента)

az ml component restore --name my-component --resource-group my-resource-group --workspace-name my-workspace

Восстановление определенной архивной версии компонента

az ml component restore --name my-component --version 1 --resource-group my-resource-group --workspace-name my-workspace

Обязательные параметры

--name -n

Имя компонента.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--label -l

Метка компонента.

--registry-name

Если это указано, команда будет нацелена на реестр вместо рабочей области. Поэтому не требуется группа ресурсов и рабочая область.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--version -v

Версия компонента.

--workspace-name -w

Имя рабочей области Azure машинного обучения. Вы можете настроить рабочую область по умолчанию с помощью az configure --defaults workspace=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az ml component show

Отображение сведений о компоненте.

az ml component show --name
                     [--label]
                     [--registry-name]
                     [--resource-group]
                     [--version]
                     [--workspace-name]

Примеры

Отображение сведений о компоненте с указанным именем и версией

az ml component show --name my-component --version 1 --resource-group my-resource-group --workspace-name my-workspace

Отображение сведений о компоненте в реестре с указанным именем и версией

az ml component show --name my-component --version 1 --registry-name my-registry-name --resource-group my-resource-group

Обязательные параметры

--name -n

Имя компонента.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--label -l

Метка компонента.

--registry-name

Если это указано, команда будет нацелена на реестр вместо рабочей области. Поэтому не требуется группа ресурсов и рабочая область.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--version -v

Версия компонента.

--workspace-name -w

Имя рабочей области Azure машинного обучения. Вы можете настроить рабочую область по умолчанию с помощью az configure --defaults workspace=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az ml component update

Обновите компонент. В настоящее время поддерживается обновление только нескольких полей (описание, display_name).

az ml component update --name
                       --resource-group
                       --workspace-name
                       [--acquire-policy-token]
                       [--add]
                       [--change-reference]
                       [--force-string]
                       [--label]
                       [--registry-name]
                       [--remove]
                       [--set]
                       [--version]

Примеры

Обновление описания компонента

az ml component update -n my_component -v 1 --set description="new description" -g my-resource-group -w my-workspace

Обязательные параметры

--name -n

Имя компонента.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--workspace-name -w

Имя рабочей области Azure машинного обучения. Вы можете настроить рабочую область по умолчанию с помощью az configure --defaults workspace=<name>.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--add

Добавьте объект в список объектов, указав пары пути и значения ключа. Пример: --add property.listProperty <key=value, string or JSON string>.

Свойство Значение
Группа параметров: Generic Update Arguments
Default value: []
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--force-string

При использовании "set" или "add" сохраняйте строковые литералы вместо попытки преобразовать в JSON.

Свойство Значение
Группа параметров: Generic Update Arguments
Default value: False
--label -l

Метка компонента.

--registry-name

Если это указано, команда будет нацелена на реестр вместо рабочей области. Поэтому не требуется группа ресурсов и рабочая область.

--remove

Удалите свойство или элемент из списка. Пример: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Свойство Значение
Группа параметров: Generic Update Arguments
Default value: []
--set

Обновите объект, указав путь к свойству и значение для задания. Пример: --set property1.property2=<value>.

Свойство Значение
Группа параметров: Generic Update Arguments
Default value: []
--version -v

Версия компонента.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False