Updated user-guide library docs with optimized config #976
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
|
@houqp @alamb @andygrove FYI took a first cut at this by adding to the library section of the user-guide. Let me know your thoughts. |
Dandandan
reviewed
Sep 7, 2021
docs/user-guide/src/library.md
Outdated
|
|
||
| ```toml | ||
| [dependencies] | ||
| datafusion = { git = "https://github.com/apache/arrow-datafusion.git", features = ["simd"]} |
There was a problem hiding this comment.
Suggested change
| datafusion = { git = "https://github.com/apache/arrow-datafusion.git", features = ["simd"]} | |
| datafusion = "5.0" |
There was a problem hiding this comment.
we dont need to keep the features = ["simd"]?
There was a problem hiding this comment.
Ah you're right 👍 But probably we don't want people building from git, if not needed.
Dandandan
reviewed
Sep 7, 2021
| snmalloc-rs = {version = "0.2", features= ["cache-friendly"]} | ||
| num_cpus = "1.0" | ||
|
|
||
| [profile.release] |
There was a problem hiding this comment.
Maybe mention that using this will increase the build time considerably
Dandandan
reviewed
Sep 7, 2021
docs/user-guide/src/library.md
Outdated
| static ALLOC: snmalloc_rs::SnMalloc = snmalloc_rs::SnMalloc; | ||
| ``` | ||
|
|
||
| Finally, in order to build with these optimizations `cargo nightly` is required. Based on the instruction |
There was a problem hiding this comment.
Nightly is only required for using simd
Dandandan
approved these changes
Sep 7, 2021
houqp
added
datafusion
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.
Which issue does this PR close?
Closes #882 .
Rationale for this change
What changes are included in this PR?
Are there any user-facing changes?