Documentation for shapes
Open
Nobody has claimed this yet.
documentation
good first issue
- Dominant language
- Rust
- Stars
- 8
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
Most of the data variables are of shape (n_outputs, n_samples), but it would be nice to figure out if this is the correct assumption in all functions or if the data is transposed somewhere.
Concretely, this could involve adding a comment on top of each function that has vectors/matrices involved, what is:
- the assumed shape
- the true shape
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files or tests are named. Start by locating functions that handle vector or matrix data and trace whether their inputs are transposed; document each function's assumed and actual shapes, then verify that the comments consistently describe the behavior across the relevant functions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100