You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/ai-services/openai/how-to/weights-and-biases-integration.md
+18-18Lines changed: 18 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,80 +21,80 @@ Weights & Biases (W&B) is a powerful AI developer platform that enables machine
21
21
## Prerequisites
22
22
23
23
- An Azure OpenAI resource. For more information, see [Create a resource and deploy a model with Azure OpenAI](../how-to/create-resource.md). The resource should be in a [region that supports fine-tuning](../concepts/models.md#fine-tuning-models).
24
-
-All users on your team who need to fine-tune models should have **Cognitive Services OpenAI Contributor** access assigned for the new Azure OpenAI resource.
24
+
-Ensure all team members who need to fine-tune models have **Cognitive Services OpenAI Contributor** access assigned for the new Azure OpenAI resource.
25
25
- A [Weights & Biases](https://wandb.ai) account and API key.
26
26
-[Azure Key Vault](https://portal.azure.com/#create/Microsoft.KeyVault). For more information on creating a key vault, see the [Azure Key Vault quickstart](/azure/key-vault/general/quick-create-portal).
27
27
28
28
## Enable System Managed Identity
29
29
30
-
First you will need to enable [System Managed Identity](/entra/identity/managed-identities-azure-resources/overview) for your Azure OpenAI resource.
30
+
First, enable [System Managed Identity](/entra/identity/managed-identities-azure-resources/overview) for your Azure OpenAI resource.
31
31
32
-
:::image type="content" source="../media/how-to/weights-and-biases/system-managed.png" alt-text="Screenshot of the system managed identity enabled user experience." lightbox="../media/how-to/weights-and-biases/system-managed.png":::
32
+
:::image type="content" source="../media/how-to/weights-and-biases/system-managed.png" alt-text="Screenshot of the system managed identity interface." lightbox="../media/how-to/weights-and-biases/system-managed.png":::
33
33
34
34
## Retrieve Weights & Biases API key
35
35
36
-
Sign in to [https://wandb.ai](https://wandb.ai) and go to [User Settings](https://wandb.ai/settings).
36
+
Sign in to [https://wandb.ai](https://wandb.ai) and go to the [User Settings](https://wandb.ai/settings).
37
37
38
-
Under **API Keys** select **Reveal** to access your key and copy to the clipboard.
38
+
Under **API Keys**, select **Reveal** to access your key and copy it to the clipboard.
39
39
40
40
:::image type="content" source="../media/how-to/weights-and-biases/reveal-key.png" alt-text="Screenshot of API keys section of User Settings user experience." lightbox="../media/how-to/weights-and-biases/reveal-key.png":::
41
41
42
-
If you would like to create a new key use [https://wandb.ai/authorize](https://wandb.ai/authorize), and copy the key to add to your integration configuration later.
42
+
If you would like to create a new key, use [https://wandb.ai/authorize](https://wandb.ai/authorize), and copy the key to add to your integration configuration later.
43
43
44
44
## Configure Azure Key Vault
45
45
46
-
In order to securely, send data from Azure OpenAI to your Weights & Biases projects you'll need to use [Azure Key Vault](/azure/key-vault/general/overview).
46
+
To securely send data from Azure OpenAI to your Weights & Biases projects, you'll need to use [Azure Key Vault](/azure/key-vault/general/overview).
47
47
48
48
### Add your Weights & Biases API key as a Secret to your Azure Key Vault
49
49
50
50
1. Navigate to the Azure Key Vault you are planning to use.
51
-
2. To read\write secrets to your Azure Key Vault, you must explicitly assign access.
52
-
3. Go to Settings > Access configuration, under Permission model we recommend you select Azure role-based access control if this isn't already selected. Learn more about [Azure role-based access control](/azure/role-based-access-control/overview?WT.mc_id=Portal-Microsoft_Azure_KeyVault).
51
+
2. To read and write secrets to your Azure Key Vault, you must explicitly assign access.
52
+
3. Go to **Settings** > **Access** configuration. Under **Permission** model, we recommend you select Azure role-based access control if this isn't already selected. Learn more about [Azure role-based access control](/azure/role-based-access-control/overview?WT.mc_id=Portal-Microsoft_Azure_KeyVault).
53
53
54
54
:::image type="content" source="../media/how-to/weights-and-biases/role-based-access-control.png" alt-text="Screenshot of key vault access configuration user interface." lightbox="../media/how-to/weights-and-biases/role-based-access-control.png":::
55
55
56
56
### Assign Key Vault Secrets Officer role
57
57
58
-
Now that you set your permission model to Azure role-based access control, you can give yourself the **Key Vault Secrets Officer** role.
58
+
Now that you have set your permission model to Azure role-based access control, you can give yourself the **Key Vault Secrets Officer** role.
59
59
60
60
1. Go to **Access control (IAM)** and then **Add role assignment**
61
61
62
62
:::image type="content" source="../media/how-to/weights-and-biases/access-control.png" alt-text="Screenshot of the access control add role assignment user experience." lightbox="../media/how-to/weights-and-biases/access-control.png":::
63
63
64
-
2. Choose **Key Vault Secrets Officer** and add your account as a member and select **review & assign**.
64
+
2. Choose **Key Vault Secrets Officer**, add your account as a member, and select **review & assign**.
65
65
66
66
:::image type="content" source="../media/how-to/weights-and-biases/key-vault-secret-officer.png" alt-text="Screenshot of the key vault secret officer role assignment." lightbox="../media/how-to/weights-and-biases/key-vault-secret-officer.png":::
67
67
68
68
### Create secrets
69
69
70
-
1. From within your key vault resource under **Objects** and select **Secrets** > **Generate/Import**.
70
+
1. From within your key vault resource under **Objects**, select **Secrets** > **Generate/Import**.
71
71
72
72
:::image type="content" source="../media/how-to/weights-and-biases/secrets.png" alt-text="Screenshot of the key vault secrets user interface." lightbox="../media/how-to/weights-and-biases/secrets.png":::
73
73
74
-
2. Provide a name to your secret and save the generated API key from Weights & Biases to the **secret value**.
74
+
2. Provide a name for your secret and save the generated Weights & Biases API key to the **secret value**.
75
75
76
76
:::image type="content" source="../media/how-to/weights-and-biases/create-secret.png" alt-text="Screenshot of the key vault secrets creation user interface." lightbox="../media/how-to/weights-and-biases/create-secret.png":::
77
77
78
-
3. Make sure to capture the secret name and key vault url. Key vault URL can be retrieved from **Overview** section of your key-vault.
78
+
3. Make sure to capture the secret name and key vault URL. The key vault URL can be retrieved from **Overview** section of your keyvault.
79
79
80
80
### Give your Key Vault permission on your Azure OpenAI account
81
81
82
-
If you used vault access policy earlier to read/write secrets to your Azure Key Vault, you should use that again. Otherwise, continue to use Azure role-based access control. **We recommend Azure role-based access control, though if it does not work for you, please try Vault Access policy.**
82
+
If you used a Vault Access policy earlier to read and write secrets to your Azure Key Vault, you should use that again. Otherwise, continue to use Azure role-based access control. **We recommend Azure role-based access control. However, if it does not work for you, please try Vault Access policy.**
83
83
84
84
Give your Azure OpenAI resource the **Key Vault Secrets Officer** role.
85
85
86
86
:::image type="content" source="../media/how-to/weights-and-biases/assign.png" alt-text="Screenshot of the assign managed identity user interface." lightbox="../media/how-to/weights-and-biases/assign.png":::
87
87
88
88
## Link Weights & Biases with Azure OpenAI
89
89
90
-
1. Navigate to [AI Foundry portal](https://ai.azure.com) and select your Azure OpenAI fine-tuning resource.
90
+
1. Navigate to the [AI Foundry portal](https://ai.azure.com) and select your Azure OpenAI fine-tuning resource.
91
91
92
92
:::image type="content" source="../media/how-to/weights-and-biases/manage-integrations.png" alt-text="Screenshot of the manage integrations button." lightbox="../media/how-to/weights-and-biases/manage-integrations.png":::
93
93
94
-
2. Add your key vault URL and secret > then select **Update**.
94
+
2. Add your key vault URL and secret. Then, select **Update**.
95
95
96
96
:::image type="content" source="../media/how-to/weights-and-biases/integration.png" alt-text="Screenshot of the manage integrations for Weights and Biases user experience." lightbox="../media/how-to/weights-and-biases/integration.png":::
97
97
98
-
3. Now when you create new fine-tuning jobs you'll have the option to log data from the job to your Weights & Biases account.
98
+
3. Now, when you create new fine-tuning jobs, you'll have the option to log data from the job to your Weights & Biases account.
99
99
100
100
:::image type="content" source="../media/how-to/weights-and-biases/dashboards.png" alt-text="Screenshot of the weights and biases dashboards." lightbox="../media/how-to/weights-and-biases/dashboards.png":::
0 commit comments