describe-model-package

Описание

Возвращает описание указанного пакета модели, который используется для создания моделей SageMaker или их перечисления на Amazon Web Services Marketplace.

Предупреждение

Если вы указали KMS Key ID при создании пакета модели, вы увидите вызов API KMS Decrypt в ваших логах CloudTrail при использовании этого API.

Чтобы создавать модели в SageMaker, покупатели могут подписаться на пакеты моделей, перечисленные на Amazon Web Services Marketplace.

См. также: AWS API Documentation

Сводка

  describe-model-package
--model-package-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Опции

--model-package-name (string)

Имя или Amazon Resource Name (ARN) пакета модели для описания.

При указании имени, имя должно содержать от 1 до 63 символов. Допустимые символы: a-z, A-Z, 0-9 и - (дефис).

--cli-input-json | --cli-input-yaml (string) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы указаны в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения, используя значение, предоставленное в JSON, поскольку строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (string) Выводит скелет JSON в стандартный вывод без отправки запроса API. Если предоставлено без значения или со значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, он проверит входные данные команды и вернет пример выходного JSON для этой команды. Сгенерированный скелет JSON не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном скелете JSON.

Глобальные опции

--debug (boolean)

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

--endpoint-url (string)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с сервисами AWS. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Эта опция переопределяет поведение по умолчанию проверки SSL-сертификатов.

--no-paginate (boolean)

Отключить автоматическое разбиение на страницы. Если автоматическое разбиение на страницы отключено, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования для вывода команды.

json
text
table
yaml
yaml-stream

--query (string)

Запрос JMESPath для использования при фильтрации данных ответа.

--profile (string)

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

--region (string)

Регион для использования. Переопределяет настройки config/env.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/выключить цветной вывод.

on
off
auto

--no-sign-request (boolean)

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

--ca-bundle (string)

Пакет сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки config/env.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокироваться и не истечет по таймауту. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокироваться и не истечет по таймауту. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования, который будет использоваться для двоичных больших объектов. Формат по умолчанию — base64. Формат base64 предполагает, что двоичные большие объекты будут предоставлены в виде строки с кодировкой base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое сопоставляется с двоичным большим объектом, fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла напрямую, независимо от параметра cli-binary-format. При использовании file:// содержимое файла необходимо правильно отформатировать для настроенного cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Отключить пейджер cli для вывода.

--cli-auto-prompt (boolean)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматический запрос параметров ввода CLI.

Output

ModelPackageName -> (string)

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

ModelPackageGroupName -> (string)

Если модель является версионной, имя группы модели, к которой принадлежит версионная модель.

ModelPackageVersion -> (integer)

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

ModelPackageArn -> (string)

Имя ресурса Amazon (ARN) пакета модели.

ModelPackageDescription -> (string)

Краткое описание пакета модели.

CreationTime -> (timestamp)

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

InferenceSpecification -> (structure)

Подробности о заданиях вывода, которые можно запускать с моделями на основе этого пакета модели.

Containers -> (list)

Путь реестра Amazon ECR образа Docker, содержащего код вывода.

(structure)

Описывает контейнер Docker для пакета модели.

ContainerHostname -> (string)

Имя хоста DNS для контейнера Docker.

Image -> (string)

Путь Amazon Elastic Container Registry (Amazon ECR), где хранится код вывода.

Если вы используете собственный пользовательский алгоритм вместо алгоритма, предоставленного SageMaker, код вывода должен соответствовать требованиям SageMaker. SageMaker поддерживает оба формата путей изображений registry/repository[:tag] и registry/repository[@digest]. Дополнительные сведения см. в разделе Использование собственных алгоритмов с Amazon SageMaker .

ImageDigest -> (string)

Хэш MD5 алгоритма обучения, который идентифицирует образ Docker, используемый для обучения.

ModelDataUrl -> (string)

Путь Amazon S3, где хранятся артефакты модели, полученные в результате обучения модели. Этот путь должен указывать на один gzip сжатый архив tar (.tar.gz суффикс).

Примечание

Артефакты модели должны находиться в корзине S3, которая находится в том же регионе, что и пакет модели.

ModelDataSource -> (structure)

Указывает местоположение данных модели ML для развертывания при создании конечной точки.

S3DataSource -> (structure)

Указывает местоположение данных модели ML в S3 для развертывания.

S3Uri -> (string)

Указывает путь S3 данных модели ML для развертывания.

S3DataType -> (string)

Указывает тип данных модели ML для развертывания.

Если вы выберете S3Prefix , S3Uri идентифицирует префикс имени ключа. SageMaker использует все объекты, соответствующие указанному префиксу имени ключа, как часть данных модели ML для развертывания. Допустимый префикс имени ключа, определяемый S3Uri , всегда заканчивается косой чертой (/).

Если вы выберете S3Object , S3Uri идентифицирует объект, который является данными модели ML для развертывания.

CompressionType -> (string)

Указывает, как подготовлены данные модели ML.

Если вы выберете Gzip и выберете S3Object в качестве значения S3DataType , S3Uri идентифицирует объект, который представляет собой архив TAR, сжатый с помощью gzip. SageMaker попытается распаковать и распаковать объект во время развертывания модели.

Если вы выберете None и выберете S3Object в качестве значения S3DataType , S3Uri идентифицирует объект, который представляет нераспакованную модель ML для развертывания.

Если вы выберете None и выберете S3Prefix в качестве значения S3DataType , S3Uri идентифицирует префикс имени ключа, под которым все объекты представляют нераспакованную модель ML для развертывания.

