model-registry группа команд

Note

Эта информация относится к Интерфейсу командной строки Databricks версии 0.205 и выше. Интерфейс командной строки Databricks находится в общедоступной предварительной версии.

Использование интерфейса командной строки Databricks подчиняется лицензии Databricks и уведомлению о конфиденциальности Databricks, включая любые положения о данных использования.

Note

Эта справочная документация по API описывает API для реестра моделей рабочей области. Databricks рекомендует использовать модели в каталоге Unity . Модели в каталоге Unity обеспечивают централизованное управление моделями, доступ к моделям через рабочие области, отслеживание происхождения и развертывание. Реестр моделей рабочей области будет снят с использования в будущем.

Группа model-registry команд в интерфейсе командной строки Databricks позволяет управлять полным жизненным циклом моделей MLflow. Реестр моделей рабочей области — это централизованный репозиторий моделей и пользовательский интерфейс и набор API- интерфейсов, позволяющих управлять полным жизненным циклом моделей MLflow.

databricks регистрация моделей approve-transition-request

Подтвердите запрос на переход стадии версии модели.

databricks model-registry approve-transition-request NAME VERSION STAGE ARCHIVE_EXISTING_VERSIONS [flags]

Arguments

NAME

    Имя модели.

VERSION

    Версия модели.

STAGE

    Целевой этап перехода. Поддерживаемые значения: Archived, None, Production, Staging

ARCHIVE_EXISTING_VERSIONS

    Указывает, следует ли архивировать все текущие версии модели на целевом этапе.

Options

--comment string

    Предоставленный пользователем комментарий к действию.

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

Глобальные флаги

databricks модельный-реестр создать-комментарий

Опубликуйте комментарий к версии модели. Комментарий может быть отправлен пользователем или программным способом для отображения соответствующих сведений о модели. Например, результаты теста или ошибки развертывания.

databricks model-registry create-comment NAME VERSION COMMENT [flags]

Arguments

NAME

    Имя модели.

VERSION

    Версия модели.

COMMENT

    Предоставленный пользователем комментарий к действию.

Options

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

Глобальные флаги

Реестр моделей Databricks создание модели

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

Вызывает RESOURCE_ALREADY_EXISTS, если зарегистрированная модель с заданным именем существует.

databricks model-registry create-model NAME [flags]

Arguments

NAME

    Регистрация моделей под этим именем

Options

--description string

    Необязательное описание зарегистрированной модели.

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

Глобальные флаги

databricks реестр моделей создать-версию модели

Создайте версию модели.

databricks model-registry create-model-version NAME SOURCE [flags]

Arguments

NAME

    Регистрация модели под этим именем

SOURCE

    URI, указывающий расположение артефактов модели.

Options

--description string

    Необязательное описание версии модели.

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

--run-id string

    Идентификатор выполнения MLflow для корреляции, если источник был получен в результате запуска эксперимента на сервере отслеживания MLflow.

--run-link string

    Ссылка на запуск MLflow — это точная ссылка на запуск, создавший данную версию модели и потенциально размещенный в другом экземпляре MLflow.

Глобальные флаги

databricks registry моделей создание запроса на переход

Создайте запрос на переход стадии версии модели.

databricks model-registry create-transition-request NAME VERSION STAGE [flags]

Arguments

NAME

    Имя модели.

VERSION

    Версия модели.

STAGE

    Целевой этап перехода. Допустимые значения:

• Нет: начальный этап версии модели.
• Стадия подготовки: промежуточный или предварительный этап.
• Производство: этап производства.
• Этап архивирован.

Поддерживаемые значения: [Архивный, None, Production, Подготовка]

Options

--comment string

    Предоставленный пользователем комментарий к действию.

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

Глобальные флаги

databricks model-registry create-webhook

Note

Эта команда находится в общедоступной предварительной версии.

Создайте веб-перехватчик реестра.

databricks model-registry create-webhook [flags]

Arguments

None

Options

--description string

    Описание веб-перехватчика, заданное пользователем.

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

--model-name string

    Название модели, события которой активируют этот вебхук.

--status RegistryWebhookStatus

    Включите или отключите активацию веб-перехватчика или поместите веб-перехватчик в тестовый режим. Поддерживаемые значения: [ACTIVE, DISABLED, TEST_MODE]

Глобальные флаги

Команда databricks model-registry delete-comment

Удалите комментарий к версии модели.

databricks model-registry delete-comment ID [flags]

Arguments

ID

    Уникальный идентификатор комментария для удаления.

Options

Глобальные флаги

