Skip to content

Commit 8d6ed76

Browse files
add diagram to readme (#41293)
1 parent fa3d585 commit 8d6ed76

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

sdk/ml/azure-ai-ml/README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,43 @@ ml_client = MLClient(
4444

4545
## Key concepts
4646

47+
Refer the below high level sequence diagram illustrating the package's workflow:
48+
49+
![azure-ai-ml sequence diagram](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/ml/azure-ai-ml/azure_ai_ml_seq_diagram.png?raw=true)
50+
51+
## SDK Architecture Components
52+
53+
The sequence diagram above illustrates the architecture and workflow of the Azure ML Python SDK v2. Here's an explanation of the key components:
54+
55+
- **User**: You, the developer using the SDK to interact with Azure ML.
56+
- **Entity**: Python classes representing Azure ML resources like Jobs, Models, Components, etc.
57+
- **Schema**: Validation classes that ensure entities conform to expected structures and requirements.
58+
- **MLClient**: The main entry point for all operations, providing access to various services.
59+
- **Operations**: Specialized classes handling specific resource types (jobs, models, endpoints, etc.).
60+
- **Telemetry**: Internal component for monitoring and collecting usage data (opt-out available).
61+
- **Serialization**: Converts between Python objects and REST API formats.
62+
- **REST Client**: Manages HTTP communications with Azure ML services.
63+
- **Authentication**: Handles identity and access tokens via Azure Identity libraries.
64+
- **AzureML Service**: The backend Azure Machine Learning service.
65+
66+
## Workflow Description
67+
68+
The diagram depicts two main workflows:
69+
70+
1. **Entity Creation and Validation**:
71+
- Create entities directly using Python classes or load from YAML files
72+
- YAML files are validated against schemas to ensure correctness
73+
- Validation errors are reported immediately if found
74+
75+
2. **Operation Execution**:
76+
- Initialize MLClient with proper credentials
77+
- Request operations through the client (create, get, list, delete, etc.)
78+
- Operations are routed to specialized classes for handling
79+
- Entities are serialized into REST API format
80+
- Authenticated HTTP requests are sent to Azure ML services
81+
- Responses are deserialized back into entity objects
82+
- Results are returned to the user
83+
4784
Azure Machine Learning Python SDK v2 comes with many new features like standalone local jobs, reusable components for pipelines and managed online/batch inferencing. The SDK v2 brings consistency and ease of use across all assets of the platform. The Python SDK v2 offers the following capabilities:
4885
* Run **Standalone Jobs** - run a discrete ML activity as Job. This job can be run locally or on the cloud. We currently support the following types of jobs:
4986
* Command - run a command (Python, R, Windows Command, Linux Shell etc.)

0 commit comments

Comments
 (0)