ImageConfig class

Definition

Abstract class for image configuration objects.

Inheritance
builtins.object
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.

See the following link for an overview on deploying models in Azure: https://aka.ms/azureml-how-deploy

Methods

build_create_payload(workspace, name, model_ids)

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(workspace, name, model_ids)

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

build_create_payload(workspace, name, model_ids)

Parameters

workspace
Workspace

The workspace associated with the image

name
str

The name of the image

model_ids
<xref:azureml.core.image.image.list[str]>

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

Remarks

Check out the ContainerImageConfig class for an example of a concrete instantiation of this abstract method

validate_configuration()

Check that the specified configuration values are valid.

validate_configuration()

Remarks

Check out the ContainerImageConfig class for an example of a concrete instantiation of this abstract method

Will raise a WebserviceException if validation fails.