Documentation

Returns a tensor with the same data and number of elements as the input tensor, but with the specified shape:

>>> g <- sMkGenerator (SDevice SCPU) 0
>>> (input, _) <- sRandn (TensorSpec (SGradient SWithGradient) (SLayout SDense) (SDevice SCPU) (SDataType SFloat) (SShape $ SName @"*" :&: SSize @4 :|: SNil)) g
>>> output <- sReshape (SShape $ SName @"*" :&: SSize @2 :|: SName @"*" :&: SSize @2 :|: SNil) input
>>> :type output
output
  :: Tensor
       ('Gradient 'WithGradient)
       ('Layout 'Dense)
       ('Device 'CPU)
       ('DataType 'Float)
       ('Shape '[ 'Dim ('Name "*") ('Size 2), 'Dim ('Name "*") ('Size 2)])

At the value level, a single dimension may be '-1', in which case it is inferred from the remaining dimensions and the number of elements in the input:

>>> output' <- sReshape (SShape $ SUncheckedName "*" :&: SUncheckedSize (-1) :|: SNil) output
>>> :type output'
output'
  :: Tensor
       ('Gradient 'WithGradient)
       ('Layout 'Dense)
       ('Device 'CPU)
       ('DataType 'Float)
       'UncheckedShape
>>> getDims output'
[Dim {dimName = "*", dimSize = 4}]

Returns a tensor with the same data and number of elements as the input tensor, but with the specified shape:

>>> g <- sMkGenerator (SDevice SCPU) 0
>>> (input, _) <- sRandn (TensorSpec (SGradient SWithGradient) (SLayout SDense) (SDevice SCPU) (SDataType SFloat) (SShape $ SName @"*" :&: SSize @4 :|: SNil)) g
>>> output <- sReshape (SShape $ SName @"*" :&: SSize @2 :|: SName @"*" :&: SSize @2 :|: SNil) input
>>> :type output
output
  :: Tensor
       ('Gradient 'WithGradient)
       ('Layout 'Dense)
       ('Device 'CPU)
       ('DataType 'Float)
       ('Shape '[ 'Dim ('Name "*") ('Size 2), 'Dim ('Name "*") ('Size 2)])

At the value level, a single dimension may be '-1', in which case it is inferred from the remaining dimensions and the number of elements in the input:

>>> output' <- sReshape (SShape $ SUncheckedName "*" :&: SUncheckedSize (-1) :|: SNil) output
>>> :type output'
output'
  :: Tensor
       ('Gradient 'WithGradient)
       ('Layout 'Dense)
       ('Device 'CPU)
       ('DataType 'Float)
       'UncheckedShape
>>> getDims output'
[Dim {dimName = "*", dimSize = 4}]

Compute transposed shapes.