Если вы выберете None, SageMaker будет следовать правилам ниже при создании файлов данных модели в каталоге /opt/ml/model для использования вашим кодом вывода:

Если вы выберете S3Object в качестве значения S3DataType , SageMaker разделит ключ объекта S3, на который ссылается S3Uri , косой чертой (/), и использует последнюю часть в качестве имени файла, содержащего содержимое объекта S3.
Если вы выберете S3Prefix в качестве значения S3DataType , то для каждого объекта S3 под префиксом имени ключа, на который ссылается S3Uri , SageMaker обрежет его ключ по префиксу и использует остаток в качестве пути (относительно /opt/ml/model ) файла, содержащего содержимое объекта S3. SageMaker разделит остаток косой чертой (/), используя промежуточные части в качестве имен каталогов и последнюю часть в качестве имени файла, содержащего содержимое объекта S3.
Не используйте ничего из следующего в качестве имен файлов или каталогов:
- Пустая или пустая строка
- Строка, содержащая нулевые байты
- Строка длиной более 255 байт
- Одна точка (. )
- Двойная точка (.. )
Неоднозначные имена файлов приведут к сбою развертывания модели. Например, если ваша нераспакованная модель ML состоит из двух объектов S3 s3://mybucket/model/weights и s3://mybucket/model/weights/part1 , и вы укажете s3://mybucket/model/ в качестве значения S3Uri и S3Prefix в качестве значения S3DataType , то это приведет к конфликту имен между /opt/ml/model/weights (обычный файл) и /opt/ml/model/weights/ (каталог).
Не упорядочивайте артефакты модели в консоли S3 с помощью папок. Когда вы создаете папку в консоли S3, S3 создает объект размером 0 байт с ключом, установленным в имя папки, которое вы предоставляете. Ключ объекта размером 0 байт заканчивается косой чертой (/), что нарушает ограничения SageMaker на имена файлов артефактов модели, что приводит к сбою развертывания модели.

ModelAccessConfig -> (structure)

Указывает файл конфигурации доступа для модели ML. Вы можете явно принять лицензионное соглашение конечного пользователя (EULA) модели в ModelAccessConfig . Вы несете ответственность за ознакомление и соблюдение любых применимых условий лицензии и обеспечение их приемлемости для вашего варианта использования перед загрузкой или использованием модели.

AcceptEula -> (boolean)

Указывает согласие с лицензионным соглашением конечного пользователя (EULA) модели. Значение AcceptEula должно быть явно определено как True , чтобы принять EULA, требуемую этой моделью. Вы несете ответственность за ознакомление и соблюдение любых применимых условий лицензии и обеспечение их приемлемости для вашего варианта использования перед загрузкой или использованием модели.

HubAccessConfig -> (structure)

Информация о конфигурации для доступа к концентратору.

HubContentArn -> (string)

ARN контента концентратора, для которого разрешен доступ к развертыванию.

ManifestS3Uri -> (string)

URI Amazon S3 файла манифеста. Файл манифеста — это CSV-файл, в котором хранятся местоположения артефактов.

ETag -> (string)

ETag, связанный с URI S3.

ManifestEtag -> (string)

ETag, связанный с URI манифеста S3.

ProductId -> (string)

Идентификатор продукта Amazon Web Services Marketplace пакета модели.

Environment -> (map)

Переменные среды, которые необходимо задать в контейнере Docker. Каждому ключу и значению в строке Environment в строку сопоставления может быть длина до 1024. Мы поддерживаем до 16 записей в карте.

key -> (string)

value -> (string)

ModelInput -> (structure)

Структура с данными Model Input.

DataInputConfig -> (string)

Объект конфигурации ввода для модели.

Framework -> (string)

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

FrameworkVersion -> (string)

Версия фреймворка образа контейнера пакета модели.

NearestModelName -> (string)

Имя предварительно обученной модели машинного обучения, сопоставленной Amazon SageMaker Inference Recommender, которая соответствует вашей модели. Список моделей, прошедших бенчмаркинг, можно найти, вызвав ListModelMetadata .

AdditionalS3DataSource -> (structure)

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

S3DataType -> (string)

Тип данных дополнительного источника данных, который вы указываете для использования при выводе или обучении.

S3Uri -> (string)

Унифицированный идентификатор ресурса (URI), используемый для идентификации дополнительного источника данных, используемого при выводе или обучении.

CompressionType -> (string)

Тип сжатия, используемый для дополнительного источника данных, используемого при выводе или обучении. Укажите None , если ваш дополнительный источник данных не сжат.

ETag -> (string)

ETag, связанный с URI S3.

ModelDataETag -> (string)

ETag, связанный с URL-адресом данных модели.

SupportedTransformInstanceTypes -> (list)

Список типов экземпляров, в которых можно запустить задание преобразования или на которых можно развернуть конечную точку.

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

(string)

SupportedRealtimeInferenceInstanceTypes -> (list)

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

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

(string)

SupportedContentTypes -> (list)

Поддерживаемые типы MIME для входных данных.

(string)

SupportedResponseMIMETypes -> (list)

Поддерживаемые типы MIME для выходных данных.

(string)

SourceAlgorithmSpecification -> (structure)

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

SourceAlgorithms -> (list)

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

(structure)

Указывает алгоритм, который использовался для создания пакета модели. Алгоритм должен быть либо ресурсом алгоритма в вашей учетной записи SageMaker, либо алгоритмом в Amazon Web Services Marketplace, на который вы подписаны.

ModelDataUrl -> (string)

