Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add the prerequisite for azure-ai-ml package. #1675

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion docs-ref-services/latest/ai-ml-readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ For a more complete set of Azure libraries, see https://aka.ms/azsdk/python/all
- You must have an [Azure subscription][azure_subscription].
- An [Azure Machine Learning Workspace][workspace].

### Install the package
### Install the Azure ML client library package

Install the Azure ML client library for Python with [pip][pip_link]:

Expand All @@ -38,6 +38,19 @@ pip install azure-ai-ml

### Authenticate the client

In order to interact with the Azure ML service, you'll need to create an instance of the [ML Client][ml_client] class.

[Client secret credential][ClientSecretCredential] authentication is being used in this getting started section but you can find more ways to authenticate with the [Azure identity package][azure_identity]. To use the [DefaultAzureCredential][DefaultAzureCredential] provider shown below,
or other credential providers provided with the Azure SDK, you should install the azure-identity package:

```bash
pip install azure-identity
```

### Create ML Client instance

Creates an instance of the ML Client.

```python
from azure.ai.ml import MLClient
from azure.identity import DefaultAzureCredential
Expand Down Expand Up @@ -134,6 +147,9 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con
[workspace]: /azure/machine-learning/concept-workspace
[python_logging]: https://docs.python.org/3/library/logging.html
[sdk_logging_docs]: /azure/developer/python/azure-sdk-logging
[ml_client]: https://learn.microsoft.com/python/api/azure-ai-ml/azure.ai.ml.mlclient?view=azure-python
[DefaultAzureCredential]: https://learn.microsoft.com/python/api/azure-identity/azure.identity.defaultazurecredential?view=azure-python
[ClientSecretCredential]: https://learn.microsoft.com/python/api/azure-identity/azure.identity.clientsecretcredential?view=azure-python
[azure_core_readme]: https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-ml_1.3.0/sdk/core/azure-core/README.md
[pip_link]: https://pypi.org/project/pip/
[azure_core_ref_docs]: https://aka.ms/azsdk-python-core-policies
Expand Down