huggingface / huggingface/candle
Add doc for public tensor operation
Open
- Dominant language
- Rust
- Stars
- 21k
- Forks
- 1.8k
- Avg merge
- 16h 42m
- Merged PRs (30d)
- 25
Description
I noticed that lots public tensor operation miss related document, such as https://docs.rs/candle-core/latest/candle_core/struct.Tensor.html#method.scatter_set . It maybe worth to add example document fot them to clear semantics of each operation.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the linked Tensor::scatter_set documentation on docs.rs and inspect the public tensor operations around it. Identify which operations lack examples and add documentation that clarifies their semantics; done means the selected public operations have useful examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation, machine-learning
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100