Group

public struct Group<Element> : RandomAccessCollection where Element : DynamicGraph.AnyTensor

extension DynamicGraph.Group: DynamicGraph.AnyGroup

extension DynamicGraph.Group: DynamicGraph_Any where Element: DynamicGraph.AnyTensor

extension DynamicGraph.Group: DynamicGraph.AnyTensorGroup where Element: DynamicGraph.AnyTensor

extension DynamicGraph.Group: DynamicGraph.TensorGroup
where Element: DynamicGraph.TensorGroup, Element: DynamicGraph.AnyTensor

Type-aware group of tensors.

Element
Declaration
Swift

public typealias Element = Element
Index
Declaration
Swift

public typealias Index = Int
Indices
Declaration
Swift

public typealias Indices = Range<Index>


                    
                    
                    SubSequence

Declaration

Swift

public typealias SubSequence = Array<Element>.SubSequence

endIndex
Declaration
Swift

public var endIndex: Index { get }
indices
Declaration
Swift

public var indices: Indices { get }
startIndex
Declaration
Swift

public var startIndex: Index { get }


                    
                    
                    formIndex(after:)

Declaration

Swift

public func formIndex(after i: inout Index)


                    
                    
                    formIndex(before:)

Declaration

Swift

public func formIndex(before i: inout Index)


                    
                    
                    subscript(_:)

Declaration

Swift

public subscript(position: Index) -> Element { get }


                    
                    
                    subscript(_:)

Declaration

Swift

public subscript(x: Indices) -> SubSequence { get }

init(_:)
Declaration
Swift

public init(_ elements: Element...)


                    
                    
                    init(_:)

Declaration

Swift

public init<OtherElement>(_ otherGroup: Group<OtherElement>) where OtherElement : DynamicGraph.AnyTensor


                    
                    
                    init(_:)

Declaration

Swift

public init(_ underlyingArray: [Element])


                    
                    
                    backward(to:streamContext:)

Compute gradients from this tensor to the source tensors.

Declaration

Swift

public func backward<S: Sequence>(to tensors: S, streamContext: StreamContext? = nil)
where S.Element: DynamicGraph.AnyGroup

Parameters

`to`	The source tensors to this tensor.
`streamContext`	The stream context to perform such operation.


                    
                    
                    backward(to:streamContext:)

Compute gradients from this tensor to the source tensor.

Declaration

Swift

public func backward<Group: DynamicGraph.AnyGroup>(
  to tensor: Group, streamContext: StreamContext? = nil
)

Parameters

`to`	The source tensor to this tensor.
`streamContext`	The stream context to perform such operation.


                    
                    
                    transposed(_:_:streamContext:)

Transpose from axisA to axisB.

Declaration

Swift

public func transposed(_ axisA: Int, _ axisB: Int, streamContext: StreamContext?)
  -> DynamicGraph.Group<Element>


                    
                    
                    rand(_:streamContext:)

Fill the given tensor with uniform random values.

Declaration

Swift

public func rand(
  _ range: ClosedRange<Float>, streamContext: StreamContext?
)

randn(std:mean:streamContext:)
Fill the given tensor with normal-distributed random values.
Declaration
Swift

public func randn( std: Float, mean: Float, streamContext: StreamContext? )
full(_:streamContext:)
Fill the given tensor with a value.
Declaration
Swift

public func full(_ value: Float, streamContext: StreamContext?)


                    
                    
                    lerp(_:to:streamContext:)

Interpolate from this tensor to the other tensor.

Declaration

Swift

public func lerp(
  _ weight: Float, to: DynamicGraph.Group<Element>, streamContext: StreamContext?
)


                    
                    
                    clamp(_:streamContext:)

Clamp the given tensor between two values.

Declaration

Swift

public func clamp(_ range: ClosedRange<Float>, streamContext: StreamContext?)


                    
                    
                    clamp(_:streamContext:)

Clamp the given tensor with a lower bound.

Declaration

Swift

public func clamp(_ range: PartialRangeFrom<Float>, streamContext: StreamContext?)


                    
                    
                    clamp(_:streamContext:)

Clamp the given tensor with an upper bound.

Declaration

Swift

public func clamp(_ range: PartialRangeThrough<Float>, streamContext: StreamContext?)

