Skip to content

Commit a8f5786

Browse files
committed
Merging changes synced from https://github.com/MicrosoftDocs/azure-docs-pr (branch live)
2 parents 33c0d98 + d91b9da commit a8f5786

File tree

6 files changed

+26
-1092
lines changed

6 files changed

+26
-1092
lines changed

articles/cognitive-services/openai/concepts/models.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ For example, our most powerful GPT-3 model is called `text-davinci-002`, while o
4949
5050
## Finding what models are available
5151

52-
You can easily see the models you have available for both inference and fine-tuning in your resource by using the [Models API](../reference.md#models).
52+
You can easily see the models you have available for both inference and fine-tuning in your resource by using the [Models API](/rest/api/cognitiveservices/azureopenai/models/list).
5353

5454
## Finding the right model
5555

articles/cognitive-services/openai/includes/fine-tuning-python.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -100,14 +100,14 @@ The first step in creating a customized model is to choose a base model. The cho
100100
- `davinci`\*
101101
\* available by request
102102

103-
You can use the [Models API](../reference.md#models) to identify which models are fine-tunable. For more information about our base models, see [Models](../concepts/models.md).
103+
You can use the [Models API](/rest/api/cognitiveservices/azureopenai/models/list) to identify which models are fine-tunable. For more information about our base models, see [Models](../concepts/models.md).
104104

105105
## Upload your training data
106106

107107
The next step is to either choose existing prepared training data or upload new prepared training data to use when customizing your model. Once you've prepared your training data, you can upload your files to the service. We offer two ways to upload training data:
108108

109-
- [From a local file](../reference.md#upload-a-file)
110-
- [Import from an Azure Blob store or other web location](../reference.md#import-a-file-from-azure-blob)
109+
- [From a local file](/rest/api/cognitiveservices/azureopenai/files/upload)
110+
- [Import from an Azure Blob store or other web location](/rest/api/cognitiveservices/azureopenai/files/import)
111111

112112
For large data files, we recommend you import from an Azure Blob store. Large files can become unstable when uploaded through multipart forms because the requests are atomic and can't be retried or resumed. For more information about Azure Blob storage, see [What is Azure Blob storage?](../../../storage/blobs/storage-blobs-overview.md)
113113

@@ -204,7 +204,7 @@ status = resp["status"]
204204
print(f'Fine-tuning model with job ID: {job_id}.')
205205
```
206206

207-
You can either use default values for the hyperparameters of the fine-tune job, or you can adjust those hyperparameters for your customization needs. For the previous Python example, we've set the `n_epochs` hyperparameter to 1, indicating that we want just one full cycle through the training data. For more information about these hyperparameters, see the [Create a Fine tune job](../reference.md#create-a-fine-tune-job) section of the [REST API](../reference.md) documentation.
207+
You can either use default values for the hyperparameters of the fine-tune job, or you can adjust those hyperparameters for your customization needs. For the previous Python example, we've set the `n_epochs` hyperparameter to 1, indicating that we want just one full cycle through the training data. For more information about these hyperparameters, see the [Create a Fine tune job](/rest/api/cognitiveservices/azureopenai/fine-tunes/create) section of the [REST API](/rest/api/cognitiveservices/azureopenai/fine-tunes) documentation.
208208

209209
## Check the status of your customized model
210210

@@ -234,7 +234,7 @@ print(f'Found {len(result)} fine-tune jobs.')
234234

235235
## Deploy a customized model
236236

237-
When the fine-tune job has succeeded, the value of `fine_tuned_model` in the response body of the FineTune.retrieve() method is set to the name of your customized model. Your model is now also available for discovery from the [list Models API](../reference.md#list-all-available-models). However, you can't issue completion calls to your customized model until your customized model is deployed. You must deploy your customized model to make it available for use with completion calls.
237+
When the fine-tune job has succeeded, the value of `fine_tuned_model` in the response body of the FineTune.retrieve() method is set to the name of your customized model. Your model is now also available for discovery from the [list Models API](/rest/api/cognitiveservices/azureopenai/models/list). However, you can't issue completion calls to your customized model until your customized model is deployed. You must deploy your customized model to make it available for use with completion calls.
238238

239239
> [!NOTE]
240240
> As with all applications, we require a review process prior to going live.
@@ -347,7 +347,7 @@ You can use various methods to delete the deployment for your customized model:
347347

348348
- [Azure OpenAI Studio](../how-to/fine-tuning.md?pivots=programming-language-studio#delete-your-model-deployment)</a>
349349
- [Azure CLI](/cli/azure/cognitiveservices/account/deployment?preserve-view=true#az-cognitiveservices-account-deployment-delete)
350-
- [REST APIs](../reference.md#delete-a-deployment)
350+
- [REST APIs](/rest/api/cognitiveservices/azureopenai/deployments/delete)
351351
- Python SDK
352352

353353
The following Python example uses the Python SDK to delete the deployment for your customized model.
@@ -363,7 +363,7 @@ result = openai.Deployment.delete(sid=deployment_id)
363363
Similarly, you can use various methods to delete your customized model:
364364

365365
- [Azure OpenAI Studio](../how-to/fine-tuning.md?pivots=programming-language-studio#delete-your-customized-model)
366-
- [REST APIs](../reference.md#delete-a-specific-fine-tuning-job)
366+
- [REST APIs](/rest/api/cognitiveservices/azureopenai/fine-tunes/delete?tabs=HTTP)
367367
- Python SDK
368368

369369
> [!NOTE]
@@ -382,7 +382,7 @@ result = openai.FineTune.delete(sid=job_id)
382382
You can optionally delete training and validation files you've uploaded for training, and result files generated during training, from your Azure OpenAI subscription. You can use the following methods to delete your training, validation, and result files:
383383

384384
- [Azure OpenAI Studio](../how-to/fine-tuning.md?pivots=programming-language-studio#delete-your-training-files)
385-
- [REST APIs](../reference.md#delete-a-file)
385+
- [REST APIs](/rest/api/cognitiveservices/azureopenai/files/delete?tabs=HTTP)
386386
- Python SDK
387387

388388
The following Python example uses the Python SDK to delete the training, validation, and result files for your customized model.
@@ -411,5 +411,5 @@ for id in results:
411411

412412
## Next steps
413413

414-
- Explore the full REST API Reference documentation to learn more about all the fine-tuning capabilities. You can find the [full REST documentation here](../reference.md).
414+
- Explore the control plane REST API Reference documentation to learn more about all the fine-tuning capabilities. You can find the [control plane REST documentation here](/rest/api/cognitiveservices/azureopenai/deployments).
415415
- Explore more of the [Python SDK operations here](https://github.com/openai/openai-python/blob/main/examples/azure/finetuning.ipynb).

articles/cognitive-services/openai/includes/fine-tuning-rest.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -98,14 +98,14 @@ The first step in creating a customized model is to choose a base model. The cho
9898
- `davinci`\*
9999
\* available by request
100100

101-
You can use the [Models API](../reference.md#models) to identify which models are fine-tunable. For more information about our base models, see [Models](../concepts/models.md).
101+
You can use the [Models API](/rest/api/cognitiveservices/azureopenai/models) to identify which models are fine-tunable. For more information about our base models, see [Models](../concepts/models.md).
102102

103103
## Upload your training data
104104

105105
The next step is to either choose existing prepared training data or upload new prepared training data to use when customizing your model. Once you've prepared your training data, you can upload your files to the service. We offer two ways to upload training data:
106106

107-
- [From a local file](../reference.md#upload-a-file)
108-
- [Import from an Azure Blob store or other web location](../reference.md#import-a-file-from-azure-blob)
107+
- [From a local file](/rest/api/cognitiveservices/azureopenai/files/upload?tabs=HTTP)
108+
- [Import from an Azure Blob store or other web location](/rest/api/cognitiveservices/azureopenai/files/import?tabs=HTTP)
109109

110110
For large data files, we recommend you import from an Azure Blob store. Large files can become unstable when uploaded through multipart forms because the requests are atomic and can't be retried or resumed. For more information about Azure Blob storage, see [What is Azure Blob storage?](../../../storage/blobs/storage-blobs-overview.md)
111111

@@ -209,7 +209,7 @@ status = (r.json())["status"]
209209
print(f'Fine-tuning model with job ID: {job_id}.')
210210
```
211211

212-
You can either use default values for the hyperparameters of the fine-tune job, or you can adjust those hyperparameters for your customization needs. For the previous Python example, we've set the `n_epochs` hyperparameter to 1, indicating that we want just one full cycle through the training data. For more information about these hyperparameters, see the [Create a Fine tune job](../reference.md#create-a-fine-tune-job) section of the [REST API](../reference.md) documentation.
212+
You can either use default values for the hyperparameters of the fine-tune job, or you can adjust those hyperparameters for your customization needs. For the previous Python example, we've set the `n_epochs` hyperparameter to 1, indicating that we want just one full cycle through the training data. For more information about these hyperparameters, see the [Create a Fine tune job](/rest/api/cognitiveservices/azureopenai/fine-tunes/create) section of the [REST API](/rest/api/cognitiveservices/azureopenai/fine-tunes) documentation.
213213

214214
## Check the status of your customized model
215215

@@ -242,7 +242,7 @@ print(f'Found {len((r.json())["data"])} fine-tune jobs.')
242242

243243
## Deploy a customized model
244244

245-
When the fine-tune job has succeeded, the value of `fine_tuned_model` in the response body of the `FineTune.retrieve()` method is set to the name of your customized model. Your model is now also available for discovery from the [list Models API](../reference.md#list-all-available-models). However, you can't issue completion calls to your customized model until your customized model is deployed. You must deploy your customized model to make it available for use with completion calls.
245+
When the fine-tune job has succeeded, the value of `fine_tuned_model` in the response body of the `FineTune.retrieve()` method is set to the name of your customized model. Your model is now also available for discovery from the [list Models API](/rest/api/cognitiveservices/azureopenai/models/list). However, you can't issue completion calls to your customized model until your customized model is deployed. You must deploy your customized model to make it available for use with completion calls.
246246

247247
> [!NOTE]
248248
> As with all applications, we require a review process prior to going live.
@@ -383,7 +383,7 @@ You can use various methods to delete the deployment for your customized model:
383383

384384
- [Azure OpenAI Studio](../how-to/fine-tuning.md?pivots=programming-language-studio#delete-your-model-deployment)
385385
- [Azure CLI](/cli/azure/cognitiveservices/account/deployment?view=azure-cli-latest&preserve-view=true#az-cognitiveservices-account-deployment-delete)
386-
- [REST APIs](../reference.md#delete-a-deployment)
386+
- [REST APIs](/rest/api/cognitiveservices/azureopenai/deployments/delete)
387387
- Python SDK
388388

389389
The following Python example uses the REST API to delete the deployment for your customized model.
@@ -400,7 +400,7 @@ r = requests.delete(api_base + 'openai/deployments/' + deployment_id,
400400
Similarly, you can use various methods to delete your customized model:
401401

402402
- [Azure OpenAI Studio](../how-to/fine-tuning.md?pivots=programming-language-studio#delete-your-customized-model)
403-
- [REST APIs](../reference.md#delete-a-specific-fine-tuning-job)
403+
- [REST APIs](/rest/api/cognitiveservices/azureopenai/fine-tunes/delete)
404404
- Python SDK
405405

406406
> [!NOTE]
@@ -420,7 +420,7 @@ r = requests.delete(api_base + 'openai/fine-tunes/' + job_id,
420420
You can optionally delete training and validation files you've uploaded for training, and result files generated during training, from your Azure OpenAI subscription. You can use the following methods to delete your training, validation, and result files:
421421

422422
- [Azure OpenAI Studio](../how-to/fine-tuning.md?pivots=programming-language-studio#delete-your-training-files)
423-
- [REST APIs](../reference.md#delete-a-file)
423+
- [REST APIs](/rest/api/cognitiveservices/azureopenai/files/delete)
424424
- Python SDK
425425

426426
The following Python example uses the REST API to delete the training, validation, and result files for your customized model.
@@ -456,5 +456,5 @@ for id in results:
456456

457457
## Next steps
458458

459-
- Explore the full REST API Reference documentation to learn more about all the fine-tuning capabilities. You can find the [full REST documentation here](../reference.md).
459+
- Explore the control plane REST API Reference documentation to learn more about all the fine-tuning capabilities. You can find the [control plane REST documentation here](/rest/api/cognitiveservices/azureopenai/deployments).
460460
- Explore more of the [Python SDK operations here](https://github.com/openai/openai-python/blob/main/examples/azure/finetuning.ipynb).

articles/cognitive-services/openai/includes/fine-tuning-studio.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ The following hyperparameters are available:
210210
| **Learning rate multiplier** | The learning rate multiplier to use for training. The fine-tuning learning rate is the original learning rate used for pre-training, multiplied by this value. |
211211
| **Prompt loss weight** | The weight to use for loss on the prompt tokens. This value controls how much the model tries to learn to generate the prompt (as compared to the completion, which always has a weight of 1.0.) Increasing this value can add a stabilizing effect to training when completions are short. |
212212

213-
For more information about these hyperparameters, see the [Create a Fine tune job](../reference.md#create-a-fine-tune-job) section of the [REST API](../reference.md) documentation.
213+
For more information about these hyperparameters, see the [Create a Fine tune job](/rest/api/cognitiveservices/azureopenai/fine-tunes/create) section of the [REST API](/rest/api/cognitiveservices/azureopenai/fine-tunes) documentation.
214214

215215
After you've chosen either default or advanced options, select **Next** to [review your choices and train your fine-tuned model](#review-your-choices-and-train-your-model).
216216

0 commit comments

Comments
 (0)