>>> type SelectBatch = 'SelectDim ('ByName "batch" :: By Symbol Nat)
>>> type SelectFeature = 'SelectDim ('ByName "feature" :: By Symbol Nat)
>>> type Dims = '[ 'Dim ('Name "batch") ('Size 10), 'Dim ('Name "feature") ('Size 8), 'Dim ('Name "anotherFeature") ('Size 12)]
>>> :kind! TransposeF SelectBatch SelectFeature ('Shape Dims)
TransposeF SelectBatch SelectFeature ('Shape Dims) :: Shape
                                                        [Dim (Name Symbol) (Size Natural)]
= 'Shape
    '[ 'Dim ('Name "feature") ('Size 8),
       'Dim ('Name "batch") ('Size 10),
       'Dim ('Name "anotherFeature") ('Size 12)]
>>> :kind! TransposeF SelectFeature SelectBatch ('Shape Dims)
TransposeF SelectFeature SelectBatch ('Shape Dims) :: Shape
                                                        [Dim (Name Symbol) (Size Natural)]
= 'Shape
    '[ 'Dim ('Name "feature") ('Size 8),
       'Dim ('Name "batch") ('Size 10),
       'Dim ('Name "anotherFeature") ('Size 12)]

Returns a tensor that is a transposed version of input. The selected dimensions selectDim0 and selectDim1 are swapped.

>>> g <- sMkGenerator (SDevice SCPU) 0
>>> (input, _) <- sRandn (TensorSpec (SGradient SWithGradient) (SLayout SDense) (SDevice SCPU) (SDataType SFloat) (SShape $ SName @"batch" :&: SSize @10 :|: SName @"feature" :&: SSize @5 :|: SNil)) g
>>> output <- sTranspose (SSelectDim (SByName @"batch")) (SSelectDim (SByName @"feature")) input
>>> :type output
output
  :: Tensor
       ('Gradient 'WithGradient)
       ('Layout 'Dense)
       ('Device 'CPU)
       ('DataType 'Float)
       ('Shape
          '[ 'Dim ('Name "feature") ('Size 5),
             'Dim ('Name "batch") ('Size 10)])
>>> output <- sTranspose (SUncheckedSelectDim (ByIndex 0)) (SSelectDim (SByIndex @1)) input
>>> :type output
output
  :: Tensor
       ('Gradient 'WithGradient)
       ('Layout 'Dense)
       ('Device 'CPU)
       ('DataType 'Float)
       'UncheckedShape
>>> getDims output
[Dim {dimName = "feature", dimSize = 5},Dim {dimName = "batch", dimSize = 10}]

Unsqueezes a tensor with the specified dimension.

Unsqueezes a tensor with the specified dimension.

Calculate the output shape of a squeeze along a given dimension

>>> :kind! SqueezeDimF ('SelectDim ('ByIndex 1)) ('Shape '[ 'Dim ('Name "*") ('Size 2), 'Dim ('Name "*") ('Size 1), 'Dim ('Name "*") ('Size 2)])
...
= 'Shape '[ 'Dim ('Name "*") ('Size 2), 'Dim ('Name "*") ('Size 2)]

Squeeze a particular dimension.

>>> t <- sOnes $ TensorSpec (SGradient SWithoutGradient) (SLayout SDense) (SDevice SCPU) (SDataType SFloat) (SShape $ SNoName :&: SSize @2 :|: SNoName :&: SSize @1 :|: SNoName :&: SSize @2 :|: SNoName :&: SSize @1 :|: SNoName :&: SSize @2 :|: SNil)
>>> result <- sSqueezeDim (SSelectDim $ SByIndex @1) t
>>> :t result
result
  :: Tensor
       ('Gradient 'WithoutGradient)
       ('Layout 'Dense)
       ('Device 'CPU)
       ('DataType 'Float)
       ('Shape
          '[ 'Dim ('Name "*") ('Size 2), 'Dim ('Name "*") ('Size 2),
             'Dim ('Name "*") ('Size 1), 'Dim ('Name "*") ('Size 2)])
>>> result
Tensor Float [2,2,1,2] [[[[ 1.0000   ,  1.0000   ]],
                         [[ 1.0000   ,  1.0000   ]]],
                        [[[ 1.0000   ,  1.0000   ]],
                         [[ 1.0000   ,  1.0000   ]]]]

Expands a tensor to the specified shape.

Expands a tensor to the specified shape.

Slices the self tensor along the selected dimension at the given index. This function returns a view of the original tensor with the given dimension removed.

>>> nats <- sArangeNaturals (SGradient SWithoutGradient) (SLayout SDense) (SDevice SCPU) (SDataType SInt32) (SSize @8)
>>> input <- sReshape (SShape $ SName @"*" :&: SSize @4 :|: SName @"*" :&: SSize @2 :|: SNil) nats
>>> input
Tensor Int32 [4,2] [[ 0,  1],
                    [ 2,  3],
                    [ 4,  5],
                    [ 6,  7]]

index can be provided at compile-time:

>>> sSelect (SSelectDim (SByIndex @0)) (SIndex @1) input
Tensor Int32 [2] [ 2,  3]

index can also be provided at runtime:

>>> sSelect (SSelectDim (SByIndex @0)) (SUncheckedIndex 1) input
Tensor Int32 [2] [ 2,  3]

It produces a runtime error if the index is too large:

>>> sSelect (SSelectDim (SByIndex @0)) (SUncheckedIndex 10) input
*** Exception: IndexOutOfBoundError {ioobeIndex = 10, ioobeDim = Dim {dimName = "*", dimSize = 4}}

GatherDimImplF is a type-level helper function for sGatherDim.

>>> :kind! GatherDimImplF ('ByIndex 1) '[ 'Dim ('Name "batch") ('Size 2), 'Dim ('Name "sequence") ('Size 4), 'Dim ('Name "feature") ('Size 1)] '[ 'Dim ('Name "batch") ('Size 2), 'Dim ('Name "sequence") ('Size 1), 'Dim ('Name "feature") ('Size 1)]
...
= 'Just
    '[ 'Dim ('Name "batch") ('Size 2),
       'Dim ('Name "sequence") ('Size 4),
       'Dim ('Name "feature") ('Size 1)]
>>> :kind! GatherDimImplF ('ByIndex 1) '[ 'Dim ('Name "batch") ('Size 2), 'Dim ('Name "sequence") ('Size 4), 'Dim ('Name "feature") ('Size 1)] '[ 'Dim ('Name "*") ('Size 2), 'Dim ('Name "sequence") ('Size 1), 'Dim ('Name "*") ('Size 1)]
...
= 'Just
    '[ 'Dim ('Name "batch") ('Size 2),
       'Dim ('Name "sequence") ('Size 4),
       'Dim ('Name "feature") ('Size 1)]
>>> :kind! GatherDimImplF ('ByIndex 1) '[ 'Dim ('Name "batch") ('Size 2), 'Dim ('Name "sequence") ('Size 4), 'Dim ('Name "feature") ('Size 2)] '[ 'Dim ('Name "batch") ('Size 2), 'Dim ('Name "sequence") ('Size 1), 'Dim ('Name "feature") ('Size 1)]
...
= 'Nothing
>>> :kind! GatherDimImplF ('ByIndex 1) '[ 'Dim ('Name "batch") ('Size 2), 'Dim ('Name "sequence") ('Size 4), 'Dim ('Name "feature") ('Size 1)] '[ 'Dim ('Name "batch") ('Size 2), 'Dim ('Name "boo") ('Size 1), 'Dim ('Name "feature") ('Size 1)]
...
= 'Nothing
>>> :kind! GatherDimImplF ('ByIndex 1) '[ 'Dim ('Name "batch") ('Size 2), 'Dim ('Name "sequence") ('Size 0), 'Dim ('Name "feature") ('Size 1)] '[ 'Dim ('Name "batch") ('Size 2), 'Dim ('Name "sequence") ('Size 2), 'Dim ('Name "feature") ('Size 1)]
...
= 'Nothing
>>> :kind! GatherDimImplF ('ByIndex 1) '[ 'Dim ('Name "batch") ('Size 2), 'Dim ('Name "sequence") ('Size 1)] '[ 'Dim ('Name "batch") ('Size 2), 'Dim ('Name "sequence") ('Size 1), 'Dim ('Name "feature") ('Size 1)]
...
= 'Nothing
>>> :kind! GatherDimImplF ('ByIndex 2) '[ 'Dim ('Name "batch") ('Size 2), 'Dim ('Name "sequence") ('Size 1), 'Dim ('Name "feature") ('Size 3)] '[ 'Dim ('Name "batch") ('Size 2), 'Dim ('Name "sequence") ('Size 1), 'Dim ('Name "feature") ('Size 1)]
...
= 'Just
    '[ 'Dim ('Name "batch") ('Size 2),
       'Dim ('Name "sequence") ('Size 1),
       'Dim ('Name "feature") ('Size 3)]
>>> :kind! GatherDimImplF ('ByName "feature") '[ 'Dim ('Name "batch") ('Size 2), 'Dim ('Name "sequence") ('Size 1), 'Dim ('Name "feature") ('Size 3)] '[ 'Dim ('Name "batch") ('Size 2), 'Dim ('Name "sequence") ('Size 1), 'Dim ('Name "*") ('Size 1)]
...
= 'Just
    '[ 'Dim ('Name "batch") ('Size 2),
       'Dim ('Name "sequence") ('Size 1),
       'Dim ('Name "feature") ('Size 3)]

Calculate the output shape of a gather operation for a given index shape along a given axis.

>>> :kind! GatherDimF ('SelectDim ('ByIndex 2)) ('Shape '[ 'Dim ('Name "*") ('Size 2), 'Dim ('Name "*") ('Size 1), 'Dim ('Name "*") ('Size 3)]) ('Shape '[ 'Dim ('Name "*") ('Size 2), 'Dim ('Name "*") ('Size 1), 'Dim ('Name "*") ('Size 1)])
...
= 'Shape
    '[ 'Dim ('Name "*") ('Size 2), 'Dim ('Name "*") ('Size 1),
       'Dim ('Name "*") ('Size 3)]

Gather values along an axis for a specified dimension.

>>> sToTensor' = sToTensor (SGradient SWithoutGradient) (SLayout SDense) (SDevice SCPU)
>>> t <- sToTensor' [[1 :: Float, 2], [3, 4]]
>>> idx <- sToTensor' [[0 :: Int, 0], [1, 0]]
>>> result <- sGatherDim (SSelectDim $ SByIndex @1) idx t
>>> :t result
result
  :: Tensor
       ('Gradient 'WithoutGradient)
       ('Layout 'Dense)
       ('Device 'CPU)
       ('DataType 'Float)
       ('Shape
          '[ 'Dim ('Name "*") 'UncheckedSize,
             'Dim ('Name "*") 'UncheckedSize])
>>> result
Tensor Float [2,2] [[ 1.0000   ,  1.0000   ],
                    [ 4.0000   ,  3.0000   ]]
>>> shape = SShape $ SNoName :&: SSize @2 :|: SNoName :&: SSize @2 :|: SNil
>>> t' <- sCheckedShape shape t
>>> idx' <- sCheckedShape shape idx
>>> result <- sGatherDim (SSelectDim $ SByIndex @1) idx' t'
>>> :t result
result
  :: Tensor
       ('Gradient 'WithoutGradient)
       ('Layout 'Dense)
       ('Device 'CPU)
       ('DataType 'Float)
       ('Shape '[ 'Dim ('Name "*") ('Size 2), 'Dim ('Name "*") ('Size 2)])
>>> result
Tensor Float [2,2] [[ 1.0000   ,  1.0000   ],
                    [ 4.0000   ,  3.0000   ]]