detach()
Detach tensors in this group from the graph. Afterwards, it is always “isConstant” and cannot requiresGrad.
Declaration
Swift

public mutating func detach()


                    
                    
                    clamped(_:streamContext:)

Clamp the given tensor between two values.

Declaration

Swift

public func clamped(_ range: ClosedRange<Float>, streamContext: StreamContext?)
  -> DynamicGraph.Group<Element>


                    
                    
                    clamped(_:streamContext:)

Clamp the given tensor with a lower bound.

Declaration

Swift

public func clamped(_ range: PartialRangeFrom<Float>, streamContext: StreamContext?)
  -> DynamicGraph.Group<Element>


                    
                    
                    clamped(_:streamContext:)

Clamp the given tensor with an upper bound.

Declaration

Swift

public func clamped(_ range: PartialRangeThrough<Float>, streamContext: StreamContext?)
  -> DynamicGraph.Group<Element>


                    
                    
                    copied(streamContext:)

Make a copy of the existing tensor group.

Declaration

Swift

public func copied(streamContext: StreamContext?)
  -> DynamicGraph.Group<Element>

contiguous(streamContext:)
Only make a copy of the existing tensor group if it is not contiguous in memory.
Declaration
Swift

public func contiguous(streamContext: StreamContext?) -> DynamicGraph.Group<Element>


                    
                    
                    reduced(_:axis:streamContext:)

Reduce along a given dimension.

Declaration

Swift

public func reduced(_ op: ReduceOp, axis: [Int], streamContext: StreamContext?)
  -> DynamicGraph.Group<Element>

scale(by:streamContext:)
Scale the given tensor with a constant inplace.
Declaration
Swift

public func scale(by a: Float, streamContext: StreamContext?)
softmax(streamContext:)
Apply softmax activation to the given tensor inplace.
Declaration
Swift

public func softmax(streamContext: StreamContext?)
ReLU(streamContext:)
Apply ReLU activation to the given tensor inplace.
Declaration
Swift

public func ReLU(streamContext: StreamContext?)
sigmoid(streamContext:)
Apply sigmoid activation to the given tensor inplace.
Declaration
Swift

public func sigmoid(streamContext: StreamContext?)
tanh(streamContext:)
Apply tanh activation to the given tensor inplace.
Declaration
Swift

public func tanh(streamContext: StreamContext?)
swish(streamContext:)
Apply swish activation to the given tensor inplace.
Declaration
Swift

public func swish(streamContext: StreamContext?)


                    
                    
                    untyped

Declaration

Swift

public var untyped: [DynamicGraph.AnyTensor] { get }

graph
Declaration
Swift

public var graph: DynamicGraph { get }
kind
Declaration
Swift

public var kind: DeviceKind { get }
shape
Declaration
Swift

public var shape: TensorShape { get }
format
Declaration
Swift

public var format: TensorFormat { get }
strides
Declaration
Swift

public var strides: TensorShape { get }
isConstant
Declaration
Swift

public var isConstant: Bool { get }
isContiguous
Declaration
Swift

public var isContiguous: Bool { get }


                    
                    
                    requiresGrad

Declaration

Swift

public var requiresGrad: Bool { get set }


                    
                    
                    grad

Declaration

Swift

public var grad: DynamicGraph.Group<DynamicGraph.AnyTensor>? { get set }


                    
                    
                    typeErased

Declaration

Swift

public var typeErased: DynamicGraph.Group<DynamicGraph.AnyTensor> { get }

isNaN
Declaration
Swift

public var isNaN: Bool { get }

Available where `Element`: `DynamicGraph.AnyTensor`


                    
                    
                    subscript(_:streamContext:)

Declaration

Swift

public subscript(ranges: [Range<Int>], streamContext streamContext: StreamContext?)
  -> DynamicGraph.Group<Element>


                    
                    
                    subscript(_:streamContext:)

Declaration

Swift

@inlinable
public subscript(ranges: Range<Int>..., streamContext streamContext: StreamContext?)
  -> DynamicGraph.Group<Element>


                    
                    
                    subscript(_:streamContext:)

Declaration

Swift

@inlinable
public subscript(range: Range<Int>, streamContext streamContext: StreamContext?)
  -> DynamicGraph.Group<Element>


                    
                    
                    subscript(_:_:streamContext:)

Declaration

Swift

