From 244ce760586dfb0f66c48c7d98cb87a0812e26cb Mon Sep 17 00:00:00 2001 From: maxime Date: Wed, 27 Nov 2024 21:20:40 -0500 Subject: [PATCH] improve doc --- crates/cubecl-core/src/frontend/container/tensor/base.rs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/crates/cubecl-core/src/frontend/container/tensor/base.rs b/crates/cubecl-core/src/frontend/container/tensor/base.rs index 32b86ac4..1417b13e 100644 --- a/crates/cubecl-core/src/frontend/container/tensor/base.rs +++ b/crates/cubecl-core/src/frontend/container/tensor/base.rs @@ -34,7 +34,10 @@ mod metadata { unexpanded!() } - /// Obtain the coordinate corresponding to the given `index` of input at dimension `dim`. + /// Obtain the coordinate corresponding to the given `index` of the tensor at dimension `dim`. + /// + /// A coordinate is a list of indices corresponding to the multi-dimensional position of an element in the tensor. + /// The `dim` element in a coordinate is the position along the `dim` dimension of the tensor. pub fn coordinate(&self, _index: I, _dim: D) -> u32 { unexpanded!() }