databricks модельный реестр delete-model

Удаление зарегистрированной модели.

databricks model-registry delete-model NAME [flags]

Arguments

NAME

    Идентификатор уникального имени зарегистрированной модели.

Options

Глобальные флаги

databricks model-registry delete-model-tag

Удалите тег для зарегистрированной модели.

databricks model-registry delete-model-tag NAME KEY [flags]

Arguments

NAME

    Имя зарегистрированной модели, под которым был зарегистрирован тег.

KEY

    Имя тега. Имя должно быть точным совпадением; удаление подстановочных символов не поддерживается. Максимальный размер составляет 250 байт.

Options

Глобальные флаги

удаление-версии-модели в реестре моделей databricks

Удалите версию модели.

databricks model-registry delete-model-version NAME VERSION [flags]

Arguments

NAME

    Имя зарегистрированной модели

VERSION

    Номер версии модели

Options

Глобальные флаги

удалить-тег-версии-модели в реестре-моделей databricks

Удаление тега версии модели.

databricks model-registry delete-model-version-tag NAME VERSION KEY [flags]

Arguments

NAME

    Имя зарегистрированной модели, под которым был зарегистрирован тег.

VERSION

    Номер версии модели, под которым тег был занесен в журнал.

KEY

    Имя тега. Имя должно быть точным совпадением; удаление подстановочных символов не поддерживается. Максимальный размер составляет 250 байт.

Options

Глобальные флаги

Databricks реестр моделей запрос на удаление перехода

Отмена запроса на переход стадии версии модели.

databricks model-registry delete-transition-request NAME VERSION STAGE CREATOR [flags]

Arguments

NAME

    Имя модели.

VERSION

    Версия модели.

STAGE

    Целевой этап запроса на переход. Допустимые значения:

• Нет: начальный этап версии модели.
• Стадия подготовки: промежуточный или предварительный этап.
• Производство: этап производства.
• Этап архивирован.

Поддерживаемые значения: [Архивный, None, Production, Подготовка]

CREATOR

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

Options

--comment string

    Предоставленный пользователем комментарий к действию.

Глобальные флаги

Databricks реестр моделей удалить вебхук

Note

Эта команда находится в общедоступной предварительной версии.

Удаляет веб-перехватчик реестра.

databricks model-registry delete-webhook [flags]

Arguments

None

Options

--id string

    Идентификатор вебхука необходим для удаления вебхука реестра.

Глобальные флаги

databricks model-registry get-latest-versions

Получите последнюю версию зарегистрированной модели.

databricks model-registry get-latest-versions NAME [flags]

Arguments

NAME

    Идентификатор уникального имени зарегистрированной модели.

Options

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

Глобальные флаги

databricks реестр моделей get-model

Узнать подробности о модели. Это версия рабочей области Databricks для конечной точки MLflow, которая также возвращает идентификатор рабочей области Databricks и уровень разрешений пользователю, запрашивающему доступ к модели.

databricks model-registry get-model NAME [flags]

Arguments

NAME

    Идентификатор уникального имени зарегистрированной модели.

Options

Глобальные флаги

databricks модель-регистрация get-model-version

Узнайте версию модели.

databricks model-registry get-model-version NAME VERSION [flags]

Arguments

NAME

    Имя зарегистрированной модели

VERSION

    Номер версии модели

Options

Глобальные флаги

Скачивание URI версии модели registry databricks

Получите URI для скачивания версии модели.

databricks model-registry get-model-version-download-uri NAME VERSION [flags]

Arguments

NAME

    Имя зарегистрированной модели

VERSION

    Номер версии модели

Options

Глобальные флаги

databricks model-registry list-models (список моделей в реестре Databricks)

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

databricks model-registry list-models [flags]

Arguments

None

Options

--max-results int

    Максимальное количество зарегистрированных моделей.

--page-token string

    Маркер разбиения на страницы для перехода на следующую страницу на основе предыдущего запроса.

Глобальные флаги

databricks model-registry list-transition-requests

Получите список всех открытых запросов на переход стадии для версии модели.

databricks model-registry list-transition-requests NAME VERSION [flags]

Arguments

NAME

    Имя модели.

VERSION

    Версия модели.

Options

Глобальные флаги

databricks model-registry list-webhooks

Note

Эта команда находится в общедоступной предварительной версии.

Перечислите все веб-перехватчики реестра.

databricks model-registry list-webhooks [flags]

Arguments

None

Options

--model-name string

    Если это не указано, перечислены все веб-перехватчики, связанные с указанными событиями, независимо от связанной модели.