Путь Amazon S3, где хранятся артефакты модели, которые являются результатом обучения модели. Этот путь должен указывать на один gzip сжатый архив tar (.tar.gz суффикс).

Примечание

Артефакты модели должны находиться в корзине S3, которая находится в том же регионе Amazon Web Services, что и алгоритм.

ModelDataSource -> (structure)

Указывает местоположение данных модели ML для развертывания во время создания конечной точки.

S3DataSource -> (structure)

Указывает местоположение S3 данных модели ML для развертывания.

S3Uri -> (string)

Указывает путь S3 к данным модели ML для развертывания.

S3DataType -> (string)

Указывает тип данных модели ML для развертывания.

Если вы выберете S3Prefix , S3Uri определяет префикс имени ключа. SageMaker использует все объекты, соответствующие указанному префиксу имени ключа, как часть данных модели ML для развертывания. Допустимый префикс имени ключа, определяемый S3Uri , всегда заканчивается косой чертой (/).

Если вы выберете S3Object , S3Uri определяет объект, который является данными модели ML для развертывания.

CompressionType -> (string)

Указывает, как подготовлены данные модели ML.

Если вы выберете Gzip и выберете S3Object в качестве значения S3DataType , S3Uri определяет объект, представляющий собой архив TAR, сжатый gzip. SageMaker попытается распаковать и разархивировать объект во время развертывания модели.

Если вы выберете None и выберете S3Object в качестве значения S3DataType , S3Uri определяет объект, представляющий несжатую модель ML для развертывания.

Если вы выберете None и выберете S3Prefix в качестве значения S3DataType , S3Uri определяет префикс имени ключа, под которым все объекты представляют несжатую модель ML для развертывания.

Если вы выберете None, то SageMaker будет следовать приведенным ниже правилам при создании файлов данных модели в каталоге /opt/ml/model для использования вашим кодом вывода:

Если вы выберете S3Object в качестве значения S3DataType , то SageMaker разделит ключ объекта S3, на который ссылается S3Uri , косой чертой (/), и использует последнюю часть в качестве имени файла, содержащего содержимое объекта S3.
Если вы выберете S3Prefix в качестве значения S3DataType , то для каждого объекта S3 под префиксом имени ключа, на который ссылается S3Uri , SageMaker обрежет его ключ по префиксу и использует остаток в качестве пути (относительно /opt/ml/model ) файла, содержащего содержимое объекта S3. SageMaker разделит остаток косой чертой (/), используя промежуточные части в качестве имен каталогов и последнюю часть в качестве имени файла файла, содержащего содержимое объекта S3.
Не используйте ничего из следующего в качестве имен файлов или имен каталогов:
- Пустая или пустая строка
- Строка, содержащая нулевые байты
- Строка длиннее 255 байт
- Одна точка (. )
- Двойная точка (.. )
Неоднозначные имена файлов приведут к сбою развертывания модели. Например, если ваша несжатая модель ML состоит из двух объектов S3 s3://mybucket/model/weights и s3://mybucket/model/weights/part1 , и вы укажете s3://mybucket/model/ в качестве значения S3Uri и S3Prefix в качестве значения S3DataType , то это приведет к конфликту имен между /opt/ml/model/weights (обычным файлом) и /opt/ml/model/weights/ (каталогом).
Не организуйте артефакты модели в консоли S3 с использованием папок. Когда вы создаете папку в консоли S3, S3 создает объект размером 0 байт с ключом, равным имени папки, которое вы указали. Ключ объекта размером 0 байт заканчивается косой чертой (/), что нарушает ограничения SageMaker на имена файлов артефактов модели, что приводит к сбою развертывания модели.

ModelAccessConfig -> (structure)

Указывает файл конфигурации доступа для модели ML. Вы можете явно принять лицензионное соглашение конечного пользователя модели (EULA) в рамках ModelAccessConfig . Вы несете ответственность за проверку и соблюдение любых применимых условий лицензии и убедитесь, что они приемлемы для вашего варианта использования, прежде чем загружать или использовать модель.

AcceptEula -> (boolean)

Указывает согласие с лицензионным соглашением конечного пользователя модели (EULA). AcceptEula значение должно быть явно определено как True , чтобы принять EULA, требуемую этой моделью. Вы несете ответственность за проверку и соблюдение любых применимых условий лицензии и убедитесь, что они приемлемы для вашего варианта использования, прежде чем загружать или использовать модель.

HubAccessConfig -> (structure)

Информация о конфигурации для доступа к концентратору.

HubContentArn -> (string)

ARN содержимого концентратора, для которого разрешен доступ к развертыванию.

ManifestS3Uri -> (string)

URI манифеста Amazon S3. Файл манифеста — это CSV-файл, в котором хранятся местоположения артефактов.

ETag -> (string)

ETag, связанный с URI S3.

ManifestEtag -> (string)

ETag, связанный с Manifest S3 URI.

ModelDataETag -> (string)

ETag, связанный с URL-адресом данных модели.

AlgorithmName -> (string)

Имя алгоритма, который использовался для создания пакета модели. Алгоритм должен быть либо ресурсом алгоритма в вашей учетной записи SageMaker, либо алгоритмом в Amazon Web Services Marketplace, на который вы подписаны.

ValidationSpecification -> (structure)

Конфигурации для одного или нескольких заданий преобразования, которые SageMaker запускает для тестирования пакета модели.

ValidationRole -> (string)

Роли IAM, которые будут использоваться для проверки пакета модели.

ValidationProfiles -> (list)

