Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Are we ndarray yet? #597

Open
14 of 31 tasks
LukeMathWalker opened this issue Mar 17, 2019 · 7 comments
Open
14 of 31 tasks

Are we ndarray yet? #597

LukeMathWalker opened this issue Mar 17, 2019 · 7 comments
Labels
good first issue A good issue to start contributing to ndarray! help wanted

Comments

@LukeMathWalker
Copy link
Member

LukeMathWalker commented Mar 17, 2019

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

  • Guidelines on how to use ndarray's types in a public API (Similar to Vec<T> vs &[T] considerations)

Feature parity

Interop / Finer-grained control

Ergonomics

Quality of life

Other

Improvements

Documentation

Error messages / Debugging

Sharp API edges/corner cases

Core

Performance

@LukeMathWalker
Copy link
Member Author

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:

  • masked arrays
  • zero-cost interop with other scientific stacks using the Apache Arrow project
  • numpy.einsum equivalent
  • consolidating all currently maintained and mature ndarray-* crates into the rust-ndarray organization, harmonizing interfaces and integrating docs where appropriate

@oracleofnj
Copy link

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.

@LukeMathWalker
Copy link
Member Author

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?

@oracleofnj
Copy link

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.

@oracleofnj
Copy link

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.

@TheButlah
Copy link

TheButlah commented Dec 19, 2020

Just came across some missing functionality that might want to be tracked here: #865
Equivalent numpy feature: slicing on a variable number of indices

@lucascolley
Copy link
Contributor

lucascolley commented Aug 11, 2024

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!)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue A good issue to start contributing to ndarray! help wanted
Projects
None yet
Development

No branches or pull requests

4 participants