feat: tool meta generation perf optimization #1250

elliotzh · 2023-11-23T12:19:48Z

This pull request includes various changes to improve the functionality and structure of the codebase. The most important changes include adding a new test method to test the behavior of a specific method, updating a method to use a new type and adding a new parameter, and adding a new Python file with a function for parsing JSON.

Perf change:

e2e time for pfutil command: ~10.10s => 5.74s (cut for 44%)
Measure-Command { C:\Users\yangtongxu\AppData\Local\miniconda3\envs\py39_promptflow\python.exe c:\Users\yangtongxu.vscode\extensions\prompt-flow.prompt-flow-1.5.0\pfutil\pfutil.py tool -f hello.py -wd c:\Users\yangtongxu\code\promptflow\examples\flows\standard\basic-with-connection -o c:\Users\yangtongxu\code\promptflow\examples\flows\standard\basic-with-connection.promptflow\flow.tools.json }

Main code changes:

src/promptflow/promptflow/_sdk/_utils.py: Various changes to the _utils.py file, including adding a new function, updating import statements, improving print statements, removing unused imports, and adding new parameters to existing functions. [1] [2] [3] [4] [5] [6] [7]
src/promptflow/promptflow/_sdk/operations/_flow_operations.py: Updating the _generate_tools_meta method to use the ProtectedFlow type, adding a new parameter timeout to the method, updating import statements, renaming and specifying the type of the flow parameter in the validate function, and adding a new decorator and default parameter to the _generate_tools_meta function. [1] [2] [3] [4] [5] [6]

Testing improvements:

src/promptflow/tests/sdk_cli_test/e2etests/test_flow_local_operations.py: Added a new test method test_flow_generate_tools_meta_timeout to test the behavior of the _generate_tools_meta method when a timeout occurs.

Configuration changes:

src/promptflow/tests/test_configs/flows/web_classification_invalid/flow.dag.yaml: Removed the line - ../external_files/convert_to_dict.py from the additional_includes section in web_classification_invalid/flow.dag.yaml.

New file addition:

src/promptflow/tests/test_configs/flows/web_classification_invalid/convert_to_dict.py: Added a new Python file convert_to_dict.py in the web_classification_invalid directory, which contains a function convert_to_dict that parses a string as JSON and returns the parsed JSON object or a default dictionary if parsing fails.# Description

Please add an informative description that covers that changes made by the pull request and link all relevant issues.

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.
Create an issue and link to the pull request to get dedicated review from promptflow team. Learn more: 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.

Testing Guidelines

Pull request includes test coverage for the included changes.

github-actions · 2023-11-23T12:23:08Z