Skip to content

Commit

Permalink
docs(rust): Update outdated performance section (#16409)
Browse files Browse the repository at this point in the history
  • Loading branch information
ritchie46 authored May 22, 2024
1 parent 46d7a40 commit ddaf393
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 107 deletions.
1 change: 0 additions & 1 deletion crates/polars/src/docs/mod.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
pub mod eager;
pub mod lazy;
pub mod performance;
101 changes: 0 additions & 101 deletions crates/polars/src/docs/performance.rs

This file was deleted.

14 changes: 9 additions & 5 deletions crates/polars/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -315,13 +315,17 @@
//! * `dtype-full` - all opt-in dtypes.
//! * `dtype-slim` - slim preset of opt-in dtypes.
//!
//! ## Performance and string data
//! Large string data can really slow down your queries.
//! Read more in the [performance section](crate::docs::performance)
//! ## Performance
//! To gains most performance out of Polars we recommend compiling on a nightly compiler
//! with the features `simd` and `performant` activated. The activated cpu features also influence
//! the amount of simd acceleration we can use.
//!
//! See this the features we activate for our python builds, or if you just run locally and want to
//! use all available features on your cpu, set `RUSTFLAGS='-C target-cpu=native'`.
//!
//! ### Custom allocator
//! A DataFrame library naturally does a lot of heap allocations. It is recommended to use a custom
//! allocator.
//! An OLAP query engine does a lot of heap allocations. It is recommended to use a custom
//! allocator, (we have found this to have up to ~25% runtime influence).
//! [JeMalloc](https://crates.io/crates/jemallocator) and
//! [Mimalloc](https://crates.io/crates/mimalloc) for instance, show a significant
//! performance gain in runtime as well as memory usage.
Expand Down

0 comments on commit ddaf393

Please sign in to comment.