@inlinable
public subscript(i0: Int, range: Range<Int>, streamContext streamContext: StreamContext?)
  -> DynamicGraph.Group<Element>


                    
                    
                    subscript(_:_:_:streamContext:)

Declaration

Swift

@inlinable
public subscript(i0: Int, i1: Int, range: Range<Int>, streamContext streamContext: StreamContext?)
  -> DynamicGraph.Group<Element>


                    
                    
                    subscript(_:_:_:_:streamContext:)

Declaration

Swift

@inlinable
public subscript(i0: Int, i1: Int, i2: Int, range: Range<Int>,
  streamContext streamContext: StreamContext?
) -> DynamicGraph.Group<Element>


                    
                    
                    subscript(_:_:_:_:_:streamContext:)

Declaration

Swift

@inlinable
public subscript(i0: Int, i1: Int, i2: Int, i3: Int, range: Range<Int>,
  streamContext streamContext: StreamContext?
)
  -> DynamicGraph.Group<Element>


                    
                    
                    subscript(_:_:_:_:_:_:streamContext:)

Declaration

Swift

@inlinable
public subscript(i0: Int, i1: Int, i2: Int, i3: Int, i4: Int, range: Range<Int>,
  streamContext streamContext: StreamContext?
)
  -> DynamicGraph.Group<
    Element
  >


                    
                    
                    subscript(_:_:_:_:_:_:_:streamContext:)

Declaration

Swift

@inlinable
public subscript(i0: Int, i1: Int, i2: Int, i3: Int, i4: Int, i5: Int, range: Range<Int>,
  streamContext streamContext: StreamContext?
)
  -> DynamicGraph.Group<Element>


                    
                    
                    subscript(_:_:_:_:_:_:_:_:streamContext:)

Declaration

Swift

@inlinable
public subscript(i0: Int, i1: Int, i2: Int, i3: Int, i4: Int, i5: Int, i6: Int, range: Range<Int>,
  streamContext streamContext: StreamContext?
)
  -> DynamicGraph.Group<Element>


                    
                    
                    subscript(_:streamContext:)

Declaration

Swift

@inlinable
public subscript(range: UnboundedRange, streamContext streamContext: StreamContext?)
  -> DynamicGraph.Group<Element>


                    
                    
                    subscript(_:_:streamContext:)

Declaration

Swift

@inlinable
public subscript(i0: Int, range: UnboundedRange, streamContext streamContext: StreamContext?)
  -> DynamicGraph.Group<Element>


                    
                    
                    subscript(_:_:_:streamContext:)

Declaration

Swift

@inlinable
public subscript(i0: Int, i1: Int, range: UnboundedRange,
  streamContext streamContext: StreamContext?
) -> DynamicGraph.Group<Element>


                    
                    
                    subscript(_:_:_:_:streamContext:)

Declaration

Swift

@inlinable
public subscript(i0: Int, i1: Int, i2: Int, range: UnboundedRange,
  streamContext streamContext: StreamContext?
) -> DynamicGraph.Group<Element>


                    
                    
                    subscript(_:_:_:_:_:streamContext:)

Declaration

Swift

@inlinable
public subscript(i0: Int, i1: Int, i2: Int, i3: Int, range: UnboundedRange,
  streamContext streamContext: StreamContext?
)
  -> DynamicGraph.Group<Element>


                    
                    
                    subscript(_:_:_:_:_:_:streamContext:)

Declaration

Swift

@inlinable
public subscript(i0: Int, i1: Int, i2: Int, i3: Int, i4: Int, range: UnboundedRange,
  streamContext streamContext: StreamContext?
)
  -> DynamicGraph.Group<
    Element
  >


                    
                    
                    subscript(_:_:_:_:_:_:_:streamContext:)

Declaration

Swift

@inlinable
public subscript(i0: Int, i1: Int, i2: Int, i3: Int, i4: Int, i5: Int, range: UnboundedRange,
  streamContext streamContext: StreamContext?
)
  -> DynamicGraph.Group<Element>


                    
                    
                    subscript(_:_:_:_:_:_:_:_:streamContext:)

Declaration

Swift

@inlinable
public subscript(i0: Int, i1: Int, i2: Int, i3: Int, i4: Int, i5: Int, i6: Int,
  range: UnboundedRange, streamContext streamContext: StreamContext?
)
  -> DynamicGraph.Group<Element>

