jeertmans / differt Goto Github PK

Currently, we do not provide a minimum Rust supported version. We should provide such a version and add CI tests to check that it can compile with that version.

E.g., DiGraph.all_paths(from_=0, ...) does not work as the text signature (from_) differs from the true signature (from). This is an issue because from cannot be used in Python.

Possible solutions:

• Create a wrapper in Python that maps keyword-arguments to positional arguments.
• Make from_ and others explicitly positional-only parameters.
• Rename from to from_ inside Rust code (at least in the function signatures).

This feature suggestion is highly inspired from maciejhirsz/logos#374, from a repository I maintain.

Actually, the idea would be to follow what pydantic-core does, see https://github.com/pydantic/pydantic-core/blob/44621f1dee5160c737a0749d21e0b2118fa99705/.github/workflows/ci.yml#L464-L557, to generate more performant code.

The setup for DiffeRT should be as follows:

1. Install the necessary LLVM tools:

rustup component add llvm-tools-preview

2. Compile code so that it can generate profiles:

RUSTFLAGS='-Cprofile-generate=/tmp/pgo-data/profdata' maturin build --release --out pgo-wheel

3. Install the library from new wheels:

pdm run python -m pip install differt --no-index --no-deps --find-links pgo-wheel --force-reinstall

4. Actually generate profiles by running code that uses wheels:

pdm run pytest --benchmark-only tests

5. Merge profiles. The actual path to llvm-profdata may change, see https://doc.rust-lang.org/rustc/profile-guided-optimization.html.

~/.rustup/toolchains/stable-x86_64-unknown-linux-gnu/lib/rustlib/x86_64-unknown-linux-gnu/bin/llvm-profdata merge -o /tmp/pgo-data/merged.profdata /tmp/pgo-data/profdata

6. Generate optimized build:

RUSTFLAGS='-Cprofile-use=/tmp/pgo-data/merged.profdata' maturin build --release --out dist

The only question I have is whether this is actually useful (did run a benchmark after, but not improvement noticed). I might need to write better benchmarks (that target actually what I want to optimize).