Skip to content

Commit 5bbf929

Browse files
authored
Merge pull request #44171 from keerthiadu/patch-1
update inference config schema; add reference to environment.
2 parents e847f6b + aee4c34 commit 5bbf929

File tree

1 file changed

+39
-10
lines changed

1 file changed

+39
-10
lines changed

includes/machine-learning-service-inference-config.md

Lines changed: 39 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
author: larryfr
2+
author: Blackmist
33
ms.service: machine-learning
44
ms.topic: include
55
ms.date: 11/06/2019
@@ -11,15 +11,16 @@ The entries in the `inferenceconfig.json` document map to the parameters for the
1111
| JSON entity | Method parameter | Description |
1212
| ----- | ----- | ----- |
1313
| `entryScript` | `entry_script` | Path to a local file that contains the code to run for the image. |
14-
| `runtime` | `runtime` | Which runtime to use for the image. Current supported runtimes are `spark-py` and `python`. |
15-
| `condaFile` | `conda_file` | Optional. Path to a local file that contains a Conda environment definition to use for the image. |
16-
| `extraDockerFileSteps` | `extra_docker_file_steps` | Optional. Path to a local file that contains additional Docker steps to run when setting up the image. |
14+
| `runtime` | `runtime` | Optional. Which runtime to use for the image. Current supported runtimes are `spark-py` and `python`. If `environment` is set, this gets ignored. |
15+
| `condaFile` | `conda_file` | Optional. Path to a local file that contains a Conda environment definition to use for the image. If `environment` is set, this gets ignored. |
16+
| `extraDockerFileSteps` | `extra_docker_file_steps` | Optional. Path to a local file that contains additional Docker steps to run when setting up the image. If `environment` is set, this gets ignored.|
1717
| `sourceDirectory` | `source_directory` | Optional. Path to folders that contain all files to create the image. |
18-
| `enableGpu` | `enable_gpu` | Optional. Whether to enable GPU support in the image. The GPU image must be used on an Azure service, like Azure Container Instances, Azure Machine Learning Compute, Azure Virtual Machines, and Azure Kubernetes Service. The default is False. |
19-
| `baseImage` | `base_image` | Optional. Custom image to be used as a base image. If no base image is provided, the image will be based on the provided runtime parameter. |
20-
| `baseImageRegistry` | `base_image_registry` | Optional. Image registry that contains the base image. |
21-
| `cudaVersion` | `cuda_version` | Optional. Version of CUDA to install for images that need GPU support. The GPU image must be used on an Azure service, like Azure Container Instances, Azure Machine Learning Compute, Azure Virtual Machines, and Azure Kubernetes Service. Supported versions are 9.0, 9.1, and 10.0. If `enable_gpu` is set, the default is 9.1. |
22-
| `description` | `description` | A description for the image. |
18+
| `enableGpu` | `enable_gpu` | Optional. Whether to enable GPU support in the image. The GPU image must be used on an Azure service, like Azure Container Instances, Azure Machine Learning Compute, Azure Virtual Machines, and Azure Kubernetes Service. The default is False. If `environment` is set, this gets ignored.|
19+
| `baseImage` | `base_image` | Optional. Custom image to be used as a base image. If no base image is provided, the image will be based on the provided runtime parameter. If `environment` is set, this gets ignored. |
20+
| `baseImageRegistry` | `base_image_registry` | Optional. Image registry that contains the base image. If `environment` is set, this gets ignored.|
21+
| `cudaVersion` | `cuda_version` | Optional. Version of CUDA to install for images that need GPU support. The GPU image must be used on an Azure service, like Azure Container Instances, Azure Machine Learning Compute, Azure Virtual Machines, and Azure Kubernetes Service. Supported versions are 9.0, 9.1, and 10.0. If `enable_gpu` is set, the default is 9.1. If `environment` is set, this gets ignored. |
22+
| `description` | `description` | A description for the image. If `environment` is set, this gets ignored. |
23+
| `environment` | `environment` | Optional. Azure Machine Learning [environment](https://docs.microsoft.com/python/api/azureml-core/azureml.core.environment.environment?view=azure-ml-py).|
2324

2425
The following JSON is an example inference configuration for use with the CLI:
2526

@@ -34,4 +35,32 @@ The following JSON is an example inference configuration for use with the CLI:
3435
"baseImage": null,
3536
"baseImageRegistry": null
3637
}
37-
```
38+
```
39+
40+
The following JSON is an example inference configuration that uses an existing Azure Machine Learning [environment](https://docs.microsoft.com/python/api/azureml-core/azureml.core.environment.environment?view=azure-ml-py) with a specific version for use with the CLI:
41+
42+
```json
43+
{
44+
"entryScript": "score.py",
45+
"environment":{
46+
"name": "myenv",
47+
"version": "1"
48+
},
49+
"condaFile": "myenv.yml",
50+
"sourceDirectory": null
51+
}
52+
```
53+
54+
The following JSON is an example inference configuration that uses an existing Azure Machine Learning [environment](https://docs.microsoft.com/python/api/azureml-core/azureml.core.environment.environment?view=azure-ml-py) with latest version for use with the CLI:
55+
56+
```json
57+
{
58+
"entryScript": "score.py",
59+
"environment":{
60+
"name": "myenv",
61+
"version": null
62+
},
63+
"condaFile": "myenv.yml",
64+
"sourceDirectory": null
65+
}
66+
```

0 commit comments

Comments
 (0)