Массив объектов ModelPackageValidationProfile, каждый из которых определяет задание пакетного преобразования, которое SageMaker запускает для проверки вашего пакета модели.

(structure)

Содержит данные, такие как входные данные и целевые типы экземпляров, которые используются в процессе проверки пакета модели.

Данные, предоставленные в профиле проверки, доступны вашим покупателям на Amazon Web Services Marketplace.

ProfileName -> (string)

Имя профиля для пакета модели.

TransformJobDefinition -> (structure)

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

MaxConcurrentTransforms -> (integer)

Максимальное количество параллельных запросов, которые могут быть отправлены каждому экземпляру в задании преобразования. Значение по умолчанию — 1.

MaxPayloadInMB -> (integer)

Максимальный размер полезных данных в МБ. Полезные данные — это часть записи данных (без метаданных).

BatchStrategy -> (string)

Строка, определяющая количество записей, включенных в один мини-пакет.

SingleRecord означает, что для каждого мини-пакета используется только одна запись. MultiRecord означает, что мини-пакет должен содержать как можно больше записей, которые могут поместиться в пределы MaxPayloadInMB.

Environment -> (map)

Переменные среды, которые необходимо установить в контейнере Docker. Мы поддерживаем до 16 записей ключей и значений в карте.

key -> (string)

value -> (string)

TransformInput -> (structure)

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

DataSource -> (structure)

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

S3DataSource -> (structure)

Местоположение данных в S3 для источника данных, связанного с каналом.

S3DataType -> (string)

Если вы выберете S3Prefix, S3Uri идентифицирует префикс имени ключа. Amazon SageMaker использует все объекты с указанным префиксом имени ключа для пакетного преобразования.

Если вы выберете ManifestFile, S3Uri идентифицирует объект, который представляет собой файл манифеста, содержащий список ключей объектов, которые вы хотите, чтобы Amazon SageMaker использовал для пакетного преобразования.

Совместимы следующие значения: ManifestFile, S3Prefix

Следующее значение несовместимо: AugmentedManifestFile

S3Uri -> (string)

В зависимости от значения, указанного для S3DataType, идентифицирует либо префикс имени ключа, либо манифест. Например:

Префикс имени ключа может выглядеть так: s3://bucketname/exampleprefix/.
Манифест может выглядеть так: s3://bucketname/example.manifest Манифест — это объект S3, представляющий собой файл JSON со следующим форматом: [ {"prefix": "s3://customer_bucket/some/prefix/"}, "relative/path/to/custdata-1", "relative/path/custdata-2", ... "relative/path/custdata-N" ] Приведенный выше код JSON соответствует следующему S3Uris: s3://customer_bucket/some/prefix/relative/path/to/custdata-1 s3://customer_bucket/some/prefix/relative/path/custdata-2 ... s3://customer_bucket/some/prefix/relative/path/custdata-N Полный набор S3Uris в этом манифесте составляет входные данные для канала для этого источника данных. Объект, на который указывает каждый S3Uris, должен быть доступен для чтения роли IAM, которую Amazon SageMaker использует для выполнения задач от вашего имени.

ContentType -> (string)

Многоцелевой тип интернет-почтового расширения (MIME) данных. Amazon SageMaker использует тип MIME с каждым вызовом http для передачи данных в задание преобразования.

CompressionType -> (string)

Если ваши данные преобразования сжаты, укажите тип сжатия. Amazon SageMaker автоматически распаковывает данные для задания преобразования соответствующим образом. Значение по умолчанию — None.

SplitType -> (string)

Метод, используемый для разделения файлов данных задания преобразования на меньшие пакеты. Разделение необходимо, когда общий размер каждого объекта слишком велик, чтобы поместиться в один запрос. Вы также можете использовать разделение данных для повышения производительности за счет обработки нескольких параллельных мини-пакетов. Значение по умолчанию для SplitType — None, что указывает на то, что файлы входных данных не разделяются, а полезные данные запроса содержат все содержимое входного объекта. Установите значение этого параметра в Line, чтобы разделить записи по границе символа новой строки. SplitType также поддерживает ряд форматов двоичных данных, ориентированных на записи. В настоящее время поддерживаются следующие форматы записей:

RecordIO
TFRecord

При включенном разделении размер мини-пакета зависит от значений параметров BatchStrategy и MaxPayloadInMB. Когда значение BatchStrategy равно MultiRecord, Amazon SageMaker отправляет максимальное количество записей в каждом запросе, до лимита MaxPayloadInMB. Если значение BatchStrategy равно SingleRecord, Amazon SageMaker отправляет отдельные записи в каждом запросе.

Примечание

Некоторые форматы данных представляют запись в виде двоичных полезных данных, завернутых дополнительными байтами заполнения. Когда разделение применяется к формату двоичных данных, заполнение удаляется, если для значения BatchStrategy установлено значение SingleRecord. Заполнение не удаляется, если для значения BatchStrategy установлено значение MultiRecord.

Дополнительные сведения о RecordIO см. в разделе Create a Dataset Using RecordIO (Создание набора данных с помощью RecordIO) в документации MXNet. Дополнительные сведения о TFRecord см. в разделе Consuming TFRecord data (Использование данных TFRecord) в документации TensorFlow.

TransformOutput -> (structure)

Определяет местоположение Amazon S3, в котором вы хотите, чтобы Amazon SageMaker сохранял результаты задания преобразования.

S3OutputPath -> (string)

Путь Amazon S3, по которому вы хотите, чтобы Amazon SageMaker сохранял результаты задания преобразования. Например, s3://bucket-name/key-name-prefix.