--page-token string

    Маркер, указывающий страницу результатов артефактов для извлечения.

Глобальные флаги

Databricks model-registry отклонить запрос на смену состояния

Отклонить запрос на переход стадии версии модели.

databricks model-registry reject-transition-request NAME VERSION STAGE [flags]

Arguments

NAME

    Имя модели.

VERSION

    Версия модели.

STAGE

    Целевой этап перехода. Допустимые значения:

• Нет: начальный этап версии модели.
• Стадия подготовки: промежуточный или предварительный этап.
• Производство: этап производства.
• Этап архивирован.

Поддерживаемые значения: [Архивный, None, Production, Подготовка]

Options

--comment string

    Предоставленный пользователем комментарий к действию.

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

Глобальные флаги

Регистрация моделей в Databricks: переименовать модель

Переименуйте зарегистрированную модель.

databricks model-registry rename-model NAME [flags]

Arguments

NAME

    Идентификатор уникального имени зарегистрированной модели.

Options

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

--new-name string

    Если указано, обновите имя для этой registered_model.

Глобальные флаги

Используйте команду databricks model-registry search-model-versions, чтобы искать версии моделей.

Выполните поиск определенных версий модели на основе предоставленного фильтра.

databricks model-registry search-model-versions [flags]

Arguments

None

Options

--filter string

    Условие фильтра строк, например name='my-model-name'.

--max-results int

    Максимальное количество нужных моделей.

--page-token string

    Маркер разбиения на страницы для перехода на следующую страницу на основе предыдущего поискового запроса.

Глобальные флаги

Databricks model-registry search-models (поиск моделей)

Выполните поиск зарегистрированных моделей на основе указанного фильтра.

databricks model-registry search-models [flags]

Arguments

None

Options

--filter string

    Условие фильтра строк, например "name LIKE 'my-model-name'".

--max-results int

    Максимальное количество нужных моделей.

--page-token string

    Маркер разбиения на страницы для перехода на следующую страницу на основе предыдущего поискового запроса.

Глобальные флаги

Databricks модель-регистрация установить-тег-модели

Задайте тег для зарегистрированной модели.

databricks model-registry set-model-tag NAME KEY VALUE [flags]

Arguments

NAME

    Уникальное имя модели.

KEY

    Имя тега. Максимальный размер зависит от серверной части хранилища. Если тег с этим именем уже существует, его предварительно существующее значение будет заменено указанным значением. Все системы хранения данных гарантированно поддерживают значения ключей размером до 250 байт.

VALUE

    Строковое значение тега, регистрируемого. Максимальный размер зависит от серверной части хранилища. Все бэкенды хранилища гарантированно поддерживают пары ключ-значение размером до 5000 байт.

Options

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

Глобальные флаги

databricks model-registry set-model-version-tag

Задайте тег версии модели.

databricks model-registry set-model-version-tag NAME VERSION KEY VALUE [flags]

Arguments

NAME

    Уникальное имя модели.

VERSION

    Номер версии модели.

KEY

    Имя тега. Максимальный размер зависит от серверной части хранилища. Если тег с этим именем уже существует, его предварительно существующее значение будет заменено указанным значением. Все системы хранения данных гарантированно поддерживают значения ключей размером до 250 байт.

VALUE

    Строковое значение тега, регистрируемого. Максимальный размер зависит от серверной части хранилища. Все бэкенды хранилища гарантированно поддерживают пары ключ-значение размером до 5000 байт.

Options

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

Глобальные флаги

databricks model-registry test-registry-webhook

Note

Эта команда находится в общедоступной предварительной версии.

Проверьте веб-перехватчик реестра.

databricks model-registry test-registry-webhook ID [flags]

Arguments

ID

    Идентификатор веб-перехватчика

Options

--event RegistryWebhookEvent

    Если задано событие, триггер теста использует указанное событие. Поддерживаемые значения: [ COMMENT_CREATED, MODEL_VERSION_CREATED, MODEL_VERSION_TAG_SET, MODEL_VERSION_TRANSITIONED_STAGE, MODEL_VERSION_TRANSITIONED_TO_ARCHIVED, MODEL_VERSION_TRANSITIONED_TO_PRODUCTION, MODEL_VERSION_TRANSITIONED_TO_STAGING, REGISTERED_MODEL_CREATED, TRANSITION_REQUEST_CREATED, TRANSITION_REQUEST_TO_ARCHIVED_CREATED, TRANSITION_REQUEST_TO_PRODUCTION_CREATED, TRANSITION_REQUEST_TO_STAGING_CREATED ]

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

