Make `general_mat_mul`/`general_mat_vec_mul` more discoverable
還沒有人認領這個 Issue。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 30/100
- Issue 類型
- 功能
- 描述清晰度
- 基本清楚
- 活躍度
- 停滯
- 技術堆疊
- rust
- 領域
- data, documentation
研究方向
Start with the linked general_mat_mul and general_mat_vec_mul documentation in the linalg module, then read the docs for the dot methods and Dot trait. Clarify whether the change should only improve documentation or also add the proposed GeneralDot trait and ArrayBase methods; done means the agreed functionality is discoverable and documented.
由索引模型根據 Issue 內容生成。
描述
The general_mat_mul and general_mat_vec_mul functions are not easy to find, since they're in the linalg module while most other functionality is available either at the top level of the crate or as methods on the array types.
At a minimum, we should mention them in the docs for the dot methods and Dot trait.
However, I think it would also be useful to expose the functionality as methods on ArrayBase. I'd suggest adding a trait like this:
/// General matrix multiplication.
pub trait GeneralDot<A, Rhs1, Rhs2> {
/// Perform general matrix-matrix multiplication, modifying `self` in-place.
///
/// Compute C ← α A B + β C, where `self` is C.
///
/// The array shapes must agree in the way that if `a` is *M* × *N*, then
/// `b` is *N* × *K* and `self` is *M* × *K*.
///
/// ***Panics*** if array shapes are not compatible<br>
/// *Note:* If enabled, uses blas `gemm` for elements of `f32, f64` when memory
/// layout allows. The default matrixmultiply backend is otherwise used for
/// `f32, f64` for all memory layouts.
fn mul_add_scaled_dot_inplace(
&mut self,
beta: A,
alpha: A,
a: &Rhs1,
b: &Rhs2,
);
}
and then add mul_add_scaled_dot_inplace methods which use this trait to ArrayBase<S, Ix1> and ArrayBase<S, Ix2>. What do you think?
- 主要語言
- Rust
- 星號
- 4.3k
- 分支
- 391
- PR 合併指標
- 30 天內沒有已合併 PR
貢獻指南
這個儲存庫沒有索引到貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
rust-ndarray/ndarray 的其他 Issue
-
難度 2/5 1-3 小時 新手友好度 72/100
rust-ndarray/ndarray#1612 · 1 則留言 ·
-
難度 4/5 3-5 天 新手友好度 48/100
rust-ndarray/ndarray#1617 · 1 則留言 ·
-
bug good first issue
難度 3/5 1-2 天 新手友好度 68/100
rust-ndarray/ndarray#1615 · 1 則留言 ·
-
難度 4/5 3-5 天 新手友好度 48/100
rust-ndarray/ndarray#1610 ·
-
難度 3/5 1-2 天 新手友好度 72/100
rust-ndarray/ndarray#1609 ·
查看 rust-ndarray/ndarray 的全部 Issue
相似的 Issue
-
bug
難度 1/5 1 小時以內 新手友好度 85/100
-
難度 2/5 1-3 小時 新手友好度 75/100
yantrikos/yantrik-os#255 ·
-
bug CLI custom-model
難度 2/5 1-3 小時 新手友好度 75/100
-
難度 2/5 1-3 小時 新手友好度 70/100
raphamorim/rio#1956 ·
-
難度 2/5 1-3 小時 新手友好度 75/100
rust-bitcoin/rust-bitcoin#6930 · 1 則留言 ·