Improve and update documentation #1207
Open
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
Contributor
Author
README.md
Outdated
| ### Auto detection of the instruction set extension to be used | ||
|
|
||
| The same computation operating on vectors and using the most performant instruction set available: | ||
| The same computation operating on vectors and using the most performant instruction set available at compile time, absed on the provided compiler flags (e.g. ``-mavx2`` for GCC and Clang to target AVX2): |
Contributor
There was a problem hiding this comment.
we could add a reference to this and maybe suggest the arch levels to the user?
Contributor
There was a problem hiding this comment.
I provide an example here: https://github.com/DiamonDinoia/random
Update supported architecture and make various usage scenario more explicit. Fix #1202
serge-sans-paille
force-pushed
the
bug/1202
branch
from
372af5c to
19a6d45
Compare
Contributor
Author
|
we could add a reference to [2]this and maybe suggest the arch levels to the
user?
I'm not sure about that: we're ine README, and I assume people should know stuff
about SIMD when using xsimd. One thing we could do is point at an academic
lesson on SIMD (in addition to the wikipedia page I've already added).
|
Contributor
I agree, maybe in the dynamic dispatch page we can mention this. |
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.
Update supported architecture and make various usage scenario more explicit.
Fix #1202