From 6e13bfdce53a3610507bc1d2aee54fa977d8a34c Mon Sep 17 00:00:00 2001 From: minggu Date: Sun, 22 Oct 2023 17:18:56 +0800 Subject: [PATCH 1/5] Fix typo in readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1e3802a472a..d04aeb5ab9a 100644 --- a/README.md +++ b/README.md @@ -93,7 +93,7 @@ We also offer a VS Code extension (a flow designer) for an interactive flow deve You can install it from the visualstudio marketplace. -#### Deep dive into flow development +#### Deep delve into flow development [Getting Started with Prompt Flow](https://microsoft.github.io/promptflow/how-to-guides/quick-start.html): A step by step guidance to invoke your first flow run. From 16c79f6008e149687df00e89a3e312a147f18d13 Mon Sep 17 00:00:00 2001 From: minggu Date: Sun, 22 Oct 2023 21:42:56 +0800 Subject: [PATCH 2/5] Fix syntax error --- docs/how-to-guides/quick-start.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to-guides/quick-start.md b/docs/how-to-guides/quick-start.md index 29052344d91..e128418ac0a 100644 --- a/docs/how-to-guides/quick-start.md +++ b/docs/how-to-guides/quick-start.md @@ -36,7 +36,7 @@ pf -v ## Understand what's a flow -A flow, represented as a YAML file, is a DAG of functions, which connected via input/output dependencies, and executed based on the topology by Prompt flow executor. See [Flows](../../concepts/concept-flows.md) for more details. +A flow, represented as a YAML file, is a DAG of functions, which is connected via input/output dependencies, and executed based on the topology by Prompt flow executor. See [Flows](../../concepts/concept-flows.md) for more details. ### Get the flow sample From 1a537ffce21c5e66a3bda5bc56b03a19158b8ac5 Mon Sep 17 00:00:00 2001 From: minggu Date: Sun, 22 Oct 2023 21:45:32 +0800 Subject: [PATCH 3/5] Fix syntax error --- docs/how-to-guides/init-and-test-a-flow.md | 2 +- docs/how-to-guides/quick-start.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/how-to-guides/init-and-test-a-flow.md b/docs/how-to-guides/init-and-test-a-flow.md index 4afaeff38d5..077632d2f94 100644 --- a/docs/how-to-guides/init-and-test-a-flow.md +++ b/docs/how-to-guides/init-and-test-a-flow.md @@ -47,7 +47,7 @@ Alternatively, you can use the "Create new flow" action on the Prompt flow pane Structure of flow folder: - **flow.dag.yaml**: The flow definition with inputs/outputs, nodes, tools and variants for authoring purpose. - **.promptflow/flow.tools.json**: It contains all package tools meta that references in `flow.dag.yaml`. -- **Source code files (.py, .jinja2)**: User managed, the code scripts that references by tools. +- **Source code files (.py, .jinja2)**: User managed, the code scripts referenced by tools. - **requirements.txt**: Python package dependencies for this flow. ![init_flow_folder](../media/how-to-guides/init-and-test-a-flow/flow_folder.png) diff --git a/docs/how-to-guides/quick-start.md b/docs/how-to-guides/quick-start.md index e128418ac0a..ed693e9129c 100644 --- a/docs/how-to-guides/quick-start.md +++ b/docs/how-to-guides/quick-start.md @@ -56,7 +56,7 @@ cd promptflow/examples/flows/standard/web-classification A flow directory is a directory that contains all contents of a flow. Structure of flow folder: - **flow.dag.yaml**: The flow definition with inputs/outputs, nodes, tools and variants for authoring purpose. - **.promptflow/flow.tools.json**: It contains all package tools meta that references in `flow.dag.yaml`. -- **Source code files (.py, .jinja2)**: User managed, the code scripts that references by tools. +- **Source code files (.py, .jinja2)**: User managed, the code scripts referenced by tools. - **requirements.txt**: Python package dependencies for this flow. From e2541f2331389160949119c337ebb0622cbfbd67 Mon Sep 17 00:00:00 2001 From: minggu Date: Sun, 22 Oct 2023 21:47:07 +0800 Subject: [PATCH 4/5] Fix syntax error --- docs/how-to-guides/init-and-test-a-flow.md | 2 +- docs/how-to-guides/quick-start.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/how-to-guides/init-and-test-a-flow.md b/docs/how-to-guides/init-and-test-a-flow.md index 077632d2f94..5a01c352cce 100644 --- a/docs/how-to-guides/init-and-test-a-flow.md +++ b/docs/how-to-guides/init-and-test-a-flow.md @@ -46,7 +46,7 @@ Alternatively, you can use the "Create new flow" action on the Prompt flow pane Structure of flow folder: - **flow.dag.yaml**: The flow definition with inputs/outputs, nodes, tools and variants for authoring purpose. -- **.promptflow/flow.tools.json**: It contains all package tools meta that references in `flow.dag.yaml`. +- **.promptflow/flow.tools.json**: It contains tools meta referenced in `flow.dag.yaml`. - **Source code files (.py, .jinja2)**: User managed, the code scripts referenced by tools. - **requirements.txt**: Python package dependencies for this flow. diff --git a/docs/how-to-guides/quick-start.md b/docs/how-to-guides/quick-start.md index ed693e9129c..0f296729290 100644 --- a/docs/how-to-guides/quick-start.md +++ b/docs/how-to-guides/quick-start.md @@ -55,7 +55,7 @@ cd promptflow/examples/flows/standard/web-classification A flow directory is a directory that contains all contents of a flow. Structure of flow folder: - **flow.dag.yaml**: The flow definition with inputs/outputs, nodes, tools and variants for authoring purpose. -- **.promptflow/flow.tools.json**: It contains all package tools meta that references in `flow.dag.yaml`. +- **.promptflow/flow.tools.json**: It contains tools meta referenced in `flow.dag.yaml`. - **Source code files (.py, .jinja2)**: User managed, the code scripts referenced by tools. - **requirements.txt**: Python package dependencies for this flow. From 9dce5b55b6d00cba012d5ae5f4b117c2eb092973 Mon Sep 17 00:00:00 2001 From: minggu Date: Sun, 22 Oct 2023 21:50:44 +0800 Subject: [PATCH 5/5] Fix syntax error --- docs/how-to-guides/quick-start.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to-guides/quick-start.md b/docs/how-to-guides/quick-start.md index 0f296729290..311edacb017 100644 --- a/docs/how-to-guides/quick-start.md +++ b/docs/how-to-guides/quick-start.md @@ -69,7 +69,7 @@ pip install -r requirements.txt ``` ### Understand the flow yaml -The entry file of a flow directory is [`flow.dag.yaml`](https://github.com/microsoft/promptflow/blob/main/examples/flows/standard/web-classification/flow.dag.yaml) which describes the `DAG(Directed Acyclic Graph)` of a flow. The flow dag of this sample likes below: +The entry file of a flow directory is [`flow.dag.yaml`](https://github.com/microsoft/promptflow/blob/main/examples/flows/standard/web-classification/flow.dag.yaml) which describes the `DAG(Directed Acyclic Graph)` of a flow. Below is a sample of flow DAG: ![flow_dag](../media/how-to-guides/quick-start/flow_dag.png)