Skip to content

Commit

Permalink
doc stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
mwlon committed Jul 11, 2023
1 parent eaf5d8a commit 601ad87
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 7 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,7 @@ with high compression ratio and moderately fast speed.
* chunked compression and streaming decompression

**Data types:**
`i32`, `i64`,
`u32`, `u64`,
`f32`, `f64`
`u32`, `u64`, `i32`, `i64`, `f32`, `f64`

It is also possible to implement your own data type via `NumberLike` and (if
necessary) `UnsignedLike` and `FloatLike`.
Expand All @@ -39,8 +37,8 @@ natively supported data types.

## Performance and Compression Ratio

See [benchmarks.md](./bench/benchmarks.md) or run the benchmark suite via
`cargo run --release --bin bench`.
See [benchmarks.md](./bench/README.md) to run the benchmark suite
or see its results.

## File Format

Expand Down
4 changes: 4 additions & 0 deletions bench/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,7 @@ You can see the compressed files in
Check `cargo run --release --bin bench -- --help` for information on how to
run other codecs, configure codecs differently, only run specific datasets,
etc.

## Results

Some simple results are in [benchmarks.md](./benchmarks.md).
2 changes: 1 addition & 1 deletion bench/benchmarks.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
All figured reported here are calculated using a single thread on a
All figures reported here are calculated using a single thread on a
2.8GHz i5 CPU, operating on in-memory data, using Rust 1.70.
Benchmarks were done by averaging 100 runs on a dataset of 1M numbers
with `compression_level` 8.
Expand Down
2 changes: 1 addition & 1 deletion images/file_format.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 601ad87

Please sign in to comment.