dnrops
/
burn
mirror of https://github.com/tracel-ai/burn.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update slice documentation (#2024)

This commit is contained in:
Dilshod Tadjibaev 2024-07-16 11:59:02 -05:00 committed by GitHub
parent 1ed62f36f8
commit ed8a91d48a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
crates/burn-tensor/src/tensor/api/base.rs
View File

@ -589,13 +589,14 @@ where
/// # Behavior
///
/// - Supports partial and full slicing in any number of dimensions.
/// - Missing ranges are treated as full slices if D > D2.
/// - Handles negative indices by wrapping around from the end of the dimension.
/// - Clamps ranges to the tensor's dimensions if they exceed the bounds.
/// - For `Option<(i64, i64)>` ranges, `None` selects the full range of that dimension.
///
/// # Panics
///
/// - If the number of ranges provided doesn't match the tensor's dimensions.
/// - If the number of ranges provided exceeds the tensor's dimensions.
/// - If a range is descending (e.g., 2..1) or empty (e.g., 1..1).
///
/// # Examples