Improve sentence in the Performance Tips section #36097
Closed
Conversation
This file contains hidden or 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
This commit improves an ambiguous sentence in the [Performance Tips](https://docs.julialang.org/en/v1/manual/performance-tips/) page. In the section [Access arrays in memory order, along columns](https://docs.julialang.org/en/v1/manual/performance-tips/#More-dots:-Fuse-vectorized-operations-1), there is the final sentence > (Of course, if you just do `f.(x)` then it is as fast as `fdot(x)` in this example, but in many contexts it is more convenient to just sprinkle some dots in your expressions rather than defining a separate function for each vectorized operation.) This is a bit confusing. What we want to say is that - using the dot notation is faster in the given example, but in general it will not be the case, - even though in general the dot notation is not the most performant approach, in several contexts it is more convenient.
This commit improves an ambiguous sentence in the [Performance Tips](https://docs.julialang.org/en/v1/manual/performance-tips/) page. In the section [Access arrays in memory order, along columns](https://docs.julialang.org/en/v1/manual/performance-tips/#More-dots:-Fuse-vectorized-operations-1), there is the final sentence > (Of course, if you just do `f.(x)` then it is as fast as `fdot(x)` in this example, but in many contexts it is more convenient to just sprinkle some dots in your expressions rather than defining a separate function for each vectorized operation.) This is a bit confusing. What we want to say is that - using the dot notation is faster in the given example, but in general it will not be the case, - even though in general the dot notation is not the most performant approach, in several contexts it is more convenient.
Fixed by running git rebase --whitespace=fix HEAD~1 and then merging.
Keno
reviewed
Jun 3, 2020
| some dots in your expressions rather than defining a separate function | ||
| for each vectorized operation.) | ||
| a new temporary array and executes in a separate loop. | ||
| Note also that, while `f.(x)` is as fast as `fdot(x)` in the above example, in general defining a separate function will lead to improved performance. Nevertheless, in many contexts it is more convenient to just sprinkle some dots in your expressions rather than defining a separate function for each vectorized operation. |
Member
There was a problem hiding this comment.
in general defining a separate function will lead to improved performance.
This seems to change the meaning of what was intended here.
Member
This is definitely not how we want to frame this. In general, it should be the same speed or faster — especially as it is then able to fuse with surrounding expressions. If you have specific examples where that's not the case, please file bugs. |
Contributor
Author
|
Thanks for the feedback. I get that my rewriting of the sentence doesn't go in the right direction. It is still unclear to me, though, how the original sentence serves the intended message. I guess that I should ask in the forum for clarifications regarding my confusion. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
This commit improves an ambiguous sentence in the Performance Tips page.
In the section Access arrays in memory order, along columns, there is the final sentence
This is a bit confusing. What we want to say is that