huggingface / huggingface/candle

Misleading `Tensor::matmul` documentation

Open
#2,228 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
21k
Forks
1.8k
Avg merge
16h 42m
Merged PRs (30d)
25

Description

First off, great job on this project!

I noticed that Gemm (at least for cuda from what I've seen) is not supported for tensors with dims > 4, however, the docs here seem to describe a tensor with arbitrary dimensions https://docs.rs/candle-core/latest/candle_core/struct.Tensor.html#method.matmul. It would be helpful to document this limitation.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the Tensor::matmul API documentation at the linked docs.rs entry and locate its corresponding Rust documentation source. Document that the CUDA Gemm implementation does not support tensors with dimensions greater than four, then verify that the generated API documentation states the limitation accurately.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.