diff --git a/docs/how-to-guides/develop-a-tool/create-and-use-tool-package.md b/docs/how-to-guides/develop-a-tool/create-and-use-tool-package.md index 9dadf954bc10..3778a5d6a52e 100644 --- a/docs/how-to-guides/develop-a-tool/create-and-use-tool-package.md +++ b/docs/how-to-guides/develop-a-tool/create-and-use-tool-package.md @@ -165,4 +165,4 @@ Alternatively, you can test your tool package using the script below to ensure t [Customize your tool icon](add-a-tool-icon.md) [Add category and tags for tool](add-category-and-tags-for-tool.md) [Use file path as tool input](use-file-path-as-tool-input.md) -[Create Custom LLM Tool](create-custom-llm-tool.md) +[Customize a LLM Tool](customize_a_llm_tool.md) diff --git a/docs/how-to-guides/develop-a-tool/create-custom-llm-tool.md b/docs/how-to-guides/develop-a-tool/customize_a_llm_tool.md similarity index 87% rename from docs/how-to-guides/develop-a-tool/create-custom-llm-tool.md rename to docs/how-to-guides/develop-a-tool/customize_a_llm_tool.md index 59d10197186a..4a62e349baa7 100644 --- a/docs/how-to-guides/develop-a-tool/create-custom-llm-tool.md +++ b/docs/how-to-guides/develop-a-tool/customize_a_llm_tool.md @@ -1,7 +1,5 @@ -# Create Custom LLM Tool -In this document, we will guide you through the process of developing a tool with `custom_llm` type which can connect to a customized large language model with prompt. - -A Custom LLM is a large language model fine-tuned by yourself. If you find it has good performance and is useful, then you can follow this guidance to make it a tool so that it can be shared with others to increase its impact. +# Customize a LLM Tool +In this document, we will guide you through the process of developing a custom LLM tool which enables users to connect to a large language model with prompt tuning experience using a prompt template. ## Prerequisites - Please ensure that your [Prompt flow for VS Code](https://marketplace.visualstudio.com/items?itemName=prompt-flow.prompt-flow) is updated to version 1.2.0 or later. @@ -10,8 +8,8 @@ A Custom LLM is a large language model fine-tuned by yourself. If you find it ha Here we use [an existing tool package](https://github.com/microsoft/promptflow/tree/main/examples/tools/tool-package-quickstart/my_tool_package) as an example. If you want to create your own tool, please refer to [create and use tool package](create-and-use-tool-package.md). 1. Develop the tool code as in [this example](https://github.com/microsoft/promptflow/blob/main/examples/tools/tool-package-quickstart/my_tool_package/tools/tool_with_custom_llm_type.py). -- Add a `CustomConnection` input to the tool, which is used to authenticate and establish a connection to the customized large language model. -- Add a `PromptTemplate` input to the tool, which serves as an argument to be passed into the customized large language model. +- Add a `CustomConnection` input to the tool, which is used to authenticate and establish a connection to the large language model. +- Add a `PromptTemplate` input to the tool, which serves as an argument to be passed into the large language model. ```python from jinja2 import Template diff --git a/docs/how-to-guides/develop-a-tool/index.md b/docs/how-to-guides/develop-a-tool/index.md index e8fd7f74a860..e2769f15d2a3 100644 --- a/docs/how-to-guides/develop-a-tool/index.md +++ b/docs/how-to-guides/develop-a-tool/index.md @@ -9,5 +9,5 @@ create-and-use-tool-package add-a-tool-icon add-category-and-tags-for-tool use-file-path-as-tool-input -create-custom-llm-tool +customize_a_llm_tool ``` \ No newline at end of file diff --git a/examples/README.md b/examples/README.md index 4832ddb18990..ba245f548aba 100644 --- a/examples/README.md +++ b/examples/README.md @@ -81,7 +81,7 @@ | [cascading-inputs-tool-showcase](tools/use-cases/cascading-inputs-tool-showcase/README.md) | [![samples_tools_use_cases_cascading_inputs_tool_showcase](https://github.com/microsoft/promptflow/actions/workflows/samples_tools_use_cases_cascading_inputs_tool_showcase.yml/badge.svg?branch=main)](https://github.com/microsoft/promptflow/actions/workflows/samples_tools_use_cases_cascading_inputs_tool_showcase.yml) | This is a flow demonstrating the use of a tool with cascading inputs which frequently used in situations where the selection in one input field determines what subsequent inputs should be shown, and it helps in creating a more efficient, user-friendly, and error-free input process | | [custom-strong-type-connection-package-tool-showcase](tools/use-cases/custom-strong-type-connection-package-tool-showcase/README.md) | [![samples_tools_use_cases_custom_strong_type_connection_package_tool_showcase](https://github.com/microsoft/promptflow/actions/workflows/samples_tools_use_cases_custom_strong_type_connection_package_tool_showcase.yml/badge.svg?branch=main)](https://github.com/microsoft/promptflow/actions/workflows/samples_tools_use_cases_custom_strong_type_connection_package_tool_showcase.yml) | This is a flow demonstrating the use of a package tool with custom string type connection which provides a secure way to manage credentials for external APIs and data sources, and it offers an improved user-friendly and intellisense experience compared to custom connections | | [custom-strong-type-connection-script-tool-showcase](tools/use-cases/custom-strong-type-connection-script-tool-showcase/README.md) | [![samples_tools_use_cases_custom_strong_type_connection_script_tool_showcase](https://github.com/microsoft/promptflow/actions/workflows/samples_tools_use_cases_custom_strong_type_connection_script_tool_showcase.yml/badge.svg?branch=main)](https://github.com/microsoft/promptflow/actions/workflows/samples_tools_use_cases_custom_strong_type_connection_script_tool_showcase.yml) | This is a flow demonstrating the use of a script tool with custom string type connection which provides a secure way to manage credentials for external APIs and data sources, and it offers an improved user-friendly and intellisense experience compared to custom connections | -| [custom_llm_tool_showcase](tools/use-cases/custom_llm_tool_showcase/README.md) | [![samples_tools_use_cases_custom_llm_tool_showcase](https://github.com/microsoft/promptflow/actions/workflows/samples_tools_use_cases_custom_llm_tool_showcase.yml/badge.svg?branch=main)](https://github.com/microsoft/promptflow/actions/workflows/samples_tools_use_cases_custom_llm_tool_showcase.yml) | This is a flow demonstrating how to use a `custom_llm` tool, `custom_llm` tool allows users to connect to a customized large language model which is fine-tuned by tool developer | +| [custom_llm_tool_showcase](tools/use-cases/custom_llm_tool_showcase/README.md) | [![samples_tools_use_cases_custom_llm_tool_showcase](https://github.com/microsoft/promptflow/actions/workflows/samples_tools_use_cases_custom_llm_tool_showcase.yml/badge.svg?branch=main)](https://github.com/microsoft/promptflow/actions/workflows/samples_tools_use_cases_custom_llm_tool_showcase.yml) | This is a flow demonstrating how to use a `custom_llm` tool, which enables users to connect to a large language model with prompt tuning experience using a prompt template | ### Connections ([connections](connections)) diff --git a/examples/tools/use-cases/custom_llm_tool_showcase/README.md b/examples/tools/use-cases/custom_llm_tool_showcase/README.md index 2df05c4c3257..f6ddab6ff7d2 100644 --- a/examples/tools/use-cases/custom_llm_tool_showcase/README.md +++ b/examples/tools/use-cases/custom_llm_tool_showcase/README.md @@ -1,5 +1,5 @@ # Flow with custom_llm tool -This is a flow demonstrating how to use a `custom_llm` tool, `custom_llm` tool allows users to connect to a customized large language model which is fine-tuned by tool developer. +This is a flow demonstrating how to use a `custom_llm` tool, which enables users to connect to a large language model with prompt tuning experience using a prompt template. Tools used in this flow: - `custom_llm` Tool