Available where `Element`: `DynamicGraph.TensorGroup`, `Element`: `DynamicGraph.AnyTensor`


                    
                    
                    toGPU(_:streamContext:)

Copy the given tensor to GPU.

Declaration

Swift

public func toGPU(_ ordinal: Int, streamContext: StreamContext?)
  -> DynamicGraph.Group<Element>


                    
                    
                    toCPU(streamContext:)

Copy the given tensor to CPU.

Declaration

Swift

public func toCPU(streamContext: StreamContext?) -> DynamicGraph.Group<Element>

Available where `Element`: `DynamicGraph_TensorGroup`


                    
                    
                    scaled(by:streamContext:)

Scale the given tensor with a constant.

Declaration

Swift

public func scaled(by a: Float, streamContext: StreamContext?) -> DynamicGraph.Group<Element>

Available where `Element` == `DynamicGraph.AnyTensor`

as(of:)
Explicitly cast the underlying storage to a specific type. It is a helper function than doing DynamicGraph.Group>(something). Less code change required if we change this from group to tensor.
Declaration
Swift

public func `as`<T>(of: T.Type) -> DynamicGraph.Group<DynamicGraph.Tensor<T>> where T : TensorNumeric

Available where `Element`: `DynamicGraph.AnyTensor`


                    
                    
                    chunked(_:axis:streamContext:)

Declaration

Swift

public func chunked(_ numberOfChunks: Int, axis: Int, streamContext: StreamContext?) -> [`Self`]


                    
                    
                    AnyTensor

Declaration

Swift

public typealias AnyTensor = DynamicGraph.Group<DynamicGraph.AnyTensor>


                    
                    
                    exec(cmd:hint:inputs:outputSize:streamContext:)

Declaration

Swift

public static func exec(
  cmd: ccv_nnc_cmd_t, hint: ccv_nnc_hint_t, inputs: [DynamicGraph_Any?], outputSize: Int32,
  streamContext: StreamContext?
) -> [AnyTensor]


                    
                    
                    exec(cmd:hint:inputs:outputs:streamContext:)

Declaration

Swift

public static func exec(
  cmd: ccv_nnc_cmd_t, hint: ccv_nnc_hint_t, inputs: [DynamicGraph_Any?],
  outputs: [DynamicGraph_Any],
  streamContext: StreamContext?
)


                    
                    
                    evaluate(model:testing:dataParallel:inputs:outputSize:streamContext:)

Declaration

Swift

public static func evaluate(
  model: OpaquePointer, testing: Bool, dataParallel: inout Int?, inputs: [DynamicGraph_Any?],
  outputSize: Int32, streamContext: StreamContext?
) -> [AnyTensor]


                    
                    
                    reshaped(format:shape:offset:strides:)

Declaration

Swift

public func reshaped(
  format: TensorFormat, shape: TensorShape, offset: TensorShape? = nil,
  strides: TensorShape? = nil
) -> Self


                    
                    
                    reshaped(_:offset:strides:)

Declaration

Swift

public func reshaped(
  _ shapeFormat: TensorShapeFormat, offset: TensorShape? = nil, strides: TensorShape? = nil
) -> Self

Available where `Element`: `DynamicGraph.TensorGroup`, `Element`: `DynamicGraph.AnyTensor`


                    
                    
                    ElementNumeric

Declaration

Swift

public typealias ElementNumeric = Element.ElementNumeric

Group

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Parameters

Declaration

Parameters

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Available where Element: DynamicGraph.AnyTensor

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Available where Element: DynamicGraph.TensorGroup, Element: DynamicGraph.AnyTensor

Declaration

Declaration

Available where Element: DynamicGraph_TensorGroup

Declaration

Available where Element == DynamicGraph.AnyTensor

Declaration

Available where Element: DynamicGraph.AnyTensor

Declaration

Available where `Element`: `DynamicGraph.AnyTensor`

Available where `Element`: `DynamicGraph.TensorGroup`, `Element`: `DynamicGraph.AnyTensor`

Available where `Element`: `DynamicGraph_TensorGroup`

Available where `Element` == `DynamicGraph.AnyTensor`

Available where `Element`: `DynamicGraph.AnyTensor`

Available where `Element`: `DynamicGraph.TensorGroup`, `Element`: `DynamicGraph.AnyTensor`