create-model

Описание

Создает модель в SageMaker. В запросе вы указываете имя модели и описываете основной контейнер. Для основного контейнера вы указываете Docker-образ, который содержит код вывода, артефакты (из предыдущего обучения) и пользовательскую карту окружения, которую код вывода использует при развертывании модели для прогнозов.

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

Чтобы разместить свою модель, вы создаете конфигурацию конечной точки с помощью API CreateEndpointConfig, а затем создаете конечную точку с помощью API CreateEndpoint. SageMaker затем развертывает все контейнеры, которые вы определили для модели в среде размещения.

Чтобы запустить пакетное преобразование с использованием вашей модели, вы запускаете задание с помощью API CreateTransformJob. SageMaker использует вашу модель и ваш набор данных для получения выводов, которые затем сохраняются в указанном расположении S3.

В запросе вы также предоставляете роль IAM, которую SageMaker может использовать для доступа к артефактам модели и Docker-образу для развертывания на экземплярах ML-вычислений или для заданий пакетного преобразования. Кроме того, вы также используете роль IAM для управления разрешениями, необходимыми коду вывода. Например, если код вывода имеет доступ к другим ресурсам Amazon Web Services, вы предоставляете необходимые разрешения через эту роль.

См. также: Документация API AWS

Синтаксис

  create-model
