Open LukeMathWalker opened 5 years ago
Going through all of these issues, I have starting to think at broader challenges which should probably fall under ndarray
's umbrella or are relevant to the project:
numpy.einsum
equivalent ndarray-*
crates into the rust-ndarray
organization, harmonizing interfaces and integrating docs where appropriate I've started taking a crack at einsum here. The implementation I have there has multiple issues (performance and otherwise) and is not at all ready for production, but is apparently correct. I'm actively working on improving the implementation. There's a web frontend that uses the crate as a WASM module deployed here.
The front-end is what I dreamed I could have when I started to use np.einsum
back in the days - quite cool @oracleofnj!
Parsing the output correctly is definitely the first step there - then it comes down to properly optimizing the computation path based on the inputs and the specified contractions. What is your attack plan @oracleofnj?
After reading through the implementations/documentation in numpy and opt_einsum, I'm writing the base cases to handle a single operand or a pair of operands and then I'll write a function that takes the general case along with a pre-specified path and iterates along the path using the base cases. Last will come an independent function (or functions) to optimize the path given the operand sizes.
I published a beta version of my crate to crates.io. It still has some issues but it's far enough along that you are welcome to give it a spin. There is a minimal example (and more in the tests/benches) at the crate repo where you should feel free to open any issues - we can move the discussion there.
Just came across some missing functionality that might want to be tracked here: https://github.com/rust-ndarray/ndarray/issues/865 Equivalent numpy feature: slicing on a variable number of indices
If you would like a slightly easier task than implementing all of NumPy, a fantastic start would be to follow the Python array API standard specification (the parts that are relevant to Rust!)
Purpose
The idea behind this collection is to provide an index to easily navigate all currently open ndarray's issues which are immediately actionable. This is meant to be a good starting point for new contributors (e.g. what should I work on?) and it can also help existing contributors to identify trends and hot areas. I have pinned it using GitHub's new feature, so that it doesn't get lost (and stale).
Given that we have ~100 open issues (and more are opened every day), you are very welcome contributing to this taxonomy effort either commenting on this issue or editing it directly (if you have permissions to do so). I am only adding to this tracker things I can easily understand/where enough context is provided in the issue - if I left something along the way, feel free to add it and to provide more info on it.
New functionality
Documentation
ndarray
's types in a public API (Similar toVec<T>
vs&[T]
considerations)Feature parity
np.kron
) (Issue: https://github.com/rust-ndarray/ndarray/issues/652)(Ongoing PR: #690)Interop / Finer-grained control
shrink_to_fit
method (Issue: https://github.com/rust-ndarray/ndarray/issues/427)Ergonomics
multislice_axis!
macro (Issue: https://github.com/rust-ndarray/ndarray/issues/593)ArrawView
as custom Dynamically Sized Type (Issue: https://github.com/rust-ndarray/ndarray/issues/538)#[track_caller]
to improve panic info #972Quality of life
Arbitrary
trait forArray
(Issue: https://github.com/rust-ndarray/ndarray/issues/596)ArcArray1
andArcArray2
(Issue: https://github.com/rust-ndarray/ndarray/issues/661)rustfmt
on the project and add it to the CI pipeline (PR: https://github.com/rust-ndarray/ndarray/pull/608)~clippy
on the project and take care of the linter warnings (PR: https://github.com/rust-ndarray/ndarray/pull/642)~Other
Clone
elements instack
andselect
(Issue: #269)Improvements
Documentation
ndarray-examples
Axis
NewType pattern rationale (Issue: https://github.com/rust-ndarray/ndarray/issues/564)astype
(Issues: https://github.com/rust-ndarray/ndarray/issues/493 , https://github.com/rust-ndarray/ndarray/issues/525)Zip
/azip
with failing examples (Issue: https://github.com/rust-ndarray/ndarray/issues/453)Error messages / Debugging
Debug
for arrays (Issue: https://github.com/rust-ndarray/ndarray/issues/398, PR: https://github.com/rust-ndarray/ndarray/pull/606)~Sharp API edges/corner cases
map_axis
/map_axis_mut
(Issue: https://github.com/rust-ndarray/ndarray/issues/579)~Core
ArrayBase.ptr
toNonNull
type (Issue: https://github.com/rust-ndarray/ndarray/issues/434)(Ongoing PR: #683)~Performance
sum_3_azip
(Issue: https://github.com/rust-ndarray/ndarray/issues/561)