Skip to content

Commit

Permalink
[Doc] Add cloud run tracking doc (microsoft#3250)
Browse files Browse the repository at this point in the history
# Description

Please add an informative description that covers that changes made by
the pull request and link all relevant issues.

# All Promptflow Contribution checklist:
- [ ] **The pull request does not introduce [breaking changes].**
- [ ] **CHANGELOG is updated for new features, bug fixes or other
significant changes.**
- [ ] **I have read the [contribution guidelines](../CONTRIBUTING.md).**
- [ ] **Create an issue and link to the pull request to get dedicated
review from promptflow team. Learn more: [suggested
workflow](../CONTRIBUTING.md#suggested-workflow).**

## General Guidelines and Best Practices
- [ ] Title of the pull request is clear and informative.
- [ ] There are a small number of commits, each of which have an
informative message. This means that previously merged commits do not
appear in the history of the PR. For more information on cleaning up the
commits in your PR, [see this
page](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/cleaning-up-commits.md).

### Testing Guidelines
- [ ] Pull request includes test coverage for the included changes.
  • Loading branch information
0mza987 authored May 14, 2024
1 parent 59e53d5 commit 2cd50b2
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 3 deletions.
13 changes: 10 additions & 3 deletions docs/cloud/azureai/tracing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,8 @@ pf config set trace.destination=azureml://subscriptions/<subscription-id>/resour

Fill in with your own subscription ID, resource group name, workspace or project name, and all is ready now. You can make LLM calls, run LLM application or execute your flow with `pf flow test` or `pf run create`, you will see an Azure portal URL link in the console:

```console
You can view the traces in cloud from Azure portal: https://ml.azure.com/prompts/trace/run/<run-name>/details?wsid=/subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.MachineLearningServices/workspaces/<workspace-or-project-name>
```
![trace-ui-portal](../../../media/cloud/azureai/tracing/portal_url.png)

Click the link to view the traces in Azure portal, and feel free to share it with your team members.

![trace-ui-portal](../../../media/trace/trace-ui-portal-demo.gif)
Expand Down Expand Up @@ -94,3 +93,11 @@ pf config set trace.destination=none
```

Then no traces will be logged to neither local nor cloud.


```{toctree}
:maxdepth: 1
:hidden:
run_tracking
```
32 changes: 32 additions & 0 deletions docs/cloud/azureai/tracing/run_tracking.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Run tracking

:::{admonition} Experimental feature
This is an experimental feature, and may change at any time. Learn [more](../../../how-to-guides/faq.md#stable-vs-experimental).
:::

After you follow [tracing](./index.md) to set trace destination to cloud and successfully run a flow locally, there will be a run record in Azure ML workspace or Azure AI project. You can view the traces in cloud from Azure portal, and feel free to share it with your team members.

## Portal tracing run list

Except clicking the portal URL link in the console, you can also find the result in the tab `Tracing` -> `Runs`:

![img](../../../media/cloud/azureai/tracing/run_tracking_list.png)

As a result, you will not be able to find these local-to-cloud runs in the tab `Prompt flow` -> `Runs`.

## View with pfazure commands

You can also view the details of the run record with most of the [pfazure run commands](../../../reference/pfazure-command-reference.md#pfazure-run).

## Compare with a cloud run

| | Local-to-cloud run | Cloud run |
|---|---|---|
| Compute | Local | Automatic runtime/Compute instance |
| Run tracking timing | After the run is completed locally | Real-time on cloud |

## Next steps

Learn more about:
- [Run prompt flow in Azure AI](../run-promptflow-in-azure-ai.md)
- [CLI reference: pfazure](../../../reference/pfazure-command-reference.md)
Binary file added docs/media/cloud/azureai/tracing/portal_url.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2cd50b2

Please sign in to comment.