[Minor] Improve arrow and parquet READMEs, document parquet feature flags #2324
Conversation
github-actions
bot
added
arrow
| - `chrono-tz` - support of parsing timezone using [chrono-tz](https://docs.rs/chrono-tz/0.6.0/chrono_tz/) | ||
| - `ffi` - bindings for the Arrow C [C Data Interface](https://arrow.apache.org/docs/format/CDataInterface.html) |
There was a problem hiding this comment.
newly added feature flags
| @@ -18,41 +18,8 @@ | |||
| //! A complete, safe, native Rust implementation of [Apache Arrow](https://arrow.apache.org), a cross-language | |||
| //! development platform for in-memory data. | |||
| //! | |||
| //! # Performance Tips | |||
| @@ -33,16 +33,16 @@ We use the term "kernel" to refer to particular general operation that contains | |||
|
|
|||
| Types of functions | |||
|
|
|||
| * Scalar functions: elementwise functions that perform scalar operations in a | |||
| - Scalar functions: elementwise functions that perform scalar operations in a | |||
There was a problem hiding this comment.
the prettier tool did this
|
|
||
| ## Performance | ||
| Arrow aims to be as fast as possible out of the box, whilst not compromising on safety. However, |
There was a problem hiding this comment.
This content was moved from what was added in #2305
|
|
||
| The `parquet` crate provides the following features which may be enabled in your `Cargo.toml`: | ||
|
|
||
| - `arrow` (default) - support for reading / writing [`arrow`](https://crates.io/crates/arrow) arrays to / from parquet |
There was a problem hiding this comment.
here are the parquet feature flags I could find
Codecov Report
@@ Coverage Diff @@
## master #2324 +/- ##
==========================================
- Coverage 80.53% 80.53% -0.01%
==========================================
Files 248 248
Lines 59971 59971
==========================================
- Hits 48296 48295 -1
- Misses 11675 11676 +1
📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more |
| @@ -55,25 +64,25 @@ Arrow seeks to uphold the Rust Soundness Pledge as articulated eloquently [here] | |||
|
|
|||
| Where soundness in turn is defined as: | |||
|
|
|||
| > Code is unable to trigger undefined behaviour using safe APIs | |||
| > Code is unable to trigger undefined behavior using safe APIs | |||
There was a problem hiding this comment.
... I shall British-ify the spelling one comment at a time 😂
There was a problem hiding this comment.
lol I am "correcting" the spelling (or maybe I can claim I am "standardizing" the spelling 😆
| Most of the compute kernels benefit a lot from being optimized for a specific CPU target. | ||
| This is especially so on x86-64 since without specifying a target the compiler can only assume support for SSE2 vector instructions. | ||
| One of the following values as `-Ctarget-cpu=value` in `RUSTFLAGS` can therefore improve performance significantly: | ||
| To address this it is recommended that you specify the override the LLVM defaults either |
There was a problem hiding this comment.
Oops this keeps a typo from my PR, "specify the override the". Will fix
|
Benchmark runs are scheduled for baseline = 297a8fa and contender = 8e30d06. 8e30d06 is a master commit associated with this PR. Results will be available as each benchmark for each run completes. |
Which issue does this PR close?
Noticed while I was working on #2172
Rationale for this change
The parquet crate has a non trivial number of feature flags. Let's consistently document the flags in crates.io and link to them in docs.rs
https://crates.io/crates/arrow
https://crates.io/crates/parquet
Also while I was messing around I found some other places where the docs could be improved so I did.
What changes are included in this PR?
Are there any user-facing changes?
readme is different