Для каждого объекта S3, используемого в качестве входных данных для задания преобразования, пакетное преобразование сохраняет преобразованные данные с суффиксом .``out`` в соответствующей подпапке в местоположении в префиксе вывода. Например, для входных данных, хранящихся в s3://bucket-name/input-name-prefix/dataset01/data.csv, пакетное преобразование сохраняет преобразованные данные в s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out. Пакетное преобразование не загружает частично обработанные объекты. Для входного объекта S3, содержащего несколько записей, оно создает файл .``out`` только в том случае, если задание преобразования завершается успешно для всего файла. Когда входные данные содержат несколько объектов S3, задание пакетного преобразования обрабатывает перечисленные объекты S3 и загружает только выходные данные для успешно обработанных объектов. Если какой-либо объект завершается неудачей в задании преобразования, пакетное преобразование помечает задание как неудачное, чтобы предложить расследование.

Accept -> (string)

Тип MIME, используемый для указания выходных данных. Amazon SageMaker использует тип MIME с каждым вызовом http для передачи данных из задания преобразования.

AssembleWith -> (string)

Определяет, как собрать результаты задания преобразования в виде одного объекта S3. Выберите формат, который наиболее удобен для вас. Чтобы объединить результаты в двоичном формате, укажите None. Чтобы добавить символ новой строки в конце каждой преобразованной записи, укажите Line.

KmsKeyId -> (string)

Ключ Amazon Web Services Key Management Service (Amazon Web Services KMS), который Amazon SageMaker использует для шифрования артефактов модели в состоянии покоя с использованием шифрования на стороне сервера Amazon S3. KmsKeyId может быть в любом из следующих форматов:

Идентификатор ключа: 1234abcd-12ab-34cd-56ef-1234567890ab
ARN ключа: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Имя псевдонима: alias/ExampleAlias
ARN имени псевдонима: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

Если вы не предоставите идентификатор ключа KMS, Amazon SageMaker использует ключ KMS по умолчанию для Amazon S3 для учетной записи вашей роли. Дополнительные сведения см. в разделе Ключи шифрования, управляемые KMS, в Руководстве разработчика Amazon Simple Storage Service.

Политика ключа KMS должна предоставлять разрешение роли IAM, которую вы указываете в запросе CreateModel. Дополнительные сведения см. в разделе Использование политик ключей в Amazon Web Services KMS в Руководстве разработчика Amazon Web Services Key Management Service.

TransformResources -> (structure)

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

InstanceType -> (string)

Тип вычислительного экземпляра ML для задания преобразования. Если вы используете встроенные алгоритмы для преобразования наборов данных умеренного размера, мы рекомендуем использовать типы экземпляров ml.m4.xlarge или ml.m5.large.

InstanceCount -> (integer)

Количество вычислительных экземпляров ML для использования в задании преобразования. Значение по умолчанию — 1, а максимальное — 100. Для распределенных заданий преобразования укажите значение больше 1.

VolumeKmsKeyId -> (string)

Ключ Amazon Web Services Key Management Service (Amazon Web Services KMS), который Amazon SageMaker использует для шифрования данных модели на томе хранилища, прикрепленном к вычислительным экземплярам ML, которые запускают задание пакетного преобразования.

Примечание

Определенные экземпляры на базе Nitro включают локальное хранилище, в зависимости от типа экземпляра. Тома локального хранилища шифруются с использованием аппаратного модуля на экземпляре. Нельзя запросить VolumeKmsKeyId при использовании типа экземпляра с локальным хранилищем.

Список типов экземпляров, поддерживающих локальное хранилище экземпляров, см. в разделе Volumes of the Instance Store (Тома хранилища экземпляров).

Дополнительные сведения о шифровании локального хранилища экземпляров см. в разделе SSD Instance Store Volumes (Тома SSD хранилища экземпляров).

VolumeKmsKeyId может быть в любом из следующих форматов:

Идентификатор ключа: 1234abcd-12ab-34cd-56ef-1234567890ab
ARN ключа: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Имя псевдонима: alias/ExampleAlias
ARN имени псевдонима: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

TransformAmiVersion -> (string)

Указывает параметр из коллекции предварительно настроенных образов Amazon Machine Image (AMI). Каждый образ настроен Amazon Web Services с набором версий программного обеспечения и драйверов.

al2-ami-sagemaker-batch-gpu-470

Ускоритель: GPU
Версия драйвера NVIDIA: 470

al2-ami-sagemaker-batch-gpu-535
Ускоритель: GPU
Версия драйвера NVIDIA: 535

ModelPackageStatus -> (string)

Текущий статус пакета модели.

ModelPackageStatusDetails -> (structure)

Детали о текущем статусе пакета модели.

ValidationStatuses -> (list)

Статус валидации пакета модели.

(structure)

Представляет общий статус пакета модели.

Name -> (string)

Имя пакета модели, для которого сообщается общий статус.

Status -> (string)

Текущий статус.

FailureReason -> (string)

если общий статус Failed , причина сбоя.

ImageScanStatuses -> (list)

Статус сканирования контейнера Docker image для пакета модели.

(structure)

Представляет общий статус пакета модели.

Name -> (string)

Имя пакета модели, для которого сообщается общий статус.

Status -> (string)

Текущий статус.

FailureReason -> (string)

если общий статус Failed , причина сбоя.

CertifyForMarketplace -> (boolean)

Сертифицирован ли пакет модели для размещения в Amazon Web Services Marketplace.

ModelApprovalStatus -> (string)

