Skip to content

Commit

Permalink
[Doc] Refine connection management doc and others (#1067)
Browse files Browse the repository at this point in the history
# Description

- Refine connection management doc to remind
`StoreConnectionEncryptionKeyError`
  - (#1009)
- Refine run-and-evaluate doc to add links to `manage runs` and `python
library reference`
  - (#771)

# 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 Nov 9, 2023
1 parent 36d7138 commit d5d3c1a
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 2 deletions.
4 changes: 4 additions & 0 deletions docs/how-to-guides/manage-connections.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ We are going to use AzureOpenAIConnection as an example for strong type connecti

## Create a connection

:::{note}
If you are using `WSL` or other OS without default keyring storage backend, you may encounter `StoreConnectionEncryptionKeyError`, please refer to [FAQ](./faq.md#connection-creation-failed-with-storeconnectionencryptionkeyerror) for the solutions.
:::

::::{tab-set}
:::{tab-item} CLI
:sync: CLI
Expand Down
10 changes: 8 additions & 2 deletions docs/how-to-guides/manage-runs.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,14 @@
:::{admonition} Experimental feature
This is an experimental feature, and may change at any time. Learn [more](faq.md#stable-vs-experimental).
:::
You can manage runs by creating a run against bulk inputs or an existing run.
You can:

This documentation will walk you through how to manage your runs with CLI, SDK and VS Code Extension.

In general:
- For `CLI`, you can run `pf/pfazure run --help` in terminal to see the help messages.
- For `SDK`, you can refer to [Promptflow Python Library Reference](../reference/python-library-reference/promptflow.md) and check `PFClient.runs` for more run operations.

Let's take a look at the following topics:

- [Manage runs](#manage-runs)
- [Create a run](#create-a-run)
Expand Down
5 changes: 5 additions & 0 deletions docs/how-to-guides/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,11 @@ See more details of this topic in [Develop a flow](./develop-a-flow/index.md).

### Create necessary connections

:::{note}
If you are using `WSL` or other OS without default keyring storage backend, you may encounter `StoreConnectionEncryptionKeyError`, please refer to [FAQ](./faq.md#connection-creation-failed-with-storeconnectionencryptionkeyerror) for the solutions.
:::


The [`connection`](../concepts/concept-connections.md) helps securely store and manage secret keys or other sensitive credentials required for interacting with LLM and other external tools for example Azure Content Safety.

The sample flow [web-classification](https://github.com/microsoft/promptflow/tree/main/examples/flows/standard/web-classification) uses connection `open_ai_connection` inside, e.g. `classify_with_llm` node needs to talk to `llm` using the connection.
Expand Down
6 changes: 6 additions & 0 deletions docs/how-to-guides/run-and-evaluate-a-flow/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,9 @@ pf.visualize(base_run)

![q_0](../../media/how-to-guides/quick-start/flow-run-visualize-single-run.png)

Feel free to check [Promptflow Python Library Reference](../../reference/python-library-reference/promptflow.md) for all SDK public interfaces.


:::

:::{tab-item} VS Code Extension
Expand All @@ -106,6 +109,7 @@ Click the bulk test button on the top of the visual editor to trigger flow test.

::::

We also have a more detailed documentation [Manage runs](../manage-runs.md) demonstrating how to manage your finished runs with CLI, SDK and VS Code Extension.

## Evaluate your flow

Expand Down Expand Up @@ -228,6 +232,8 @@ There are actions to trigger local batch runs. To perform an evaluation you can
Learn more about:
- [Tune prompts with variants](../tune-prompts-with-variants.md)
- [Deploy a flow](../deploy-a-flow/index.md)
- [Manage runs](../manage-runs.md)
- [Python library reference](../../reference/python-library-reference/promptflow.md)

```{toctree}
:maxdepth: 1
Expand Down

0 comments on commit d5d3c1a

Please sign in to comment.