Skip to content

Commit 5fe3f4d

Browse files
committed
Merge branch 'main' of https://github.com/microsoftdocs/azure-ai-docs-pr into onnx
2 parents c2f1b21 + aee09d8 commit 5fe3f4d

15 files changed

+465
-306
lines changed

articles/ai-services/content-safety/quickstart-groundedness.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ This section walks through a sample request with cURL. Paste the command below i
3939

4040

4141
```shell
42-
curl --location --request POST '<endpoint>/contentsafety/text:detectGroundedness?api-version=2024-02-15-preview' \
42+
curl --location --request POST '<endpoint>/contentsafety/text:detectGroundedness?api-version=2024-09-15-preview' \
4343
--header 'Ocp-Apim-Subscription-Key: <your_subscription_key>' \
4444
--header 'Content-Type: application/json' \
4545
--data-raw '{
@@ -87,7 +87,7 @@ Create a new Python file named _quickstart.py_. Open the new file in your prefer
8787
'Ocp-Apim-Subscription-Key': '<your_subscription_key>',
8888
'Content-Type': 'application/json'
8989
}
90-
conn.request("POST", "/contentsafety/text:detectGroundedness?api-version=2024-02-15-preview", payload, headers)
90+
conn.request("POST", "/contentsafety/text:detectGroundedness?api-version=2024-09-15-preview", payload, headers)
9191
res = conn.getresponse()
9292
data = res.read()
9393
print(data.decode("utf-8"))
@@ -124,7 +124,7 @@ The following fields must be included in the URL:
124124

125125
| Name | Required | Description | Type |
126126
| :-------------- | :-------- | :------ | :----- |
127-
| **API Version** | Required | This is the API version to be used. The current version is: api-version=2024-02-15-preview. Example: `<endpoint>/contentsafety/text:detectGroundedness?api-version=2024-02-15-preview` | String |
127+
| **API Version** | Required | This is the API version to be used. The current version is: api-version=2024-09-15-preview. Example: `<endpoint>/contentsafety/text:detectGroundedness?api-version=2024-09-15-preview` | String |
128128

129129
The parameters in the request body are defined in this table:
130130

@@ -210,7 +210,7 @@ This section walks through a sample request with cURL. Paste the command below i
210210

211211

212212
```shell
213-
curl --location --request POST '<endpoint>/contentsafety/text:detectGroundedness?api-version=2024-02-15-preview' \
213+
curl --location --request POST '<endpoint>/contentsafety/text:detectGroundedness?api-version=2024-09-15-preview' \
214214
--header 'Ocp-Apim-Subscription-Key: <your_subscription_key>' \
215215
--header 'Content-Type: application/json' \
216216
--data-raw '{
@@ -244,7 +244,7 @@ Create a new Python file named _quickstart.py_. Open the new file in your prefer
244244
import http.client
245245
import json
246246
247-
conn = http.client.HTTPSConnection("<endpoint>/contentsafety/text:detectGroundedness?api-version=2024-02-15-preview")
247+
conn = http.client.HTTPSConnection("<endpoint>/contentsafety/text:detectGroundedness?api-version=2024-09-15-preview")
248248
payload = json.dumps({
249249
"domain": "Generic",
250250
"task": "QnA",
@@ -266,7 +266,7 @@ Create a new Python file named _quickstart.py_. Open the new file in your prefer
266266
'Ocp-Apim-Subscription-Key': '<your_subscription_key>',
267267
'Content-Type': 'application/json'
268268
}
269-
conn.request("POST", "/contentsafety/text:detectGroundedness?api-version=2024-02-15-preview", payload, headers)
269+
conn.request("POST", "/contentsafety/text:detectGroundedness?api-version=2024-09-15-preview", payload, headers)
270270
res = conn.getresponse()
271271
data = res.read()
272272
print(data.decode("utf-8"))
@@ -389,7 +389,7 @@ This section demonstrates a sample request using cURL. Replace the placeholders
389389

390390

391391
```shell
392-
curl --location --request POST '<endpoint>/contentsafety/text:detectGroundedness?api-version=2024-02-15-preview' \
392+
curl --location --request POST '<endpoint>/contentsafety/text:detectGroundedness?api-version=2024-09-15-preview' \
393393
--header 'Ocp-Apim-Subscription-Key: <your_subscription_key>' \
394394
--header 'Content-Type: application/json' \
395395
--data-raw '{
@@ -412,7 +412,7 @@ curl --location --request POST '<endpoint>/contentsafety/text:detectGroundedness
412412
Create a Python script named quickstart.py and include the following code. Update the endpoint URL and key as appropriate:
413413
```Python
414414
415-
conn = http.client.HTTPSConnection("<endpoint>/contentsafety/text:detectGroundedness?api-version=2024-02-15-preview")
415+
conn = http.client.HTTPSConnection("<endpoint>/contentsafety/text:detectGroundedness?api-version=2024-09-15-preview")
416416
payload = json.dumps({
417417
"domain": "Generic",
418418
"task": "Summarization",
@@ -431,7 +431,7 @@ headers = {
431431
'Ocp-Apim-Subscription-Key': '<your_subscription_key>',
432432
'Content-Type': 'application/json'
433433
}
434-
conn.request("POST", "/contentsafety/text:detectGroundedness?api-version=2024-02-15-preview", payload, headers)
434+
conn.request("POST", "/contentsafety/text:detectGroundedness?api-version=2024-09-15-preview", payload, headers)
435435
res = conn.getresponse()
436436
data = res.read()
437437
print(data.decode("utf-8"))

articles/ai-studio/concepts/deployments-overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ms.service: azure-ai-studio
77
ms.custom:
88
- ignite-2023
99
- build-2024
10-
ms.topic: conceptual
10+
ms.topic: concept-article
1111
ms.date: 5/21/2024
1212
ms.reviewer: fasantia
1313
ms.author: mopeakande
@@ -96,4 +96,4 @@ Optimizing LLMs requires a careful consideration of several factors, including o
9696
- [Deploy Azure OpenAI models with Azure AI Studio](../how-to/deploy-models-openai.md)
9797
- [Deploy Meta Llama 3.1 models with Azure AI Studio](../how-to/deploy-models-llama.md)
9898
- [Deploy large language models with Azure AI Studio](../how-to/deploy-models-open.md)
99-
- [Azure AI Studio FAQ](../faq.yml)
99+
- [Model catalog and collections in Azure AI Studio](../how-to/model-catalog-overview.md)

articles/machine-learning/concept-azure-machine-learning-v2.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ms.topic: conceptual
1010
ms.author: sgilley
1111
author: sdgilley
1212
ms.reviewer: balapv
13-
ms.date: 08/21/2024
13+
ms.date: 09/30/2024
1414
#Customer intent: As a data scientist, I want to understand the big picture about how Azure Machine Learning works.
1515
---
1616

@@ -41,7 +41,7 @@ This document provides a quick overview of these resources and assets.
4141
To use the Python SDK code examples in this article:
4242

4343
1. Install the [Python SDK v2](https://aka.ms/sdk-v2-install)
44-
2. Create a connection to your Azure Machine Learning subscription. The examples all rely on `ml_client`. To create a workspace, the connection does not need a workspace name, since you may not yet have one. All other examples in this article require that the workspace name is included in the connection.
44+
2. Create a connection to your Azure Machine Learning subscription. The examples all rely on `ml_client`. To create a workspace, the connection doesn't need a workspace name, since you may not yet have one. All other examples in this article require that the workspace name is included in the connection.
4545

4646
```python
4747
# import required libraries
@@ -82,7 +82,7 @@ Sign in to [Azure Machine Learning studio](https://ml.azure.com).
8282

8383
## Workspace
8484

85-
The workspace is the top-level resource for Azure Machine Learning, providing a centralized place to work with all the artifacts you create when you use Azure Machine Learning. The workspace keeps a history of all jobs, including logs, metrics, output, and a snapshot of your scripts. The workspace stores references to resources like datastores and compute. It also holds all assets like models, environments, components and data asset.
85+
The workspace is the top-level resource for Azure Machine Learning, providing a centralized place to work with all the artifacts you create when you use Azure Machine Learning. The workspace keeps a history of all jobs, including logs, metrics, output, and a snapshot of your scripts. The workspace stores references to resources like datastores and compute. It also holds all assets like models, environments, components, and data asset.
8686

8787
### Create a workspace
8888

@@ -133,7 +133,7 @@ A compute is a designated compute resource where you run your job or host your e
133133

134134
* **Compute instance** - a fully configured and managed development environment in the cloud. You can use the instance as a training or inference compute for development and testing. It's similar to a virtual machine on the cloud.
135135
* **Compute cluster** - a managed-compute infrastructure that allows you to easily create a cluster of CPU or GPU compute nodes in the cloud.
136-
* **Serverless compute** - a compute cluster you access on the fly. When you use serverless compute, you don't need to create your own cluster. All compute lifecycle management is offloaded to Azure Machine Learning.
136+
* **Serverless compute** - a compute cluster you access on the fly. When you use serverless compute, you don't need to create your own cluster. All compute lifecycle management is offloaded to Azure Machine Learning.
137137
* **Inference cluster** - used to deploy trained machine learning models to Azure Kubernetes Service. You can create an Azure Kubernetes Service (AKS) cluster from your Azure Machine Learning workspace, or attach an existing AKS cluster.
138138
* **Attached compute** - You can attach your own compute resources to your workspace and use them for training and inference.
139139

@@ -171,11 +171,10 @@ az ml compute create --file my_compute.yml
171171
```
172172

173173
For the content of the file, see [compute YAML examples](https://github.com/Azure/azureml-examples/tree/main/cli/resources/compute).
174-
.
175174

176175
### [Studio](#tab/azure-studio)
177176

178-
1. Select a workspace if you are not already in one.
177+
1. Select a workspace if you aren't already in one.
179178
1. From the left-hand menu, select **Compute**.
180179
1. On the top, select a tab to specify the type of compute you want to create.
181180
1. Select **New** to create the new compute.
@@ -235,7 +234,7 @@ For the content of the file, see [datastore YAML examples](https://github.com/Az
235234

236235
### [Studio](#tab/azure-studio)
237236

238-
1. Select a workspace if you are not already in one.
237+
1. Select a workspace if you aren't already in one.
239238
1. From the left-hand menu, select **Data**.
240239
1. On the top, select **Datastores**.
241240
1. Select **Create** to create a new datastore.
@@ -246,7 +245,7 @@ To learn more about using a datastore, see [Create and manage data assets](how-t
246245

247246
## Model
248247

249-
Azure Machine Learning models consist of the binary file(s) that represent a machine learning model and any corresponding metadata. Models can be created from a local or remote file or directory. For remote locations `https`, `wasbs` and `azureml` locations are supported. The created model will be tracked in the workspace under the specified name and version. Azure Machine Learning supports three types of storage format for models:
248+
Azure Machine Learning models consist of one or more binary files that represent a machine learning model and any corresponding metadata. Models can be created from a local or remote file or directory. For remote locations `https`, `wasbs` and `azureml` locations are supported. The created model is tracked in the workspace under the specified name and version. Azure Machine Learning supports three types of storage format for models:
250249

251250
* `custom_model`
252251
* `mlflow_model`
@@ -260,13 +259,13 @@ For more information on how to create models in the registry, see [Work with mod
260259

261260
## Environment
262261

263-
Azure Machine Learning environments are an encapsulation of the environment where your machine learning task happens. They specify the software packages, environment variables, and software settings around your training and scoring scripts. The environments are managed and versioned entities within your Machine Learning workspace. Environments enable reproducible, auditable, and portable machine learning workflows across a variety of computes.
262+
Azure Machine Learning environments are an encapsulation of the environment where your machine learning task happens. They specify the software packages, environment variables, and software settings around your training and scoring scripts. The environments are managed and versioned entities within your Machine Learning workspace. Environments enable reproducible, auditable, and portable machine learning workflows across various computes.
264263

265264
### Types of environment
266265

267266
Azure Machine Learning supports two types of environments: curated and custom.
268267

269-
Curated environments are provided by Azure Machine Learning and are available in your workspace by default. Intended to be used as is, they contain collections of Python packages and settings to help you get started with various machine learning frameworks. These pre-created environments also allow for faster deployment time. For a full list, see the [curated environments article](resource-curated-environments.md).
268+
Curated environments are provided by Azure Machine Learning and are available in your workspace by default. Intended to be used as is, they contain collections of Python packages and settings to help you get started with various machine learning frameworks. These precreated environments also allow for faster deployment time. For a full list, see the [curated environments article](resource-curated-environments.md).
270269

271270
In custom environments, you're responsible for setting up your environment and installing packages or any other dependencies that your training or scoring script needs on the compute. Azure Machine Learning allows you to create your own environment using
272271

@@ -291,7 +290,7 @@ For more information, see [environment YAML schema](reference-yaml-environment.m
291290

292291
### [Studio](#tab/azure-studio)
293292

294-
1. Select a workspace if you are not already in one.
293+
1. Select a workspace if you aren't already in one.
295294
1. From the left-hand menu, select **Environments**.
296295
1. On the top, select **Custom environments**.
297296
1. Select **Create** to create a new custom environment.
@@ -314,7 +313,7 @@ Azure Machine Learning allows you to work with different types of data:
314313
* `boolean`
315314
* `number`
316315

317-
For most scenarios, you'll use URIs (`uri_folder` and `uri_file`) - a location in storage that can be easily mapped to the filesystem of a compute node in a job by either mounting or downloading the storage to the node.
316+
For most scenarios, you use URIs (`uri_folder` and `uri_file`) - a location in storage that can be easily mapped to the filesystem of a compute node in a job by either mounting or downloading the storage to the node.
318317

319318
`mltable` is an abstraction for tabular data that is to be used for AutoML Jobs, Parallel Jobs, and some advanced scenarios. If you're just starting to use Azure Machine Learning and aren't using AutoML, we strongly encourage you to begin with URIs.
320319

articles/machine-learning/concept-mlflow.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.author: mopeakande
88
ms.reviewer: cacrest
99
ms.service: azure-machine-learning
1010
ms.subservice: mlops
11-
ms.date: 09/25/2024
11+
ms.date: 09/30/2024
1212
ms.topic: concept-article
1313
ms.custom: cliv2, sdkv2, FY25Q1-Linter
1414
#Customer intent: As a data scientist, I want to understand what MLflow is and does so that I can use MLflow with my models.
@@ -29,11 +29,37 @@ Azure Machine Learning workspaces are MLflow-compatible, which means that you ca
2929
> [!TIP]
3030
> Unlike the Azure Machine Learning SDK v1, there's no logging functionality in the Azure Machine Learning v2 SDK. You can use MLflow logging to ensure that your training routines are cloud-agnostic, portable, and have no dependency on Azure Machine Learning.
3131
32+
## What is tracking
33+
34+
When you work with jobs, Azure Machine Learning automatically tracks some information about experiments, such as code, environment, and input and output data. However, models, parameters, and metrics are specific to the scenario, so model builders must configure their tracking.
35+
36+
The saved tracking metadata varies by experiment, and can include:
37+
38+
- Code
39+
- Environment details such as OS version and Python packages
40+
- Input data
41+
- Parameter configurations
42+
- Models
43+
- Evaluation metrics
44+
- Evaluation visualizations such as confusion matrices and importance plots
45+
- Evaluation results, including some evaluation predictions
46+
47+
## Benefits of tracking experiments
48+
49+
Whether you train models with jobs in Azure Machine Learning or interactively in notebooks, experiment tracking helps you:
50+
51+
- Organize all of your machine learning experiments in a single place. You can then search and filter experiments and drill down to see details about previous experiments.
52+
- Easily compare experiments, analyze results, and debug model training.
53+
- Reproduce or rerun experiments to validate results.
54+
- Improve collaboration, because you can see what other teammates are doing, share experiment results, and access experiment data programmatically.
55+
3256
## Tracking with MLflow
3357

58+
Azure Machine Learning workspaces are MLflow-compatible. This compatibility means you can use MLflow to track runs, metrics, parameters, and artifacts in workspaces without needing to change your training routines or inject any cloud-specific syntax. To learn how to use MLflow for tracking experiments and runs in Azure Machine Learning workspaces, see [Track experiments and models with MLflow](how-to-use-mlflow-cli-runs.md).
59+
3460
Azure Machine Learning uses MLflow tracking to log metrics and store artifacts for your experiments. When you're connected to Azure Machine Learning, all MLflow tracking materializes in the workspace you're working in.
3561

36-
To learn how to set up MLflow tracking for experiments and training routines, see [Log metrics, parameters, and files with MLflow](how-to-log-view-metrics.md). You can also [query and compare experiments and runs with MLflow](how-to-track-experiments-mlflow.md).
62+
To learn how to enable logging to monitor real-time run metrics with MLflow, see [Log metrics, parameters, and files with MLflow](how-to-log-view-metrics.md). You can also [query and compare experiments and runs with MLflow](how-to-track-experiments-mlflow.md).
3763

3864
MLflow in Azure Machine Learning provides a way to centralize tracking. You can connect MLflow to Azure Machine Learning workspaces even when you're working locally or in a different cloud. The Azure Machine Learning workspace provides a centralized, secure, and scalable location to store training metrics and models.
3965

articles/machine-learning/concept-v2.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.topic: conceptual
99
ms.author: sgilley
1010
author: sdgilley
1111
ms.reviewer: balapv
12-
ms.date: 01/17/2024
12+
ms.date: 09/30/2024
1313
ms.custom: cliv2, sdkv2, devx-track-python
1414
#Customer intent: As a data scientist, I want to know whether to use v1 or v2 of CLI and SDK.
1515
---
@@ -98,7 +98,7 @@ We encourage you to migrate your code for both CLI and SDK v1 to CLI and SDK v2.
9898

9999
### CLI v2
100100

101-
Azure Machine Learning CLI v1 has been deprecated. Support for the v1 extension will end on September 30, 2025. You will be able to install and use the v1 extension until that date.
101+
Azure Machine Learning CLI v1 has been deprecated. Support for the v1 extension will end on September 30, 2025. You'll be able to install and use the v1 extension until that date.
102102

103103
We recommend that you transition to the `ml`, or v2, extension before September 30, 2025.
104104

@@ -110,7 +110,7 @@ Azure Machine Learning Python SDK v1 doesn't have a planned deprecation date. If
110110
* You're starting a new workflow or pipeline. All new features and future investments will be introduced in v2.
111111
* You want to take advantage of the improved usability of the Python SDK v2 ability to compose jobs and pipelines by using Python functions, with easy evolution from simple to complex tasks.
112112

113-
## Next steps
113+
## Related content
114114

115115
* [Upgrade from v1 to v2](how-to-migrate-from-v1.md)
116116
* Get started with CLI v2:

0 commit comments

Comments
 (0)