-
Notifications
You must be signed in to change notification settings - Fork 1.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve CLI speed with lazy imports #1319
Open
jgbradley1
wants to merge
70
commits into
main
Choose a base branch
from
joshbradley/import-speedup
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This is an optional PR to consider. Because of too many imports getting executed in various
__init__.py
files throughout the library, the CLI is slow to start up. The initialization of so many imports also makes the initial import of graphrag slow as well.Proposed Changes
Following some tips from this article, I profiled the startup time for the entire library with a focus on improving the CLI startup time. Some import statements involving very large libraries or long-processing times have been moved inside the function calls that rely on them.
Across the entire library, nearly all
__init__.py
files are empty now.The following screenshot shows the startup time for the CLI code when the package is first installed.
After the library has been loaded once (python generates bytecode to speed up future imports), we can achieve an even faster load time of 0.3 seconds.
Tab completion with the CLI is also now very responsive.
Checklist
Additional Notes
This PR closes #1299 as well. Additional comments were added in places where import statements may appear unusual at first explaining why they have been moved there.
A small patch for Typer path completion was added to the CLI to improve the CLI experience.