Skip to content

Commit

Permalink
Update slice documentation (tracel-ai#2024)
Browse files Browse the repository at this point in the history
  • Loading branch information
antimora authored Jul 16, 2024
1 parent 1ed62f3 commit ed8a91d
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion crates/burn-tensor/src/tensor/api/base.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit ed8a91d

Please sign in to comment.