DynamicGraph Class Reference


                    
                    
                    AnyTensor

A type-erased tensor variable.

Declaration

Swift

public class AnyTensor

extension DynamicGraph.AnyTensor: CustomStringConvertible

extension DynamicGraph.AnyTensor: CustomDebugStringConvertible

extension DynamicGraph.AnyTensor: DynamicGraph_Any

extension DynamicGraph.AnyTensor: DynamicGraph.AnyTensorGroup


                    
                    
                    Tensor

A typed tensor variable.

Declaration

Swift

public final class Tensor<Element> : AnyTensor where Element : TensorNumeric

extension DynamicGraph.Tensor: DynamicGraph.TensorGroup


                    
                    
                    cGraph

Declaration

Swift

public let cGraph: OpaquePointer


                    
                    
                    workspaceSize

The workspace size for executions. This is helpful when execute models, which will use this to tune the optimal kernel.

Declaration

Swift

public var workspaceSize: Int


                    
                    
                    maxConcurrency

Declaration

Swift

public var maxConcurrency: StreamContext.Concurrency { get set }


                    
                    
                    init()

Declaration

Swift

public init()


                    
                    
                    Group

Type-aware group of tensors.

Declaration

Swift

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


                    
                    
                    LogLevel

Declaration

Swift

public enum LogLevel


                    
                    
                    logLevel

Set the log level on a dynamic graph.

Declaration

Swift

public static var logLevel: LogLevel { get set }


                    
                    
                    setSeed(_:)

Set the seed for global context.

Declaration

Swift

public static func setSeed(_ seed: UInt32)


                    
                    
                    joined()

Create a synchronization point with the underlying stream context.

Declaration

Swift

public func joined()


                    
                    
                    queueWatermark

The watermark for in-flight Metal operations.

Declaration

Swift

public static var queueWatermark: Int { get set }


                    
                    
                    setProfiler(_:)

Set whether to enable profiler or not.

Declaration

Swift

public static func setProfiler(_ on: Bool)


                    
                    
                    Statistics

Statistics about the graph.

Declaration

Swift

public struct Statistics


                    
                    
                    statistics

Collect statistics from a dynamic graph. It computes how many variables and computations are still tracked. If you have memory leaks, this is useful to track down that.

Declaration

Swift

public var statistics: Statistics { get }


                    
                    
                    WeakAnyTensor

Declaration

Swift

extension DynamicGraph.WeakAnyTensor: Hashable


                    
                    
                    variable()

Create a placeholder variable. It doesn’t have shape and can only be used as output.

Declaration

Swift

public func variable() -> AnyTensor


                    
                    
                    constant()

Create a placeholder constant. It doesn’t have shape and can only be used as output.

Declaration

Swift

public func constant() -> AnyTensor


                    
                    
                    variable(_:)

Create a new variable from an existing tensor.

Declaration

Swift

public func variable<Element>(_ tensor: NNC.Tensor<Element>) -> Tensor<Element> where Element : TensorNumeric

Parameters


                                tensor

The existing tensor.

Return Value

Created new tensor variable.


                    
                    
                    constant(_:)

Create a new constant from an existing tensor.

Declaration

Swift

public func constant<Element>(_ tensor: NNC.Tensor<Element>) -> Tensor<Element> where Element : TensorNumeric

Parameters


                                tensor

The existing tensor.

Return Value

Created new tensor constant.


                    
                    
                    variable(_:format:shape:of:)

Declaration

Swift

public func variable<Element: TensorNumeric>(
  _ device: DeviceKind, format: TensorFormat, shape: TensorShape, of: Element.Type = Element.self
) -> Tensor<Element>


                    
                    
                    constant(_:format:shape:of:)

Declaration

Swift

public func constant<Element: TensorNumeric>(
  _ device: DeviceKind, format: TensorFormat, shape: TensorShape, of: Element.Type = Element.self
) -> Tensor<Element>


                    
                    
                    variable(_:_:of:)

Declaration

Swift

public func variable<Element: TensorNumeric>(
  _ device: DeviceKind, _ shapeFormat: TensorShapeFormat, of: Element.Type = Element.self
) -> Tensor<Element>


                    
                    
                    constant(_:_:of:)

Declaration

Swift

public func constant<Element: TensorNumeric>(
  _ device: DeviceKind, _ shapeFormat: TensorShapeFormat, of: Element.Type = Element.self
) -> Tensor<Element>


                    
                    
                    variable(like:)

Declaration

Swift

public func variable<T>(like: T) -> T where T : DynamicGraph_TensorGroup


                    
                    
                    constant(like:)

Declaration

Swift

public func constant<T>(like: T) -> T where T : DynamicGraph_TensorGroup


                    
                    
                    withNoGrad(_:)

Turn off gradient tracking within the given closure. This may be useful during testing, we can make more aggressive optimizations if the gradient tracking is off.

Declaration

Swift

public func withNoGrad<Result>(_ closure: () throws -> Result) rethrows -> Result


                    
                    
                    withStream(_:_:)

Perform operations on a given stream within the closure. Each operation can take a stream context parameter, however, that often error-prune. This method make sure all operations within the closure will be dispatched to the given stream context, making it easier to organize.

Declaration

Swift

public func withStream<Result>(_ streamContext: StreamContext, _ closure: () throws -> Result)
  rethrows -> Result


                    
                    
                    garbageCollect()

Perform garbage collection. This will be done automatically when GPU memory at pressure. Do it manually helps to identify actual memory leaks.

Declaration

Swift

public func garbageCollect()


                    
                    
                    EnableBits

Declaration

Swift

public struct EnableBits : OptionSet, CaseIterable


                    
                    
                    flags

Set system-wide flag.

Declaration

Swift

public static var flags: EnableBits { get set }


                    
                    
                    AnyTensorGroup

Declaration

Swift

public typealias AnyTensorGroup = DynamicGraph_AnyTensorGroup


                    
                    
                    AnyGroup

Declaration

Swift

public typealias AnyGroup = DynamicGraph_AnyGroup


                    
                    
                    Store

A key-value based parameter store.

Declaration

Swift

public struct Store


                    
                    
                    OpenError

Declaration

Swift

public enum OpenError : Error


                    
                    
                    openStore(_:flags:externalStore:chunkSize:procedure:)

Open the store from a file.

Declaration

Swift

@discardableResult
public func openStore<SuccessResult>(
  _ filePath: String, flags: Store.OpenFlag = .truncateWhenClose,
  externalStore: String? = nil, chunkSize: Int = 16_384,
  procedure: (_ store: Store) throws -> SuccessResult
) rethrows -> Result<SuccessResult, OpenError>

Parameters

`filePath`	The file path for the store.
`flags`	The flags for the opening store. Default to truncateWhenClose.
`externalStore`	The external store for tensor data, in case we have tensors stored externally (a.k.a. outside of the SQLite database).
`chunkSize`	Align each tensor to a certain chunk size.
`procedure`	When the store is open, you can access it from this closure.

Return Value

Wether this store can be successfully open or not.


                    
                    
                    TensorGroup

Declaration

Swift

public typealias TensorGroup = DynamicGraph_TensorGroup