INCATools / INCATools/oakx-grape
provide docs on underlying methods
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
it's awesome we are now wrapping the underlying embiggen/ensmallen code:
https://github.com/INCATools/oakx-grape/blob/088f2d29d5a4f2a7a6b473ac871624831d779efa/src/oakx_grape/grape_implementation.py#L274
it would be great to see docs on underying rust objects, e.g
https://github.com/INCATools/oakx-grape/blob/088f2d29d5a4f2a7a6b473ac871624831d779efa/src/oakx_grape/grape_implementation.py#L286
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
Start by reading src/oakx_grape/grape_implementation.py at the referenced lines 274 and 286, then inspect how the underlying embiggen and ensmallen Rust objects are exposed. Determine where this project keeps API documentation and document the wrapped objects and methods shown there; done means users can understand those underlying Rust objects from the project docs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100