Skip to content
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.

Sign up for GitHub

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

add note about possible performance regressions #29

Merged
merged 3 commits into from
Aug 22, 2023
Merged

add note about possible performance regressions #29

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cd3a1a1
Add note about possible performance regressions
lmiq Aug 22, 2023
138e92e
Merge pull request #1 from lmiq/lmiq-precompilation-note
lmiq Aug 22, 2023
5e1dcff
note about performance regressions in <1.8
lmiq Aug 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ test data using functions that you don't need to precompile in your package.)
Finally, `PrecompileTools` includes `@recompile_invalidations` to mitigate the undesirable consequences of *invalidations*.
These different tools are demonstrated below.

!!! note
There have been cases where precompilation led to performance regressions in packages (see for example [[1](https://github.com/JuliaLang/julia/issues/50749),[2](https://github.com/JuliaLang/julia/pull/50766),[3](https://github.com/JuliaLang/julia/issues/35972)]). While fixes have been released, some problems persist in older Julia versions and new issues might also slow down runtime after precompilation. Hence, it's advised to test packages for performance regressions in all supported Julia versions when introducing precompilation directives.
lmiq marked this conversation as resolved.
Show resolved Hide resolved

## Tutorial: forcing precompilation with workloads

No matter whether you're a package developer or a user looking to make your own workloads start faster,
Expand Down