Статус одобрения пакета модели.

CreatedBy -> (structure)

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

UserProfileArn -> (string)

Имя ресурса Amazon (ARN) профиля пользователя.

UserProfileName -> (string)

Имя профиля пользователя.

DomainId -> (string)

Домен, связанный с пользователем.

IamIdentity -> (structure)

Сведения об идентификации IAM, связанные с пользователем. Эти сведения связаны только с группами пакетов моделей, пакетами моделей и сущностями проекта.

Arn -> (string)

Имя ресурса Amazon (ARN) идентификации IAM.

PrincipalId -> (string)

ID принципала, который принимает идентификацию IAM.

SourceIdentity -> (string)

Лицо или приложение, которое принимает идентификацию IAM.

MetadataProperties -> (structure)

Свойства метаданных сущности отслеживания, испытания или компонента испытания.

CommitId -> (string)

ID коммита.

Repository -> (string)

Репозиторий.

GeneratedBy -> (string)

Сущность, сгенерированная этой сущностью.

ProjectId -> (string)

ID проекта.

ModelMetrics -> (structure)

Метрики для модели.

ModelQuality -> (structure)

Метрики, которые измеряют качество модели.

Statistics -> (structure)

Статистика качества модели.

ContentType -> (string)

Тип контента источника метрики.

ContentDigest -> (string)

Хэш-ключ, используемый для источника метрик.

S3Uri -> (string)

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

Constraints -> (structure)

Ограничения качества модели.

ContentType -> (string)

Тип контента источника метрики.

ContentDigest -> (string)

Хэш-ключ, используемый для источника метрик.

S3Uri -> (string)

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

ModelDataQuality -> (structure)

Метрики, которые измеряют качество входных данных для модели.

Statistics -> (structure)

Статистика качества данных для модели.

ContentType -> (string)

Тип контента источника метрики.

ContentDigest -> (string)

Хэш-ключ, используемый для источника метрик.

S3Uri -> (string)

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

