ImageConfig Class

Defines the abstract class for image configuration objects.

This class is DEPRECATED.

Inheritance

ABC

ImageConfig

Constructor

ImageConfig()

Remarks

The ImageConfig class is one of a set of classes that are designed to facilitate deploying models in Azure.

One way to deploy a model that you've trained is to package it as an image (e.g., a Docker image) containing the dependencies needed to run the model. An Image configuration is used to specify key information about the image (such as conda environment info and execution scripts). The ImageConfig class is the abstract class that all such configuration objects will inherit from. For example, the ContainerImageConfig class inherits from the ImageConfig class.

For an overview on deploying models in Azure, see https://aka.ms/azureml-how-deploy.

Methods

build_create_payload	Abstract method for building the creation payload associated with this configuration object.
validate_configuration	Check that the specified configuration values are valid.

build_create_payload

Abstract method for building the creation payload associated with this configuration object.

abstract build_create_payload(workspace, name, model_ids)

Parameters

workspace

Workspace

Required

The workspace associated with the image.

name

str

Required

The name of the image.

model_ids

list[str]

Required

Specifies list of model IDs, corresponding to models to be packaged with the image.

Returns

The creation payload to use for Image creation.

Return type

dict

Remarks

See the ContainerImageConfig class for an example of a concrete instantiation of this abstract method.

validate_configuration

Check that the specified configuration values are valid.

abstract validate_configuration()

Exceptions

WebserviceException

Remarks

See the ContainerImageConfig class for an example of a concrete instantiation of this abstract method.

Raises a WebserviceException if validation fails.