ContainerImage Класс

Представляет образ контейнера, в настоящее время только для образов Docker.

Использовать этот класс НЕ РЕКОМЕНДУЕТСЯ. Используйте вместо этого класс Environment.

Образ содержит зависимости, необходимые для выполнения модели, в том числе:

  • Среда выполнения

  • Определения среды Python, указанные в файле Conda

  • Возможность включения поддержки GPU

  • Пользовательский файл Docker для конкретных команд выполнения

Конструктор изображений.

Использовать этот класс НЕ РЕКОМЕНДУЕТСЯ. Используйте вместо этого класс Environment.

Конструктор изображений используется для получения облачного представления объекта Image, связанного с предоставленной рабочей областью. Возвращает экземпляр дочернего класса, соответствующий конкретному типу извлеченного объекта Image.

Наследование
ContainerImage

Конструктор

ContainerImage(workspace, name=None, id=None, tags=None, properties=None, version=None)

Параметры

workspace
Workspace
Обязательно

Объект рабочей области, содержащий извлекаемый образ

name
str
значение по умолчанию: None

Имя получаемого образа. Возвращает последнюю версию, если она существует

id
str
значение по умолчанию: None

Конкретный идентификатор извлекаемого образа. (идентификатор — ":")

tags
list
значение по умолчанию: None

Фильтрация результатов будет осуществляться по указанному списку: "ключ" или "[ключ, значение]". Например: ["ключ", ["ключ2", "ключ2 значение"]]

properties
list
значение по умолчанию: None

Фильтрация результатов будет осуществляться по указанному списку: "ключ" или "[ключ, значение]". Например: ["ключ", ["ключ2", "ключ2 значение"]]

version
str
значение по умолчанию: None

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

Комментарии

ContainerImage извлекается с помощью конструктора класса Image путем передачи имени или идентификатора ранее созданного ContainerImage. В следующем примере кода показано извлечение образа из рабочей области с помощью имени и идентификатора.


   container_image_from_name = Image(workspace, name="image-name")
   container_image_from_id = Image(workspace, id="image-id")

Чтобы создать новую конфигурацию образа для использования в развертывании, создайте объект ContainerImageConfig, как показано в следующем примере кода:


   from azureml.core.image import ContainerImage

   image_config = ContainerImage.image_configuration(execution_script="score.py",
                                                    runtime="python",
                                                    conda_file="myenv.yml",
                                                    description="image for model",
                                                    cuda_version="9.0"
                                                    )

Методы

image_configuration

Создание и возврат объекта ContainerImageConfig.

Эта функция принимает параметры, определяющие, как модель должна выполняться в веб- службе, а также конкретную среду и зависимости, необходимые для осуществления выполнения.

run

Локальное выполнение образа с заданными входными данными.

Для работы необходимо установить и запустить Docker. Этот метод будет работать только на ЦП, так как образ с поддержкой GPU можно запускать только в службах Microsoft Azure.

serialize

Преобразование этого объекта ContainerImage в сериализованный словарь JSON.

image_configuration

Создание и возврат объекта ContainerImageConfig.

Эта функция принимает параметры, определяющие, как модель должна выполняться в веб- службе, а также конкретную среду и зависимости, необходимые для осуществления выполнения.

static image_configuration(execution_script, runtime, conda_file=None, docker_file=None, schema_file=None, dependencies=None, enable_gpu=None, tags=None, properties=None, description=None, base_image=None, base_image_registry=None, cuda_version=None)

Параметры

execution_script
str
Обязательно

Путь к локальному файлу Python, содержащему код, выполняемый для образа. Должна содержать обе функции, init() и run(input_data), которые определяют этапы выполнения модели для веб-службы.

runtime
str
Обязательно

Среда выполнения, используемая для образа. Текущие поддерживаемые среды выполнения: spark-py и python.

conda_file
str
значение по умолчанию: None

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

docker_file
str
значение по умолчанию: None

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

schema_file
str
значение по умолчанию: None

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

dependencies
list[str]
значение по умолчанию: None

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

enable_gpu
bool
значение по умолчанию: None

Указывает, следует ли включить поддержку GPU в образе. Образ GPU должен использоваться службами Microsoft Azure, такими как Экземпляры контейнеров Azure, Вычислительная среда Машинного обучения Azure, Виртуальные машины Azure и Служба Azure Kubernetes. Значение по умолчанию — False.

tags
dict[str, str]
значение по умолчанию: None

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

properties
dict[str, str]
значение по умолчанию: None

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

description
str
значение по умолчанию: None

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

base_image
str
значение по умолчанию: None

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

base_image_registry
ContainerRegistry
значение по умолчанию: None

Реестр образов, содержащий базовый образ.

cuda_version
str
значение по умолчанию: None

Версия CUDA, которую нужно установить для образов, требующих поддержки GPU. Образ GPU должен использоваться службами Microsoft Azure, такими как Экземпляры контейнеров Azure, Вычислительная среда Машинного обучения Azure, Виртуальные машины Azure и Служба Azure Kubernetes. Поддерживаются версии 9.0, 9.1 и 10.0. Если задано значение 'enable_gpu', по умолчанию используется версия '9.1'.

Возвращаемое значение

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

Возвращаемый тип

Исключения

run

Локальное выполнение образа с заданными входными данными.

Для работы необходимо установить и запустить Docker. Этот метод будет работать только на ЦП, так как образ с поддержкой GPU можно запускать только в службах Microsoft Azure.

run(input_data)

Параметры

input_data
<xref:varies>
Обязательно

Входные данные для передачи в образ при выполнении

Возвращаемое значение

Результаты выполнения образа.

Возвращаемый тип

<xref:varies>

Исключения

serialize

Преобразование этого объекта ContainerImage в сериализованный словарь JSON.

serialize()

Возвращаемое значение

Представление JSON этого ContainerImage.

Возвращаемый тип

Исключения