diff --git a/README.md b/README.md index ccce04b..36b5498 100644 --- a/README.md +++ b/README.md @@ -10,13 +10,6 @@ License

-

- - - Solution quality vs. solve time across allocators - -

- OmniMalloc is a Python library for static memory allocation: given buffers with known sizes and lifetimes, assign offsets so that peak memory is minimized. This is the memory-planning step at the heart of ML compilers, embedded @@ -30,10 +23,18 @@ tools to develop and evaluate new allocation strategies. ## Installation +Install the latest release from PyPI: + ```bash pip install omnimalloc ``` +Or install the development version directly from GitHub: + +```bash +pip install git+https://github.com/fpedd/omnimalloc.git +``` + ## Usage ```python @@ -68,16 +69,12 @@ allocation sources, and benchmarking.

- - Packing efficiency per problem - - - - Solve time vs. problem size + + Solution quality vs. solve time across allocators

-Every figure on this page is generated from a deterministic benchmark run by +All figures on this page are generated from a deterministic benchmark run by [`scripts/generate_readme_assets.py`](scripts/generate_readme_assets.py). Run your own campaigns with the [benchmark harness](examples/05_benchmark.py).