Skip to content

Commit

Permalink
[doc] highlight tracing feature (microsoft#3518)
Browse files Browse the repository at this point in the history
# Description

[doc] highlight tracing feature

# 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.

---------

Signed-off-by: Brynn Yin <[email protected]>
Co-authored-by: Brynn Yin <[email protected]>
  • Loading branch information
wangchao1230 and brynn-code authored Jul 9, 2024
1 parent 95b1ba2 commit c6ecbf2
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 9 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ With prompt flow, you will be able to:

- **Create and iteratively develop flow**
- Create executable [flows](https://microsoft.github.io/promptflow/concepts/concept-flows.html) that link LLMs, prompts, Python code and other [tools](https://microsoft.github.io/promptflow/concepts/concept-tools.html) together.
- Debug and iterate your flows, especially the [interaction with LLMs](https://microsoft.github.io/promptflow/concepts/concept-connections.html) with ease.
- Debug and iterate your flows, especially [tracing interaction with LLMs](https://microsoft.github.io/promptflow/how-to-guides/tracing/index.html) with ease.
- **Evaluate flow quality and performance**
- Evaluate your flow's quality and performance with larger datasets.
- Integrate the testing and evaluation into your CI/CD system to ensure quality of your flow.
Expand Down
3 changes: 2 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ html_theme.sidebar_secondary.remove: true
With prompt flow, you will be able to:

- **Create [flows](./concepts/concept-flows.md)** that link [LLMs](./reference/tools-reference/llm-tool.md), [prompts](./reference/tools-reference/prompt-tool.md), [Python](./reference/tools-reference/python-tool.md) code and other [tools](./concepts/concept-tools.md) together in a executable workflow.
- **Debug and iterate your flows**, especially the interaction with LLMs with ease.
- **Debug and iterate your flows**, especially [tracing interaction with LLMs](how-to-guides/tracing/index.md) with ease.
- **Evaluate your flows**, calculate quality and performance metrics with larger datasets.
- **Integrate the testing and evaluation into your CI/CD system** to ensure quality of your flow.
- **Deploy your flows** to the serving platform you choose or integrate into your app's code base easily.
Expand All @@ -39,6 +39,7 @@ This documentation site contains guides for prompt flow [sdk, cli](https://pypi.
- header: "📒 How-to Guides"
content: "
Articles guide user to complete a specific task in prompt flow.<br/><br/>
- [Tracing](how-to-guides/tracing/index.md)<br/>
- [Develop a flow](how-to-guides/develop-a-flex-flow/index.md)<br/>
- [Run and evaluate a flow](how-to-guides/run-and-evaluate-a-flow/index.md)<br/>
- [Deploy a flow](how-to-guides/deploy-a-flow/index.md)<br/>
Expand Down
20 changes: 18 additions & 2 deletions scripts/docs/_static/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,33 @@
max-width: 70em;
}

/* Background color for feature announcement */
html[data-theme="light"] {
--header-announcement-color: #fff070;
--header-announcement-color: #3278e5;
}

html[data-theme="dark"] {
--header-announcement-color: #4d4d00;
--header-announcement-color: #67d6ed;
}

.bd-header-announcement {
background: var(--header-announcement-color);
}
/* Background color for feature announcement */

/* Background color for warning announcement */
/*html[data-theme="light"] {*/
/* --header-announcement-color: #fff070;*/
/*}*/

/*html[data-theme="dark"] {*/
/* --header-announcement-color: #4d4d00;*/
/*}*/

/*.bd-header-announcement {*/
/* background: var(--header-announcement-color);*/
/*}*/
/* Background color for warning announcement */

/* (A) LIGHTBOX BACKGROUND */
#lightbox {
Expand Down
9 changes: 5 additions & 4 deletions scripts/docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -112,10 +112,11 @@
"show_toc_level": 1,
"navbar_align": "left", # [left, content, right] For testing that the navbar items align properly
"navbar_center": ["navbar-nav"],
"announcement": "<b>[IMPORTANT]</b> Please uninstall existing promptflow and sub packages before you "
"upgrade from promptflow<=1.7.0 to newer version. Reach "
"<a href='https://microsoft.github.io/promptflow/how-to-guides/faq.html#promptflow-1-8-0-upgrade-guide'>"
"here</a> for more details.",
"announcement": "🚀<b style='color:black;'>"
"Promptflow 1.13.0 has released! Try new feature: "
"<a href='https://microsoft.github.io/promptflow/how-to-guides/tracing/index.html' style='color:black;'>"
"<u>tracing interaction with LLMs</u></a>."
"</b>",
"show_nav_level": 1,
}

Expand Down
2 changes: 1 addition & 1 deletion src/promptflow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ With prompt flow, you will be able to:

- **Create and iteratively develop flow**
- Create executable [flows](https://microsoft.github.io/promptflow/concepts/concept-flows.html) that link LLMs, prompts, Python code and other [tools](https://microsoft.github.io/promptflow/concepts/concept-tools.html) together.
- Debug and iterate your flows, especially the [interaction with LLMs](https://microsoft.github.io/promptflow/concepts/concept-connections.html) with ease.
- Debug and iterate your flows, especially [tracing interaction with LLMs](https://microsoft.github.io/promptflow/how-to-guides/tracing/index.html) with ease.
- **Evaluate flow quality and performance**
- Evaluate your flow's quality and performance with larger datasets.
- Integrate the testing and evaluation into your CI/CD system to ensure quality of your flow.
Expand Down

0 comments on commit c6ecbf2

Please sign in to comment.