陈前锋/promptflow

代码拉取完成,页面将自动刷新

richgiteeai

Watch

不关注关注所有动态仅关注版本发行动态关注但不提醒动态

1 Star 0 Fork 0

陈前锋/promptflow

代码 Issues 0 Pull Requests 0 Wiki 统计流水线

服务

加入 Gitee

与超过 1400万开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)

免费加入

已有帐号? 立即登录

文件

新建文件新建 Diagram 文件

main

分支 (320)

标签 (71)

管理

main

release/promptflow/1.4.0

dev_yuhaliu/gpt4_v_test

devs/peiwen/add_executor_server

luluzuo/ModifyDocOfWorkerCount

chw/pf/executor_label

feature/test_data_gen

chjinche/tool_1.1.0

heta/exec-line-timeout-poc

devs/linatang/support_batch_for_eager_flow

zhengfei/fundamental/less-jobs-daily-live-azure-test

zhengfei/extract-open

chenyin/unskip_test_flow_build_executable

zhangxingzhi/pfs-service-for-telemetry

migu/resume-batch-run

chesi/support-input-index

dev/jiazeng/support-input-index

hod/run-download-check-permission

shimin/exec_line_async

devs/robbenwang_handle_image_url

promptflow_1.4.0rc4

promptflow_1.4.0rc3

tools_1.1.0rc2

tools_1.1.0rc1

promptflow_1.4.0rc2

v1.0.2-tools

v1.0.3-tools

promptflow_1.4.0rc1

promptflow_1.3.0

promptflow_1.3.0rc4

promptflow_1.3.0rc3

promptflow_1.3.0rc2

promptflow_1.3.0rc1

promptflow_1.2.0

promptflow_1.2.0rc2

v1.0.1-tools

promptflow_1.1.1

promptflow_1.2.0rc1

promptflow_1.1.0

v1.0.0-tools

克隆/下载

HTTPS SSH SVN SVN+SSH 下载ZIP

提示

下载代码请复制以下命令到终端执行

为确保你提交的代码身份被 Gitee 正确识别,请执行以下命令完成配置

git config --global user.name userName 
git config --global user.email userEmail

初次使用 SSH 协议进行代码克隆、推送等操作时,需按下述提示完成 SSH 配置

1 生成 RSA 密钥

2 获取 RSA 公钥内容,并配置到 SSH公钥中

在 Gitee 上使用 SVN,请访问使用指南

使用 HTTPS 协议时,命令行会出现如下账号密码验证步骤。基于安全考虑,Gitee 建议配置并使用私人令牌替代登录密码进行克隆、推送等操作

Username for 'https://gitee.com': userName

Password for 'https://userName@gitee.com': # 私人令牌

新建文件新建 Diagram 文件

分支 320

标签 71

贡献代码

同步代码

创建 Pull Request

了解更多

对比差异通过 Pull Request 同步

同步更新到分支

通过 Pull Request 同步

将会在向当前分支创建一个 Pull
Request,合入后将完成同步

Bhavy Khatri Update documentation for deploying docker ... 5053232

1059 次提交

File empty ...

cloud

concepts

dev

how-to-guides

integrations

media

reference

tutorials

README.md

index.md

README

# Promptflow documentation contribute guidelines

This folder contains the source code for [prompt flow documentation site](https://microsoft.github.io/promptflow/).

This readme file will not be included in above doc site. It keeps a guide for promptflow documentation contributors.

## Content
Below is a table of important doc pages.
| Category | Article |
|----------------|----------------|
|Quick start|[Getting started with prompt flow](./how-to-guides/quick-start.md)|
|Concepts|[Flows](./concepts/concept-flows.md) [Tools](./concepts/concept-tools.md) [Connections](./concepts/concept-connections.md) [Variants](./concepts/concept-variants.md) |
|How-to guides|[How to initialize and test a flow](./how-to-guides/init-and-test-a-flow.md) [How to run and evaluate a flow](./how-to-guides/run-and-evaluate-a-flow/index.md) [How to tune prompts using variants](./how-to-guides/tune-prompts-with-variants.md) [How to deploy a flow](./how-to-guides/deploy-a-flow/index.md) [How to create and use your own tool package](./how-to-guides/develop-a-tool/create-and-use-tool-package.md)|
|Tools reference|[LLM tool](./reference/tools-reference/llm-tool.md) [Prompt tool](./reference/tools-reference/prompt-tool.md) [Python tool](./reference/tools-reference/python-tool.md) [Embedding tool](./reference/tools-reference/embedding_tool.md) [SERP API tool](./reference/tools-reference/serp-api-tool.md) ||

## Writing tips
0. Reach the doc source repository by clicking `Edit this page` on any page.
 ![Edit this page](./media/edit-this-page.png)
1. Please use :::{admonition} for experimental feature or notes, and admonition with dropdown for the Limitation Part.
2. Please use ::::{tab-set} to group your sdk/cli example, and put the cli at first. Use :sync: to sync multiple tables . 
3. If you are unclear with the above lines, refer to [get started](./how-to-guides/quick-start.md) to see the usage.
4. Add gif: Use [ScreenToGif](https://www.screentogif.com/) to record your screen, edit and save as a gif.
5. Reach more element style at [Sphinx Design Components](https://pydata-sphinx-theme.readthedocs.io/en/latest/user_guide/web-components.html).

## Preview your changes

**Local build**: We suggest using local build at the beginning, as it's fast and efficiency.

Please refer to [How to build doc site locally](./dev/documentation_guidelines.md#how-to-build-doc-site-locally).

## FAQ
### Adding image in doc
Please use markdown syntax `![img desc](img link)` to reference image, because the relative path of image will be changed after sphinx build, and image placed in html tags can not be referenced when build.

### Draw flow chart in doc 
We recommend using the mermaid, learn more from the [mermaid syntax doc](https://mermaid-js.github.io/mermaid/#/./flowchart?id=flowcharts-basic-syntax)
- Recommend to install [vscode extension](https://marketplace.visualstudio.com/items?itemName=bierner.markdown-mermaid) to preview graph in vscode.

## Reference
- [md-and-rst](https://coderefinery.github.io/sphinx-lesson/md-and-rst/)
- [sphinx-quickstart](https://www.sphinx-doc.org/en/master/usage/quickstart.html)