From 02de526a2268946ea8d292b57f7ef576a752be97 Mon Sep 17 00:00:00 2001 From: Yao <46446115+16oeahr@users.noreply.github.com> Date: Wed, 6 Sep 2023 17:13:17 +0800 Subject: [PATCH 1/2] fix script path and remove useless file --- .../how-to-create-and-use-your-own-tool-package.md | 4 ++-- .../my_tool_package/yamls/output.yaml | 12 ------------ 2 files changed, 2 insertions(+), 14 deletions(-) delete mode 100644 examples/tools/tool-package-quickstart/my_tool_package/yamls/output.yaml diff --git a/docs/how-to-guides/how-to-create-and-use-your-own-tool-package.md b/docs/how-to-guides/how-to-create-and-use-your-own-tool-package.md index bd2d25f81ae..a6c714dbf0c 100644 --- a/docs/how-to-guides/how-to-create-and-use-your-own-tool-package.md +++ b/docs/how-to-guides/how-to-create-and-use-your-own-tool-package.md @@ -64,11 +64,11 @@ hello-world-proj/ > [!Note] If you create a new tool, don't forget to also create the corresponding tool YAML. You can run below command under your tool project to auto generate your tool YAML. You may want to specify `-n` for `name` and `-d` for `description`, which would be displayed as the tool name and tooltip in prompt flow UI. ``` - python ..\scripts\tool\generate_package_tool_meta.py -m -o -n -d + python -m -o -n -d ``` For example: ``` - python ..\scripts\tool\generate_package_tool_meta.py -m hello_world.tools.hello_world_tool -o hello_world\yamls\hello_world_tool.yaml -n "Hello World Tool" -d "This is my hello world tool." + python D:\proj\github\promptflow\scripts\tool\generate_package_tool_meta.py -m hello_world.tools.hello_world_tool -o hello_world\yamls\hello_world_tool.yaml -n "Hello World Tool" -d "This is my hello world tool." ``` To populate your tool module, adhere to the pattern \.tools.\, which represents the folder path to your tool within the package. 6. **tests**: This directory contains all your tests, though they are not required for creating your custom tool package. When adding a new tool, you can also create corresponding tests and place them in this directory. Run below command under your tool project: diff --git a/examples/tools/tool-package-quickstart/my_tool_package/yamls/output.yaml b/examples/tools/tool-package-quickstart/my_tool_package/yamls/output.yaml deleted file mode 100644 index ad625c8d669..00000000000 --- a/examples/tools/tool-package-quickstart/my_tool_package/yamls/output.yaml +++ /dev/null @@ -1,12 +0,0 @@ -my_tool_package.tools.my_tool_1.my_tool: - function: my_tool - inputs: - connection: - type: - - CustomConnection - input_text: - type: - - string - module: my_tool_package.tools.my_tool_1 - name: my_tool - type: python From b4f241719ad950dddbb274c1398cbad0b35bc694 Mon Sep 17 00:00:00 2001 From: Yao <46446115+16oeahr@users.noreply.github.com> Date: Thu, 7 Sep 2023 19:59:21 +0800 Subject: [PATCH 2/2] fix comment --- .../how-to-create-and-use-your-own-tool-package.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/how-to-guides/how-to-create-and-use-your-own-tool-package.md b/docs/how-to-guides/how-to-create-and-use-your-own-tool-package.md index a6c714dbf0c..5e36d3057f3 100644 --- a/docs/how-to-guides/how-to-create-and-use-your-own-tool-package.md +++ b/docs/how-to-guides/how-to-create-and-use-your-own-tool-package.md @@ -21,11 +21,11 @@ git clone https://github.com/microsoft/promptflow.git ### Create custom tool package Run below command under root folder to create your tool project quickly: ``` -python scripts\tool\generate_tool_package_template.py --destination --package-name --tool-name --function-name +python \tool\generate_tool_package_template.py --destination --package-name --tool-name --function-name ``` For example: ``` -python scripts\tool\generate_tool_package_template.py --destination hello-world-proj --package-name hello-world --tool-name hello_world_tool --function-name get_greeting_message +python D:\proj\github\promptflow\scripts\tool\generate_tool_package_template.py --destination hello-world-proj --package-name hello-world --tool-name hello_world_tool --function-name get_greeting_message ``` This auto-generated script will create one tool for you. The parameters _destination_ and _package-name_ are mandatory. The parameters _tool-name_ and _function-name_ are optional. If left unfilled, the _tool-name_ will default to _hello_world_tool_, and the _function-name_ will default to _tool-name_. @@ -64,7 +64,7 @@ hello-world-proj/ > [!Note] If you create a new tool, don't forget to also create the corresponding tool YAML. You can run below command under your tool project to auto generate your tool YAML. You may want to specify `-n` for `name` and `-d` for `description`, which would be displayed as the tool name and tooltip in prompt flow UI. ``` - python -m -o -n -d + python \tool\generate_package_tool_meta.py -m -o -n -d ``` For example: ```