Skip to content

Commit caa665b

Browse files
authored
Merge pull request #117 from J2-D2-3PO/patch-1
Minor writing updates to weights-and-biases-integration.md
2 parents 64a9695 + ab29f43 commit caa665b

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

articles/ai-services/openai/how-to/weights-and-biases-integration.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -21,80 +21,80 @@ Weights & Biases (W&B) is a powerful AI developer platform that enables machine
2121
## Prerequisites
2222

2323
- 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.
2525
- A [Weights & Biases](https://wandb.ai) account and API key.
2626
- [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).
2727

2828
## Enable System Managed Identity
2929

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.
3131

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":::
3333

3434
## Retrieve Weights & Biases API key
3535

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).
3737

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.
3939

4040
:::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":::
4141

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.
4343

4444
## Configure Azure Key Vault
4545

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).
4747

4848
### Add your Weights & Biases API key as a Secret to your Azure Key Vault
4949

5050
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).
5353

5454
:::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":::
5555

5656
### Assign Key Vault Secrets Officer role
5757

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.
5959

6060
1. Go to **Access control (IAM)** and then **Add role assignment**
6161

6262
:::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":::
6363

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**.
6565

6666
:::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":::
6767

6868
### Create secrets
6969

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**.
7171

7272
:::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":::
7373

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**.
7575

7676
:::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":::
7777

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 key vault.
7979

8080
### Give your Key Vault permission on your Azure OpenAI account
8181

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.**
8383

8484
Give your Azure OpenAI resource the **Key Vault Secrets Officer** role.
8585

8686
:::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":::
8787

8888
## Link Weights & Biases with Azure OpenAI
8989

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.
9191

9292
:::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":::
9393

94-
2. Add your key vault URL and secret > then select **Update**.
94+
2. Add your key vault URL and secret. Then, select **Update**.
9595

9696
:::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":::
9797

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.
9999

100100
:::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

Comments
 (0)