Constraints -> (structure

Ограничения качества данных для модели.

ContentType -> (string)

Тип контента источника метрики.

ContentDigest -> (string)

Хэш-ключ, используемый для источника метрик.

S3Uri -> (string)

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

Bias -> (structure)

Метрики, которые измеряют предвзятость в модели.

Report -> (structure)

Отчет о предвзятости для модели

ContentType -> (string)

Тип контента источника метрики.

ContentDigest -> (string)

Хэш-ключ, используемый для источника метрик.

S3Uri -> (string)

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

PreTrainingReport -> (structure)

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

ContentType -> (string)

Тип контента источника метрики.

ContentDigest -> (string)

Хэш-ключ, используемый для источника метрик.

S3Uri -> (string)

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

PostTrainingReport -> (structure)

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

ContentType -> (string)

Тип контента источника метрики.

ContentDigest -> (string)

Хэш-ключ, используемый для источника метрик.

S3Uri -> (string)

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

Explainability -> (structure)

Метрики, которые помогают объяснить модель.

Report -> (structure)

Отчет о понятности для модели.

ContentType -> (string)

Тип контента источника метрики.

ContentDigest -> (string)

Хэш-ключ, используемый для источника метрик.

S3Uri -> (string)

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

LastModifiedTime -> (timestamp)

Время последней модификации пакета модели.

LastModifiedBy -> (structure)

UserProfileArn -> (string)

Имя ресурса Amazon (ARN) профиля пользователя.

UserProfileName -> (string)

Имя профиля пользователя.

DomainId -> (string)

Домен, связанный с пользователем.

IamIdentity -> (structure)

Arn -> (string)

Имя ресурса Amazon (ARN) идентификации IAM.

PrincipalId -> (string)

ID принципала, который принимает идентификацию IAM.

SourceIdentity -> (string)

Лицо или приложение, которое принимает идентификацию IAM.

ApprovalDescription -> (string)

Описание, предоставленное для утверждения модели.

Domain -> (string)

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

Task -> (string)

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

SamplePayloadUrl -> (string)

Путь Amazon Simple Storage Service (Amazon S3), в котором хранятся образцы полезных данных. Этот путь указывает на один gzip сжатый архив tar (.tar.gz suffix).

CustomerMetadataProperties -> (map)

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

key -> (string)

value -> (string)

DriftCheckBaselines -> (structure)

Представляет базовые показатели проверки дрейфа, которые можно использовать, когда монитор модели настраивается с использованием пакета модели. Для получения дополнительной информации см. раздел Обнаружение дрейфа по сравнению с предыдущими базовыми показателями в SageMaker Pipelines в Руководстве разработчика Amazon SageMaker .

Bias -> (structure)

Представляет базовые показатели предвзятости проверки дрейфа, которые можно использовать при настройке монитора модели с использованием пакета модели.

ConfigFile -> (structure)

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

ContentType -> (string)

Тип контента, хранящегося в источнике файла.

ContentDigest -> (string)

Дайджест источника файла.

S3Uri -> (string)

URI Amazon S3 для источника файла.

PreTrainingConstraints -> (structure)

Ограничения перед обучением.

ContentType -> (string)

Тип контента источника метрики.

ContentDigest -> (string)

Хэш-ключ, используемый для источника метрик.

S3Uri -> (string)

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

PostTrainingConstraints -> (structure)

Ограничения после обучения.

ContentType -> (string)

Тип контента источника метрики.

ContentDigest -> (string)

Хэш-ключ, используемый для источника метрик.

S3Uri -> (string)

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

Explainability -> (structure)

Представляет базовые показатели объяснимости проверки дрейфа, которые можно использовать при настройке монитора модели с использованием пакета модели.

Constraints -> (structure)

Ограничения объяснимости проверки дрейфа.

ContentType -> (string)

Тип контента источника метрики.

ContentDigest -> (string)

Хэш-ключ, используемый для источника метрик.

S3Uri -> (string)

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

ConfigFile -> (structure)

Файл конфигурации понятности для модели.

ContentType -> (string)

Тип контента, хранящегося в источнике файла.

ContentDigest -> (string)

Дайджест источника файла.

S3Uri -> (string)

URI Amazon S3 для источника файла.

ModelQuality -> (structure)

Представляет базовые показатели качества модели проверки дрейфа, которые можно использовать при настройке монитора модели с использованием пакета модели.

Statistics -> (structure)

Статистика качества модели проверки дрейфа.

ContentType -> (string)

Тип контента источника метрики.

ContentDigest -> (string)

Хэш-ключ, используемый для источника метрик.

S3Uri -> (string)

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

Constraints -> (structure)

Ограничения качества модели проверки дрейфа.

ContentType -> (string)

Тип контента источника метрики.

ContentDigest -> (string)

Хэш-ключ, используемый для источника метрик.

S3Uri -> (string)

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

ModelDataQuality -> (structure)

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

Statistics -> (structure)

Статистика качества данных модели проверки дрейфа.

ContentType -> (string)

Тип контента источника метрики.

ContentDigest -> (string)

Хэш-ключ, используемый для источника метрик.

S3Uri -> (string)

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

Constraints -> (structure)

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

ContentType -> (string)

Тип контента источника метрики.

ContentDigest -> (string)

Хэш-ключ, используемый для источника метрик.

S3Uri -> (string)

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

AdditionalInferenceSpecifications -> (list)

Массив дополнительных объектов спецификации вывода. Каждая дополнительная спецификация вывода определяет артефакты на основе этого пакета модели, которые можно использовать в конечных точках вывода. Обычно используется с SageMaker Neo для хранения скомпилированных артефактов.

(structure)

Структура дополнительной спецификации вывода. Дополнительная спецификация вывода определяет подробности о заданиях вывода, которые можно запускать с моделями на основе этого пакета модели.

Name -> (string)

Уникальное имя для идентификации дополнительной спецификации вывода. Имя должно быть уникальным в списке ваших дополнительных спецификаций вывода для конкретного пакета модели.

Description -> (string)

Описание дополнительной спецификации вывода

Containers -> (list)

Путь к реестру Amazon ECR образа Docker, содержащего код вывода.

(structure)

Описывает контейнер Docker для пакета модели.

ContainerHostname -> (string)

Имя хоста DNS для контейнера Docker.

Image -> (string)

Путь Amazon Elastic Container Registry (Amazon ECR), где хранится код вывода.

Если вы используете собственный пользовательский алгоритм вместо алгоритма, предоставленного SageMaker, код вывода должен соответствовать требованиям SageMaker. SageMaker поддерживает оба формата пути к изображению registry/repository[:tag] и registry/repository[@digest] . Для получения дополнительной информации см. раздел Using Your Own Algorithms with Amazon SageMaker .

ImageDigest -> (string)

Хэш MD5 алгоритма обучения, который идентифицирует образ Docker, используемый для обучения.

ModelDataUrl -> (string)

Примечание

Артефакты модели должны находиться в корзине S3, которая находится в том же регионе, что и пакет модели.

ModelDataSource -> (structure)

Указывает расположение данных модели ML для развертывания при создании конечной точки.

S3DataSource -> (structure)

Указывает расположение S3 данных модели ML для развертывания.

S3Uri -> (string)

Указывает путь S3 данных модели ML для развертывания.

S3DataType -> (string)

Указывает тип данных модели ML для развертывания.

Если вы выберете S3Object , S3Uri идентифицирует объект, который является данными модели ML для развертывания.

CompressionType -> (string)

Указывает, как подготавливаются данные модели ML.

Если вы выберете Gzip и выберете S3Object в качестве значения S3DataType , S3Uri идентифицирует объект, представляющий собой gzip-сжатый архив TAR. SageMaker попытается распаковать и распаковать объект во время развертывания модели.

Если вы выберете None и выберете S3Object в качестве значения S3DataType , S3Uri идентифицирует объект, представляющий несжатую модель ML для развертывания.

Если вы выберете None и выберете S3Prefix в качестве значения S3DataType , S3Uri идентифицирует префикс имени ключа, под которым все объекты представляют несжатую модель ML для развертывания.

Если вы выберете None, SageMaker будет следовать приведенным ниже правилам при создании файлов данных модели в каталоге /opt/ml/model для использования вашим кодом вывода:

Если вы выберете S3Object в качестве значения S3DataType , SageMaker разделит ключ объекта S3, на который ссылается S3Uri , косой чертой (/), и использует последнюю часть в качестве имени файла, содержащего содержимое объекта S3.
Если вы выберете S3Prefix в качестве значения S3DataType , то для каждого объекта S3 под префиксом имени ключа, на который ссылается S3Uri , SageMaker обрежет его ключ по префиксу и использует остаток в качестве пути (относительно /opt/ml/model ) файла, содержащего содержимое объекта S3. SageMaker разделит остаток косой чертой (/), используя промежуточные части в качестве имен каталогов и последнюю часть в качестве имени файла, содержащего содержимое объекта S3.
Не используйте ни одно из следующих имен файлов или имен каталогов:
- Пустая или пустая строка
- Строка, содержащая нулевые байты
- Строка длиной более 255 байт
- Один точка (. )
- Двойная точка (.. )
Неоднозначные имена файлов приведут к сбою развертывания модели. Например, если ваша несжатая модель ML состоит из двух объектов S3 s3://mybucket/model/weights и s3://mybucket/model/weights/part1 , и вы укажете s3://mybucket/model/ в качестве значения S3Uri и S3Prefix в качестве значения S3DataType , то это приведет к конфликту имен между /opt/ml/model/weights (обычный файл) и /opt/ml/model/weights/ (каталог).
Не организовывайте артефакты модели в консоли S3, используя папки. Когда вы создаете папку в консоли S3, S3 создает объект размером 0 байт с ключом, установленным в имя папки, которое вы предоставили. Ключ объекта размером 0 байт заканчивается косой чертой (/), что нарушает ограничения SageMaker на имена файлов артефактов модели, что приводит к сбою развертывания модели.

ModelAccessConfig -> (structure)

Указывает файл конфигурации доступа для модели ML. Вы можете явно принять лицензионное соглашение конечного пользователя модели (EULA) в ModelAccessConfig . Вы несете ответственность за ознакомление и соблюдение любых применимых условий лицензии и за обеспечение их приемлемости для вашего варианта использования перед загрузкой или использованием модели.

AcceptEula -> (boolean)

Указывает согласие с лицензионным соглашением конечного пользователя модели (EULA). Значение AcceptEula должно быть явно определено как True , чтобы принять EULA, требуемую этой моделью. Вы несете ответственность за ознакомление и соблюдение любых применимых условий лицензии и за обеспечение их приемлемости для вашего варианта использования перед загрузкой или использованием модели.

HubAccessConfig -> (structure)

Сведения о конфигурации для доступа к концентратору.

HubContentArn -> (string)

ARN контента концентратора, для которого разрешен доступ к развертыванию.

ManifestS3Uri -> (string)

URI манифеста в Amazon S3. Файл манифеста представляет собой файл CSV, в котором хранятся местоположения артефактов.

ETag -> (string)

ETag, связанный с S3 URI.

ManifestEtag -> (string)

ETag, связанный с Manifest S3 URI.

ProductId -> (string)

Идентификатор продукта Amazon Web Services Marketplace пакета модели.

Environment -> (map)

Переменные среды, которые необходимо установить в контейнере Docker. Каждое значение ключа и значение в карте строка-строка Environment может иметь длину до 1024. Мы поддерживаем до 16 записей в карте.

key -> (string)

value -> (string)

ModelInput -> (structure)

Структура с подробностями входных данных модели.

DataInputConfig -> (string)

Объект конфигурации входных данных для модели.

Framework -> (string)

Платформа машинного обучения образа контейнера пакета модели.

FrameworkVersion -> (string)

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

NearestModelName -> (string)

Название предварительно обученной модели машинного обучения, протестированной Amazon SageMaker Inference Recommender, которая соответствует вашей модели. Вы можете найти список протестированных моделей, вызвав ListModelMetadata .

AdditionalS3DataSource -> (structure)

S3DataType -> (string)

S3Uri -> (string)

CompressionType -> (string)

ETag -> (string)

ETag, связанный с S3 URI.

ModelDataETag -> (string)

ETag, связанный с Model Data URL.

SupportedTransformInstanceTypes -> (list)

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

(string)

SupportedRealtimeInferenceInstanceTypes -> (list)

Список типов экземпляров, используемых для генерации выводов в режиме реального времени.

(string)

SupportedContentTypes -> (list)

Поддерживаемые типы MIME для входных данных.

(string)

SupportedResponseMIMETypes -> (list)

Поддерживаемые типы MIME для выходных данных.

(string)

SkipModelValidation -> (string)

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

SourceUri -> (string)

URI источника пакета модели.

SecurityConfig -> (structure)

Идентификатор ключа KMS (KMSKeyId ), используемый для шифрования информации о пакете модели.

KmsKeyId -> (string)

Идентификатор ключа KMS (KMSKeyId ), используемый для шифрования информации о пакете модели.

ModelCard -> (structure)

Карта модели, связанная с пакетом модели. Поскольку ModelPackageModelCard привязана к пакету модели, это конкретное использование карты модели, и ее схема упрощена по сравнению со схемой ModelCard. Схема ModelPackageModelCard не включает model_package_details, а model_overview состоит из свойств model_creator и model_artifact. Для получения дополнительной информации о схеме карты модели пакета модели см. Схема карты модели пакета модели. Для получения дополнительной информации о карте модели, связанной с пакетом модели, см. Просмотр сведений о версии модели.

ModelCardContent -> (string)

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

ModelCardStatus -> (string)

Статус утверждения карты модели в вашей организации. Разные организации могут иметь разные критерии для проверки и утверждения карты модели.

Draft: Карта модели находится в процессе разработки.
PendingReview: Карта модели ожидает рассмотрения.
Approved: Карта модели утверждена.
Archived: Карта модели архивирована. Больше нельзя вносить обновления в содержимое карты модели. Если вы попытаетесь обновить содержимое карты модели, вы получите сообщение Model Card is in Archived state.

ModelLifeCycle -> (structure)

Структура, описывающая текущее состояние модели в ее жизненном цикле.

Stage -> (string)

Текущий этап жизненного цикла модели.

StageStatus -> (string)

Текущий статус этапа в жизненном цикле модели.

StageDescription -> (string)

Описывает детали, связанные с этапом.