Глобальные флаги

этап перехода реестра моделей databricks

Переход этапа версии модели. Это версия рабочей области Databricks, поддерживающая конечную точку MLflow, которая также принимает комментарий, связанный с фиксируемым переходом.

databricks model-registry transition-stage NAME VERSION STAGE ARCHIVE_EXISTING_VERSIONS [flags]

Arguments

NAME

    Имя модели.

VERSION

    Версия модели.

STAGE

    Целевой этап перехода. Допустимые значения:

• Нет: начальный этап версии модели.
• Стадия подготовки: промежуточный или предварительный этап.
• Производство: этап производства.
• Этап архивирован.

Поддерживаемые значения: [Архивный, None, Production, Подготовка]

ARCHIVE_EXISTING_VERSIONS

    Указывает, следует ли архивировать все текущие версии модели на целевом этапе.

Options

--comment string

    Предоставленный пользователем комментарий к действию.

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

Глобальные флаги

databricks модель-регистрация обновить-комментарий

Опубликовать изменение комментария к версии модели.

databricks model-registry update-comment ID COMMENT [flags]

Arguments

ID

    Уникальный идентификатор действия

COMMENT

    Предоставленный пользователем комментарий к действию.

Options

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

Глобальные флаги

databricks model-registry обновление модели

Обновление зарегистрированной модели.

databricks model-registry update-model NAME [flags]

Arguments

NAME

    Идентификатор уникального имени зарегистрированной модели.

Options

--description string

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

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

Глобальные флаги

databricks model-registry обновление версии модели

Обновите версию модели.

databricks model-registry update-model-version NAME VERSION [flags]

Arguments

NAME

    Имя зарегистрированной модели

VERSION

    Номер версии модели

Options

--description string

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

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

Глобальные флаги

databricks модель-реестр обновить-вебхук

Note

Эта команда находится в общедоступной предварительной версии.

Обновите вебхук реестра.

databricks model-registry update-webhook ID [flags]

Arguments

ID

    Идентификатор веб-перехватчика

Options

--description string

    Описание веб-перехватчика, заданное пользователем.

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

--status RegistryWebhookStatus

    Включите или отключите активацию веб-перехватчика или поместите веб-перехватчик в тестовый режим. Поддерживаемые значения: [ACTIVE, DISABLED, TEST_MODE]

Глобальные флаги

databricks model-registry get-permission-levels

Получить уровни разрешений для зарегистрированной модели.

databricks model-registry get-permission-levels REGISTERED_MODEL_ID [flags]

Arguments

REGISTERED_MODEL_ID

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

Options

Глобальные флаги

databricks модель-регистратор получить-разрешения

Получает разрешения зарегистрированной модели. Зарегистрированные модели могут наследовать разрешения от корневого объекта.

databricks model-registry get-permissions REGISTERED_MODEL_ID [flags]

Arguments

REGISTERED_MODEL_ID

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

Options

Глобальные флаги

databricks model-registry назначить права доступа

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

databricks model-registry set-permissions REGISTERED_MODEL_ID [flags]

Arguments

REGISTERED_MODEL_ID

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

Options

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

Глобальные флаги

databricks модель-регистр обновить разрешения

Обновите разрешения для зарегистрированной модели. Зарегистрированные модели могут наследовать разрешения от корневого объекта.

databricks model-registry update-permissions REGISTERED_MODEL_ID [flags]

Arguments

REGISTERED_MODEL_ID

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

Options

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

Глобальные флаги

Глобальные флаги

--debug

  Следует ли включить ведение журнала отладки.

-h или --help

    Отобразить справку по интерфейсу командной строки Databricks, связанной группе команд или отдельной команде.

--log-file струна

    Строка, представляющая файл для записи журналов выходных данных. Если этот флаг не указан, по умолчанию используется запись журналов выходных данных в stderr.

--log-format формат

    Тип формата журнала: text или json. Значение по умолчанию — text.

--log-level струна

    Строка, представляющая уровень формата журнала. Если не указано, уровень формата журнала отключен.

типа -o, --output

    Тип выходных данных команды: text или json. Значение по умолчанию — text.

-p, --profile струна

    Имя профиля в ~/.databrickscfg файле, используемого для выполнения команды. Если флаг не указан, используется профиль DEFAULT, если он существует.

--progress-format формат

    Формат для отображения журналов хода выполнения: default, appendinplace, илиjson

-t, --target струна

    Если применимо, целевой объект пакета для использования