--model-name <value>
[--primary-container <value>]
[--containers <value>]
[--inference-execution-config <value>]
[--execution-role-arn <value>]
[--tags <value>]
[--vpc-config <value>]
[--enable-network-isolation | --no-enable-network-isolation]
[--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-name (строка)

Имя новой модели.

--primary-container (структура)

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

ContainerHostname -> (строка)

Этот параметр игнорируется для моделей, содержащих только PrimaryContainer.

Когда ContainerDefinition является частью конвейера вывода, значение параметра однозначно идентифицирует контейнер для целей ведения журнала и метрик. Дополнительную информацию см. в разделе Использование журналов и метрик для мониторинга конвейера вывода. Если вы не укажете значение для этого параметра для ContainerDefinition, являющегося частью конвейера вывода, уникальное имя будет автоматически назначено на основе позиции ContainerDefinition в конвейере. Если вы укажете значение для ContainerHostName для любого ContainerDefinition, который является частью конвейера вывода, вы должны указать значение для параметра ContainerHostName для каждого ContainerDefinition в этом конвейере.

Image -> (строка)

Путь, где хранится код вывода. Он может находиться как в Amazon EC2 Container Registry, так и в реестре Docker, доступном из той же VPC, что и ваш конечная точка. Если вы используете свой собственный алгоритм вместо алгоритма, предоставляемого SageMaker, код вывода должен соответствовать требованиям SageMaker. SageMaker поддерживает форматы пути к изображению registry/repository[:tag] и registry/repository[@digest]. Дополнительную информацию см. в разделе Использование собственных алгоритмов с Amazon SageMaker.

Примечание

Артефакты модели в ведре Amazon S3 и образ Docker для контейнера вывода в Amazon EC2 Container Registry должны находиться в той же области, что и модель или конечная точка, которую вы создаёте.

ImageConfig -> (структура)

Указывает, находится ли контейнер модели в Amazon ECR или в частном реестре Docker, доступном из вашей Amazon Virtual Private Cloud (VPC). Дополнительную информацию о хранении контейнеров в частном реестре Docker см. в разделе Использование частного реестра Docker для контейнеров реального времени.

Примечание

RepositoryAccessMode -> (строка)

Установите одно из следующих значений:

Platform — Образ модели размещён в Amazon ECR.
Vpc — Образ модели размещён в частном реестре Docker в вашей VPC.

RepositoryAuthConfig -> (структура)

(Необязательно) Указывает конфигурацию аутентификации для частного реестра Docker, где размещен образ вашей модели. Укажите значение для этого свойства только в том случае, если вы указали Vpc в качестве значения для поля RepositoryAccessMode, и частный реестр Docker, в котором размещен образ модели, требует аутентификации.

RepositoryCredentialsProviderArn -> (строка)

Amazon Resource Name (ARN) функции Amazon Web Services Lambda, предоставляющей учетные данные для аутентификации в частном реестре Docker, где размещен образ вашей модели. Дополнительную информацию о создании функции Amazon Web Services Lambda см. в разделе Создание функции Lambda с помощью консоли в Руководстве разработчика Amazon Web Services Lambda.

Mode -> (строка)

Указывает, содержит ли контейнер одну модель или несколько моделей.

ModelDataUrl -> (строка)

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

Примечание

Артефакты модели должны находиться в ведре S3 в той же области, что и модель или конечная точка, которую вы создаёте.

Если вы предоставляете значение для этого параметра, SageMaker использует Amazon Web Services Security Token Service для скачивания артефактов модели из указанного вами пути в S3. Amazon Web Services STS активирован в вашей учётной записи Amazon Web Services по умолчанию. Если вы ранее деактивировали Amazon Web Services STS для области, вам необходимо повторно активировать Amazon Web Services STS для этой области. Дополнительную информацию см. в разделе Активация и деактивация Amazon Web Services STS в области Amazon Web Services в Руководстве пользователя Amazon Web Services Identity and Access Management.

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

Если вы используете встроенный алгоритм для создания модели, SageMaker требует, чтобы вы предоставили путь в S3 к артефактам модели в ModelDataUrl.

ModelDataSource -> (структура)

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

Примечание

В настоящее время вы не можете использовать ModelDataSource в сочетании с SageMaker пакетной обработкой, SageMaker бессерверными конечными точками, SageMaker конечными точками с несколькими моделями и SageMaker Marketplace.

S3DataSource -> (структура)

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

S3Uri -> (строка)

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

S3DataType -> (строка)

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

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

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

CompressionType -> (строка)

Указывает способ подготовки данных 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 -> (структура)

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

AcceptEula -> (булево)

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

HubAccessConfig -> (структура)

Конфигурационная информация для доступа к хабу.

HubContentArn -> (строка)

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

ManifestS3Uri -> (строка)

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

ETag -> (строка)

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

ManifestEtag -> (строка)

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

AdditionalModelDataSources -> (список)

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

(структура)

ChannelName -> (строка)

Пользовательское имя для этого объекта AdditionalModelDataSource.

S3DataSource -> (структура)

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

S3Uri -> (строка)

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

S3DataType -> (строка)

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

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

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

CompressionType -> (строка)

Указывает способ подготовки данных 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 -> (структура)

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

AcceptEula -> (булево)

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

HubAccessConfig -> (структура)

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

HubContentArn -> (строка)

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

ManifestS3Uri -> (строка)

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

ETag -> (строка)

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

ManifestEtag -> (строка)

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

Environment -> (карта)

Переменные окружения, которые нужно установить в контейнере Docker. Не включайте конфиденциальные данные в переменные окружения.

Максимальная длина каждого ключа и значения в карте Environment составляет 1024 байта. Максимальная длина всех ключей и значений в карте, вместе взятых, составляет 32 КБ. Если вы передаете несколько контейнеров в запрос CreateModel, то максимальная длина всех их карт, вместе взятых, также составляет 32 КБ.

key -> (строка)

value -> (строка)

ModelPackageName -> (строка)

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

InferenceSpecificationName -> (строка)

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

MultiModelConfig -> (структура)

Указывает дополнительную конфигурацию для многомодельных конечных точек.

ModelCacheSetting -> (строка)

Следует ли кэшировать модели для многомодельной конечной точки. По умолчанию многомодельные конечные точки кэшируют модели, чтобы модель не загружалась в память каждый раз при вызове. Некоторые сценарии не выигрывают от кэширования модели. Например, если конечная точка содержит большое количество моделей, которые вызываются нечасто, конечная точка может работать лучше, если вы отключите кэширование моделей. Чтобы отключить кэширование моделей, установите значение этого параметра в Disabled.

Синтаксис JSON:

{
  "ContainerHostname": "string",
  "Image": "string",
  "ImageConfig": {
    "RepositoryAccessMode": "Platform"|"Vpc",
    "RepositoryAuthConfig": {
      "RepositoryCredentialsProviderArn": "string"
    }
  },
  "Mode": "SingleModel"|"MultiModel",
  "ModelDataUrl": "string",
  "ModelDataSource": {
    "S3DataSource": {
      "S3Uri": "string",
      "S3DataType": "S3Prefix"|"S3Object",
      "CompressionType": "None"|"Gzip",
      "ModelAccessConfig": {
        "AcceptEula": true|false
      },
      "HubAccessConfig": {
        "HubContentArn": "string"
      },
      "ManifestS3Uri": "string",
      "ETag": "string",
      "ManifestEtag": "string"
    }
  },
  "AdditionalModelDataSources": [
    {
      "ChannelName": "string",
      "S3DataSource": {
        "S3Uri": "string",
        "S3DataType": "S3Prefix"|"S3Object",
        "CompressionType": "None"|"Gzip",
        "ModelAccessConfig": {
          "AcceptEula": true|false
        },
        "HubAccessConfig": {
          "HubContentArn": "string"
        },
        "ManifestS3Uri": "string",
        "ETag": "string",
        "ManifestEtag": "string"
      }
    }
    ...
  ],
  "Environment": {"string": "string"
    ...},
  "ModelPackageName": "string",
  "InferenceSpecificationName": "string",
  "MultiModelConfig": {
    "ModelCacheSetting": "Enabled"|"Disabled"
  }
}

--containers (список)

Указывает контейнеры в конвейере вывода.

(структура)

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

ContainerHostname -> (строка)

Этот параметр игнорируется для моделей, содержащих только PrimaryContainer.

Когда ContainerDefinition является частью конвейера вывода, значение параметра однозначно идентифицирует контейнер для целей ведения журналов и метрик. Дополнительную информацию см. в разделе Использование журналов и метрик для мониторинга конвейера вывода. Если вы не укажете значение для этого параметра для ContainerDefinition, который является частью конвейера вывода, уникальное имя будет автоматически присвоено на основе позиции ContainerDefinition в конвейере. Если вы укажете значение для ContainerHostName для любого ContainerDefinition, который является частью конвейера вывода, вы должны указать значение параметра ContainerHostName для каждого ContainerDefinition в этом конвейере.

Image -> (строка)

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

Примечание

Файлы модели в ведре Amazon S3 и образ Docker для контейнера вывода в Amazon EC2 Container Registry должны находиться в той же области, что и модель или конечная точка, которую вы создаете.

ImageConfig -> (структура)

Примечание

RepositoryAccessMode -> (строка)

Установите одно из следующих значений:

Platform — Образ модели размещен в Amazon ECR.
Vpc — Образ модели размещен в частном реестре Docker в вашей VPC.

RepositoryAuthConfig -> (структура)

(Необязательно) Указывает конфигурацию аутентификации для частного реестра Docker, где размещен образ вашей модели. Указывайте значение для этого свойства только в том случае, если вы указали Vpc в качестве значения для поля RepositoryAccessMode, и частный реестр Docker, где размещен образ модели, требует аутентификации.

RepositoryCredentialsProviderArn -> (строка)

Amazon Resource Name (ARN) функции Amazon Web Services Lambda, которая предоставляет учетные данные для аутентификации в частном реестре Docker, где размещен образ вашей модели. Дополнительную информацию о создании функции Amazon Web Services Lambda см. в разделе Создание функции Lambda с помощью консоли в Руководстве разработчика Amazon Web Services Lambda.

Mode -> (строка)

Указывает, содержит ли контейнер одну или несколько моделей.

ModelDataUrl -> (строка)

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

Путь в S3 требуется для встроенных алгоритмов SageMaker, но не требуется, если вы используете свои собственные алгоритмы. Дополнительную информацию об встроенных алгоритмах см. в разделе Общие параметры.

Примечание

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

Если вы предоставите значение для этого параметра, SageMaker будет использовать Amazon Web Services Security Token Service для скачивания файлов модели с предоставленного вами пути в S3. Amazon Web Services STS по умолчанию активирован в вашей учетной записи Amazon Web Services. Если вы ранее деактивировали Amazon Web Services STS для определенной области, вам необходимо повторно активировать Amazon Web Services STS для этой области. Дополнительную информацию см. в разделе Активация и деактивация Amazon Web Services STS в области Amazon Web Services в Руководстве пользователя Amazon Web Services Identity and Access Management.

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

Если вы используете встроенный алгоритм для создания модели, SageMaker требует, чтобы вы предоставили путь к файлам модели в S3 в формате ModelDataUrl.

ModelDataSource -> (структура)

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

Примечание

В настоящее время вы не можете использовать ModelDataSource совместно с SageMaker batch transform, SageMaker serverless endpoints, SageMaker multi-model endpoints и SageMaker Marketplace.

S3DataSource -> (структура)

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

S3Uri -> (строка)

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

S3DataType -> (строка)

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

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

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

CompressionType -> (строка)

Указывает способ подготовки данных ML-модели.

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

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

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

Если вы выберете 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 -> (структура)

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

AcceptEula -> (булево)

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

HubAccessConfig -> (структура)

Конфигурационная информация для доступа к хабу.

HubContentArn -> (строка)

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

ManifestS3Uri -> (строка)

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

ETag -> (строка)

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

ManifestEtag -> (строка)

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

AdditionalModelDataSources -> (список)

(структура)

ChannelName -> (строка)

Пользовательское имя для этого объекта AdditionalModelDataSource.

S3DataSource -> (структура)

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

S3Uri -> (строка)

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

S3DataType -> (строка)

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

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

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

CompressionType -> (строка)

Указывает способ подготовки данных 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 -> (структура)

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

AcceptEula -> (булево)

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

HubAccessConfig -> (структура)

Конфигурационная информация для доступа к хабу.

HubContentArn -> (строка)

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

ManifestS3Uri -> (строка)

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

ETag -> (строка)

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

ManifestEtag -> (строка)

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

Environment -> (карта)

Переменные среды, которые необходимо установить в контейнере Docker. Не включайте конфиденциальные данные в свои переменные среды.

Максимальная длина каждого ключа и значения в карте Environment составляет 1024 байта. Максимальная длина всех ключей и значений в карте, вместе взятых, составляет 32 КБ. Если вы передаёте несколько контейнеров в запрос CreateModel, то максимальная длина всех их карт, вместе взятых, также составляет 32 КБ.

ключ -> (строка)

значение -> (строка)

ModelPackageName -> (строка)

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

InferenceSpecificationName -> (строка)

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

MultiModelConfig -> (структура)

Указывает дополнительную конфигурацию для многомодельных конечных точек.

ModelCacheSetting -> (строка)

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

Синтаксис JSON:

[
  {
    "ContainerHostname": "string",
    "Image": "string",
    "ImageConfig": {
      "RepositoryAccessMode": "Platform"|"Vpc",
      "RepositoryAuthConfig": {
        "RepositoryCredentialsProviderArn": "string"
      }
    },
    "Mode": "SingleModel"|"MultiModel",
    "ModelDataUrl": "string",
    "ModelDataSource": {
      "S3DataSource": {
        "S3Uri": "string",
        "S3DataType": "S3Prefix"|"S3Object",
        "CompressionType": "None"|"Gzip",
        "ModelAccessConfig": {
          "AcceptEula": true|false
        },
        "HubAccessConfig": {
          "HubContentArn": "string"
        },
        "ManifestS3Uri": "string",
        "ETag": "string",
        "ManifestEtag": "string"
      }
    },
    "AdditionalModelDataSources": [
      {
        "ChannelName": "string",
        "S3DataSource": {
          "S3Uri": "string",
          "S3DataType": "S3Prefix"|"S3Object",
          "CompressionType": "None"|"Gzip",
          "ModelAccessConfig": {
            "AcceptEula": true|false
          },
          "HubAccessConfig": {
            "HubContentArn": "string"
          },
          "ManifestS3Uri": "string",
          "ETag": "string",
          "ManifestEtag": "string"
        }
      }
      ...
    ],
    "Environment": {"string": "string"
      ...},
    "ModelPackageName": "string",
    "InferenceSpecificationName": "string",
    "MultiModelConfig": {
      "ModelCacheSetting": "Enabled"|"Disabled"
    }
  }
  ...
]

--inference-execution-config (структура)

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

Mode -> (строка)

Как выполняются контейнеры в многоконтейнерной конечной точке. Следующие значения допустимы.

SERIAL - Контейнеры выполняются как последовательная конвейерная линия.
DIRECT - Выполняется только указанный вами отдельный контейнер.

Краткая запись:

Mode=string

Синтаксис JSON:

{
  "Mode": "Serial"|"Direct"
}

--execution-role-arn (строка)

Amazon Resource Name (ARN) роли IAM, которую SageMaker может принять для доступа к артефактам модели и образу Docker для развертывания на экземплярах ML-вычислений или для задач пакетного преобразования. Развертывание на экземплярах ML-вычислений является частью размещения модели. Дополнительную информацию см. в SageMaker Roles.

Примечание

Чтобы иметь возможность передать эту роль SageMaker, вызывающий эту API должен иметь разрешение iam:PassRole.

--tags (список)

Массив пар «ключ-значение». Вы можете использовать теги для категоризации ваших ресурсов Amazon Web Services различными способами, например, по назначению, владельцу или среде. Дополнительную информацию см. в Tagging Amazon Web Services Resources.

(структура)

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

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

Дополнительную информацию об добавлении метаданных к вашим ресурсам Amazon Web Services с помощью тегов см. в Tagging Amazon Web Services resources. Советы по лучшим практикам управления ресурсами Amazon Web Services с помощью тегов см. в Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy .

Ключ -> (строка)

Ключ тега. Ключи тегов должны быть уникальными для каждого ресурса.

Значение -> (строка)

Значение тега.

Краткая запись:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--vpc-config (структура)

Объект VpcConfig, определяющий VPC, к которому вы хотите подключить свою модель. Управляйте доступом к вашей модели и из неё, настроив VPC. VpcConfig используется в сервисах размещения и в задачах пакетного преобразования. Дополнительную информацию см. в Protect Endpoints by Using an Amazon Virtual Private Cloud и Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud.

SecurityGroupIds -> (список)

ID групп безопасности VPC, в формате sg-xxxxxxxx. Укажите группы безопасности для VPC, указанной в поле Subnets.

(строка)

Subnets -> (список)

ID подсетей в VPC, к которым вы хотите подключить свою задачу обучения или модель. Сведения о доступности конкретных типов экземпляров см. в Supported Instance Types and Availability Zones .

(строка)

Краткая запись:

SecurityGroupIds=string,string,Subnets=string,string

Синтаксис JSON:

{
  "SecurityGroupIds": ["string", ...],
  "Subnets": ["string", ...]
}

--enable-network-isolation | --no-enable-network-isolation (булево)

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

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

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

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

--debug (логическое значение)

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

--endpoint-url (строка)

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

--no-verify-ssl (логическое значение)

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

--no-paginate (логическое значение)

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

--output (строка)

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

json
text
table
yaml
yaml-stream

--query (строка)

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

--profile (строка)

Использовать определённый профиль из файла аутентификации.

--region (строка)

Регион для использования. Переопределяет настройки из конфигурации/среды.

--version (строка)

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

--color (строка)

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

on
off
auto

--no-sign-request (логическое значение)

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

--ca-bundle (строка)

Файл сертификатов CA для проверки сертификатов SSL. Переопределяет настройки из конфигурации/среды.

--cli-read-timeout (целое число)

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

--cli-connect-timeout (целое число)

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

--cli-binary-format (строка)

Стиль форматирования, используемый для бинарных блоков. Формат по умолчанию - 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 (логическое значение)

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

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

ModelArn -> (строка)

ARN модели, созданной в SageMaker.