S4NNC

https://liuliu.github.io/s4nnc/documentation/
Admin
S4NNC is a neural network framework providing a comprehensive set of models, layers, optimizers, and...
Tokens:287,902
Snippets:2,890
Trust Score:9.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### starts(with:by:) Method Signature

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dataframe/untypedseries/starts%28with%3Aby%3A%29

The signature for the starts(with:by:) method, which is inherited from Sequence.

```APIDOC
## starts(with:by:)

### Description
Checks if the sequence starts with the elements of a `possiblePrefix` sequence, using a provided `areEquivalent` closure to compare elements.

### Method Signature
```swift
func starts<PossiblePrefix>(with possiblePrefix: PossiblePrefix, by areEquivalent: (Self.Element, PossiblePrefix.Element) throws -> Bool) rethrows -> Bool where PossiblePrefix : Sequence
```

### Parameters
- **possiblePrefix**: A `Sequence` whose elements are compared to the beginning of the receiver.
- **areEquivalent**: A closure that takes two elements (one from the receiver, one from `possiblePrefix`) and returns `true` if they are considered equivalent, `false` otherwise.

### Returns
`true` if the sequence starts with the `possiblePrefix` according to the `areEquivalent` closure, `false` otherwise.
```

--------------------------------

### Sequence starts(with:by:) Method Signature

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dataframe/manyuntypedseries/starts%28with%3Aby%3A%29

This is the method signature for starts(with:by:). It checks if a sequence starts with a given possible prefix, using a provided closure to determine element equivalence.

```swift
func starts<PossiblePrefix>(
    with possiblePrefix: PossiblePrefix,
    by areEquivalent: (Self.Element, PossiblePrefix.Element) throws -> Bool
) rethrows -> Bool where PossiblePrefix : Sequence
```

--------------------------------

### Sequence starts(with:) Method Signature

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dataframe/typedseries/starts%28with%3A%29

This is the method signature for starts(with:). It returns a Boolean indicating if the sequence starts with the given possiblePrefix. The element type must conform to Equatable.

```swift
func starts<PossiblePrefix>(with possiblePrefix: PossiblePrefix) -> Bool where PossiblePrefix : Sequence, Self.Element == PossiblePrefix.Element
```

--------------------------------

### Replicate Mode Example

Source: https://liuliu.github.io/s4nnc/documentation/nnc/pad/mode/replicate

Demonstrates the usage of the replicate mode in padding operations.

```plaintext
case replicate
```

--------------------------------

### Fail Case Example

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dynamicgraph/store/modelreaderresult/fail

Represents the scenario where no data is loaded.

```text
case fail
```

--------------------------------

### starts(with:by:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dataframe/manyuntypedseries/starts%28with%3Aby%3A%29

Checks if a sequence starts with a given prefix, using a custom closure to determine element equivalence.

```APIDOC
## starts(with:by:)

### Description
Checks if a sequence starts with a given prefix, using a custom closure to determine element equivalence.

### Signature
```swift
func starts<PossiblePrefix>(with possiblePrefix: PossiblePrefix, by areEquivalent: (Self.Element, PossiblePrefix.Element) throws -> Bool) rethrows -> Bool where PossiblePrefix : Sequence
```

### Parameters
- `possiblePrefix`: The sequence to check if it is a prefix of the current sequence.
- `areEquivalent`: A closure that takes two elements (one from the current sequence and one from `possiblePrefix`) and returns `true` if they are considered equivalent, `false` otherwise.

### Returns
`true` if the sequence starts with the `possiblePrefix` according to the `areEquivalent` closure, `false` otherwise.

### Throws
This method rethrows errors thrown by the `areEquivalent` closure.
```

--------------------------------

### Float32 Case Example

Source: https://liuliu.github.io/s4nnc/documentation/nnc/datatype/float32

Demonstrates the case statement for Float32.

```plaintext
case Float32
```

--------------------------------

### Float64 Case Example

Source: https://liuliu.github.io/s4nnc/documentation/nnc/datatype/float64

Demonstrates the case statement for Float64.

```rust
case Float64
```

--------------------------------

### Zero Case Example

Source: https://liuliu.github.io/s4nnc/documentation/nnc/pad/mode/zero

Illustrates the 'zero' case within the Pad.Mode system. This is a basic case declaration.

```case
case zero
```

--------------------------------

### begin Instance Property

Source: https://liuliu.github.io/s4nnc/documentation/nnc/hint/border-swift.struct/begin

The 'begin' property is an array of integers, likely representing starting points or initial values within the border-swift structure.

```APIDOC
## begin

### Description
An instance property that holds an array of integers.

### Type
[Int]

### Example
```swift
var begin: [Int]
```
```

--------------------------------

### starts(with:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dataframe/manyuntypedseries/starts%28with%3A%29

Checks if the sequence begins with the elements of a `possiblePrefix`. This method is available when the `Element` type conforms to `Equatable`.

```APIDOC
## starts(with:)

### Description
Checks if the sequence begins with the elements of a `possiblePrefix`.

### Signature
```swift
func starts<PossiblePrefix>(with possiblePrefix: PossiblePrefix) -> Bool where PossiblePrefix : Sequence, Self.Element == PossiblePrefix.Element
```

### Constraints
Available when `Element` conforms to `Equatable`.
```

--------------------------------

### Get Suffix from Index

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dynamicgraph/group/suffix%28from%3A%29

Returns a subsequence of the collection starting from the given index. This method is inherited from the Collection protocol.

```swift
func suffix(from start: Self.Index) -> Self.SubSequence
```

--------------------------------

### init(leftScalar:rightScalar:name:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/add/init%28leftscalar%3Arightscalar%3Aname%3A%29

Initializes a new instance with optional leftScalar, rightScalar, and name.

```APIDOC
## init(leftScalar:rightScalar:name:)

### Description
Initializes a new instance with optional leftScalar, rightScalar, and name.

### Parameters
#### Path Parameters
- **leftScalar** (Float) - Optional - Defaults to 1.
- **rightScalar** (Float) - Optional - Defaults to 1.
- **name** (String) - Optional - Defaults to "".

### Method
Initializer

### Endpoint
init(leftScalar:rightScalar:name:)
```

--------------------------------

### init(_:_:name:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/variable/init%28_%3A_%3Aname%3A%29

Initializes a new instance of the DeviceKind with the specified dimension format and an optional name.

```APIDOC
## init(_:_:name:)

### Description
Initializes a new instance of the DeviceKind with the specified dimension format and an optional name.

### Parameters
- **kind** (DeviceKind) - Description of the kind parameter.
- **dimensionFormat** (TensorShapeFormat) - Description of the dimensionFormat parameter.
- **name** (String) - Optional name for the initializer. Defaults to "".
```

--------------------------------

### init(_:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/functional/gemmflag/init%28_%3A%29

Initializes a new instance by converting a sequence.

```APIDOC
## init(_:)

### Description
Initializes a new instance by converting a sequence.

### Signature
```swift
init<S>(_ sequence: S) where S : Sequence, Self.Element == S.Element
```

### Inheritance
Inherited from `SetAlgebra.init(_:)`.
```

--------------------------------

### init(exactly:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/bfloat16/init%28exactly%3A%29

Initializes a bfloat16 value from a source that conforms to BinaryInteger, ensuring exact representation.

```APIDOC
## init(exactly:)

### Description
Initializes a bfloat16 value from a source that conforms to BinaryInteger, ensuring exact representation.

### Signature
```swift
init?<T>(exactly source: T) where T : BinaryInteger
```

### Parameters
- **source** (`T` where `T` conforms to `BinaryInteger`): The exact value to initialize the bfloat16 from.
```

--------------------------------

### init(_:name:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/scalmul/init%28_%3Aname%3A%29

Initializes a new instance with a Float value and an optional String name.

```APIDOC
## init(_:name:)

### Description
Initializes a new instance with a Float value and an optional String name.

### Parameters
#### Path Parameters
- **a** (Float) - Required - The Float value for initialization.
- **name** (String) - Optional - The name for the instance, defaults to an empty string.

### Method
Initializer

### Endpoint
N/A (This is an SDK initializer, not an HTTP endpoint)

### Request Example
```swift
let instance = YourClass(10.5, name: "ExampleName")
let defaultInstance = YourClass(5.0)
```

### Response
#### Success Response
An instance of the class is created.

#### Response Example
```swift
// No direct response object for an initializer, but an instance is returned.
```
```

--------------------------------

### Get Model Parameters

Source: https://liuliu.github.io/s4nnc/documentation/nnc/anymodel/parameters%28for%3A%29

Use this method to get an abstract representation of either the weight or bias parameters of a model. Ensure you provide the correct Model.ParametersType.

```swift
func parameters(for type: Model.ParametersType) -> Model.Parameters
```

--------------------------------

### init(name:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/copy/init%28name%3A%29

Initializes a new instance with an optional name.

```APIDOC
## init(name:)

### Description
Initializes a new instance with an optional name.

### Method Signature
init(name: String = "")

### Parameters
#### Path Parameters
- **name** (String) - Optional - The name to initialize with. Defaults to an empty string.
```

--------------------------------

### subscript(_:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/model/parameters-swift.class/subscript%28_%3A%29

Get index into the parameters.

```APIDOC
## subscript(_:)

### Description
Get index into the parameters.

### Signature
```swift
subscript(position: Int) -> Model.Parameters { get }
```
```

--------------------------------

### init(name:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/contiguous/init%28name%3A%29

Initializes a new instance with an optional name.

```APIDOC
## init(name:)

### Description
Initializes a new instance with an optional name.

### Signature
```swift
init(name: String = "")
```

### Parameters
#### Path Parameters
- **name** (String) - Optional - The name to initialize with. Defaults to an empty string.
```

--------------------------------

### init(_:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dynamicgraph/anytensor/init%28_%3A%29

Initializes an AnyTensor with a given DynamicGraph.AnyTensor.AnyTensor.

```APIDOC
## init(_:)

### Description
Initializes an `AnyTensor` with a provided `DynamicGraph.AnyTensor.AnyTensor`.

### Signature
```swift
required init(_ tensor: DynamicGraph.AnyTensor.AnyTensor)
```

### Parameters
- **tensor** (`DynamicGraph.AnyTensor.AnyTensor`) - The tensor to initialize the `AnyTensor` with.
```

--------------------------------

### size

Source: https://liuliu.github.io/s4nnc/documentation/nnc/model/parameters-swift.class/size

Get the byte size of parameters.

```APIDOC
## Instance Property

# size

Get the byte size of parameters.

```swift
var size: UInt64 { get }
```
```

--------------------------------

### init(_:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/mseloss/init%28_%3A%29

Initializes an MSELoss instance with a specified reduction operation.

```APIDOC
## init(_:)

### Description
Initializes an instance of `MSELoss`.

### Method
`init(_ reduceOp: MSELoss.ReduceOp = .mean)`

### Parameters
#### Path Parameters
- **reduceOp** (MSELoss.ReduceOp) - Optional - The reduction operation to apply to the loss. Defaults to `.mean`.
```

--------------------------------

### Count

Source: https://liuliu.github.io/s4nnc/documentation/nnc/model/parameters-swift.class/count

Get the total number of parameters.

```APIDOC
## Instance Property

### count

Get the total number of parameters.

```swift
var count: Int { get }
```
```

--------------------------------

### init(_:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/streamcontext/init%28_%3A%29

Creates a new stream context, specifying whether it operates on the CPU or GPU.

```APIDOC
## init(_:)

### Description
Create a new stream context.

### Parameters
#### Parameters
- **kind** (DeviceKind) - Required - Whether this stream context is on CPU or GPU.
```

--------------------------------

### posWeight

Source: https://liuliu.github.io/s4nnc/documentation/nnc/sigmoidbinarycrossentropyloss

The weight for positive examples in the loss calculation.

```APIDOC
## posWeight

### Description
Represents the weight applied to positive examples during the loss calculation. This can be used to handle class imbalance.

### Property
`var posWeight: Float`
```

--------------------------------

### init(beta:name:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/swish/init%28beta%3Aname%3A%29

Initializes the Swish module with optional beta and name parameters.

```APIDOC
## init(beta:name:)

### Description
Initializes the Swish module. Allows for setting a beta value and a name.

### Method
Initializer

### Parameters
#### Path Parameters
- **beta** (Float) - Optional - Defaults to 1. The beta value for initialization.
- **name** (String) - Optional - Defaults to "". The name for initialization.

### Request Example
```swift
init(beta: 0.5, name: "MySwishInstance")
```

### Response
#### Success Response (200)
Initializes the object.

#### Response Example
```swift
// No explicit response body documented, initialization is implicit.
```
```

--------------------------------

### offset(of:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dynamicgraph/group/offset%28of%3A%29

Calculates the distance between the start of the collection and the given index.

```APIDOC
## offset(of:) <a name="offset(of:)"></a>

### Description
Calculates the distance between the start of the collection and the given index.

### Method Signature
```swift
func offset(of i: Self.Index) -> Int
```

### Parameters
#### Path Parameters
- **i** (Self.Index) - The index for which to calculate the offset.

### Return Value
An `Int` representing the offset of the index from the beginning of the collection.
```

--------------------------------

### rawValue

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dynamicgraph/tensor/rawvalue

Get the underlying tensor. If not available, create one.

```APIDOC
## rawValue

### Description
Get the underlying tensor. If not available, create one.

### Signature
```swift
var rawValue: Tensor<Element> { get }
```
```

--------------------------------

### init(name:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/max/init%28name%3A%29

Initializes the nnc/max module with an optional name.

```APIDOC
## init(name:)

### Description
Initializes the nnc/max module. An optional name can be provided during initialization.

### Method Signature
```swift
init(name: String = "")
```

### Parameters
#### Parameters
- **name** (String) - Optional - The name to initialize the module with. Defaults to an empty string.
```

--------------------------------

### maxConcurrency

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dynamicgraph/maxconcurrency

Allows you to get and set the maximum concurrency for a StreamContext.

```APIDOC
## maxConcurrency

### Description

This instance property allows you to retrieve or modify the maximum concurrency level for a `StreamContext`. Concurrency determines how many operations can run simultaneously.

### Property

`maxConcurrency`

### Type

`StreamContext.Concurrency`

### Access

`get set`
```

--------------------------------

### init(stride:border:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/hint/init%28stride%3Aborder%3A%29

Initializes a new instance with the specified stride and border.

```APIDOC
## init(stride:border:)

### Description
Initializes a new instance with the specified stride and border.

### Parameters
#### Path Parameters
- **stride** (Int) - Required - The stride value.
- **border** (Hint.Border) - Optional - The border value. Defaults to Border().
```

--------------------------------

### init(scalar:name:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/mul/init%28scalar%3Aname%3A%29

Initializes a new instance with optional scalar and name values.

```APIDOC
## init(scalar:name:)

### Description
Initializes a new instance with optional scalar and name values.

### Method
Initializer

### Parameters
#### Path Parameters
- **scalar** (Float) - Optional - Defaults to 1.
- **name** (String) - Optional - Defaults to "".

### Request Example
```swift
init(scalar: 1.5, name: "exampleName")
```

### Response
#### Success Response (200)
- **Instance** (Object) - A new instance of the object.

#### Response Example
```swift
// No specific response example provided for initializers in this format.
```
```

--------------------------------

### requiresGrad Property

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dynamicgraph/anytensor/requiresgrad

This property is inherited from `DynamicGraph_Any.requiresGrad` and can be get or set.

```APIDOC
## requiresGrad

### Description
Indicates whether a gradient is required for the dynamic graph computation. This property is inherited from `DynamicGraph_Any.requiresGrad`.

### Type
`Bool`

### Access
`get set`
```

--------------------------------

### init(_:begin:end:name:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/pad/init%28_%3Abegin%3Aend%3Aname%3A%29

Initializes a Pad object with specified mode, begin and end padding shapes, and an optional name.

```APIDOC
## init(_:begin:end:name:)

### Description
Initializes a Pad object.

### Parameters
#### Path Parameters
- **mode** (Pad.Mode) - Description: The padding mode to apply.
- **begin** (TensorShape) - Optional - Description: The shape of the padding to add at the beginning of each dimension.
- **end** (TensorShape) - Optional - Description: The shape of the padding to add at the end of each dimension.
- **name** (String) - Optional - Description: An optional name for the operation.
```

--------------------------------

### init(trim0:trim1:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/softmaxcrossentropyloss/init%28trim0%3Atrim1%3A%29

Initializes the SoftmaxCrossEntropyLoss with optional trim parameters.

```APIDOC
## init(trim0:trim1:)

### Description
Initializes the SoftmaxCrossEntropyLoss function. Allows for optional trimming of the loss calculation.

### Parameters
#### Path Parameters
- **trim0** (Float) - Optional - The lower bound for trimming the loss. Defaults to 0.
- **trim1** (Float) - Optional - The upper bound for trimming the loss. Defaults to 1.

### Method
Initializer

### Endpoint
N/A (SDK/Library method)

### Request Example
```swift
let loss = SoftmaxCrossEntropyLoss(trim0: 0.1, trim1: 0.9)
```

### Response
N/A (Initializer)
```

--------------------------------

### init(kth:axis:descending:name:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/partition/init%28kth%3Aaxis%3Adescending%3Aname%3A%29

Initializes a new instance with specified parameters for kth, axis, descending, and an optional name.

```APIDOC
## init(kth:axis:descending:name:)

### Description
Initializes a new instance with specified parameters for kth, axis, descending, and an optional name.

### Method
Initializer

### Parameters
#### Path Parameters
- **kth** (Int) - Required - The value for kth.
- **axis** (Int) - Required - The value for axis.
- **descending** (Bool) - Required - The value for descending.
- **name** (String) - Optional - The value for name. Defaults to "".
```

--------------------------------

### startIndex

Source: https://liuliu.github.io/s4nnc/documentation/nnc/tensorshape/startindex

Inherited from Collection.startIndex. This property returns the starting index of the TensorShape.

```APIDOC
## startIndex

### Description
Inherited from `Collection.startIndex`. This property returns the starting index of the TensorShape.

### Signature
```swift
var startIndex: TensorShape.Index { get }
```
```

--------------------------------

### init(reciprocal:name:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/div/init%28reciprocal%3Aname%3A%29

Initializes a new instance with optional reciprocal and name parameters.

```APIDOC
## init(reciprocal:name:)

### Description
Initializes a new instance with optional reciprocal and name parameters.

### Parameters
#### Path Parameters
- **reciprocal** (Bool) - Optional - Defaults to false. Indicates if reciprocal behavior is enabled.
- **name** (String) - Optional - Defaults to an empty string. The name to associate with the instance.

### Request Example
```swift
// Example usage:
let instance = YourClass.init(reciprocal: true, name: "ExampleName")
```

### Response
#### Success Response (200)
- **instance** (YourClass) - A newly initialized instance of the class.
```

--------------------------------

### init(logDecay:name:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/gateddelta/init%28logdecay%3Aname%3A%29

Initializes a new instance with specified log decay and name.

```APIDOC
## init(logDecay:name:)

### Description
Initializes a new instance with specified log decay and name.

### Parameters
#### Path Parameters
- **logDecay** (Bool) - Required - Specifies whether to use log decay.
- **name** (String) - Optional - The name for the instance. Defaults to an empty string.

### Request Example
```swift
init(logDecay: true, name: "exampleName")
```

### Response
#### Success Response (200)
Initializes the object.
```

--------------------------------

### Get GPU Count

Source: https://liuliu.github.io/s4nnc/documentation/nnc/devicekind/gpus/count

Returns the number of available GPU devices.

```APIDOC
## Get GPU Count

### Description
Returns the number of available GPU devices.

### Method
`static var count: Int { get }`

### Response
#### Success Response (Int)
- **count** (Int) - The number of available GPU devices.
```

--------------------------------

### DataFrame.count

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dataframe/count

Access the `count` property to get the number of rows in the DataFrame.

```APIDOC
## DataFrame.count

### Description
How many rows in the dataframe.

### Property
`count` (Int) - Read-only property that returns the number of rows.

### Usage
```swift
var count: Int { get }
```
```

--------------------------------

### init(_:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/bfloat16/init%28_%3A%29-572hp

Initializes a bfloat16 value from an integer.

```APIDOC
## init(_:)

### Description
Initializes a bfloat16 value from an integer.

### Signature
```swift
init(_ value: Int)
```

### Parameters
#### Path Parameters
- **value** (Int) - Required - The integer value to convert to bfloat16.
```

--------------------------------

### logLevel Property

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dynamicgraph/loglevel-swift.type.property

Allows you to get and set the log level on a dynamic graph.

```APIDOC
## logLevel

Set the log level on a dynamic graph.

```swift
static var logLevel: DynamicGraph.LogLevel { get set }
```
```

--------------------------------

### init(exponent:name:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/pow/init%28exponent%3Aname%3A%29

Initializes a new instance with the specified exponent and an optional name.

```APIDOC
## init(exponent:name:)

### Description
Initializes a new instance with the specified exponent and an optional name.

### Parameters
#### Path Parameters
- **exponent** (Float) - Required - The exponent value.
- **name** (String) - Optional - The name for the instance. Defaults to "".
```

--------------------------------

### init(_:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dataseriesiterator/init%28_%3A%29

Initializes a new instance of DataSeriesIterator with the provided data series.

```APIDOC
## init(_:)

### Description
Initializes a new instance of DataSeriesIterator with the provided data series.

### Signature
```swift
init(_ dataSeries: S)
```

### Parameters
- **dataSeries** (S) - The data series to be used by the iterator.
```

--------------------------------

### fread Case Example

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dynamicgraph/store/codec/datareadingoptions/fread

This snippet shows the basic case statement for fread.

```plaintext
case fread
```

--------------------------------

### init(_:kind:format:shape:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/tensor/init%28_%3Akind%3Aformat%3Ashape%3A%29

Initializes a Tensor from a sequence, specifying the device kind, tensor format, and shape.

```APIDOC
## init(_:kind:format:shape:)

### Description
Initializes a Tensor from a sequence, specifying the device kind, tensor format, and shape.

### Signature
```swift
init<S>( _ sequence: S, kind: DeviceKind, format: TensorFormat, shape: TensorShape) where Element == S.Element, S : Sequence
```

### Parameters
- **sequence**: The sequence of elements to initialize the tensor with.
- **kind**: The `DeviceKind` for the tensor (e.g., CPU, GPU).
- **format**: The `TensorFormat` (e.g., channels last, channels first).
- **shape**: The `TensorShape` of the tensor.
```

--------------------------------

### init(_:name:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/extract/init%28_%3Aname%3A%29

Initializes an object with an index and an optional name.

```APIDOC
## init(_:name:)

### Description
Initializes an object with a required integer index and an optional string name.

### Parameters
#### Path Parameters
- **index** (Int) - Required - The index for the object.
- **name** (String) - Optional - The name for the object. Defaults to an empty string.

### Method
Initializer

### Endpoint
N/A (SDK Method)

### Request Example
```swift
// Example usage:
let myObject = SomeObject(0, name: "Example")
let anotherObject = SomeObject(1)
```

### Response
N/A (Initializer)
```

--------------------------------

### suffix(from:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dynamicgraph/group/suffix%28from%3A%29

Returns a subsequence starting from the specified index. This method is inherited from the Collection protocol.

```APIDOC
## suffix(from:)

### Description
Returns a subsequence starting from the specified index.

### Signature
```swift
func suffix(from start: Self.Index) -> Self.SubSequence
```

### Parameters
#### Path Parameters
- **start** (Self.Index) - The starting index from which to create the subsequence.
```

--------------------------------

### init(name:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/min/init%28name%3A%29

Initializes the NNC module with an optional name.

```APIDOC
## init(name:)

### Description
Initializes the NNC module with an optional name.

### Signature
```swift
init(name: String = "")
```

### Parameters
#### Path Parameters
- **name** (String) - Optional - The name to initialize the module with. Defaults to an empty string.
```

--------------------------------

### startIndex Property

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dynamicgraph/group/startindex

The startIndex property returns the starting index of the group. It is inherited from the Collection.startIndex.

```APIDOC
## startIndex

### Description
Inherited from `Collection.startIndex`.

### Signature
```swift
var startIndex: DynamicGraph.Group<Element>.Index { get }
```

### Type
`DynamicGraph.Group<Element>.Index`
```

--------------------------------

### init(_:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/hint/border-swift.struct/init%28_%3A%29

Initializes a Border object with an array of integers.

```APIDOC
## init(_:)

### Description
Initializes a Border object with an array of integers.

### Parameters
#### Path Parameters
- **border** (Array<Int>) - Required - An array of integers representing the border.
```

--------------------------------

### Accessing Group Indices

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dynamicgraph/group/indices-swift.property

This property is inherited from RandomAccessCollection. Use it to get the indices of the group.

```swift
var indices: DynamicGraph.Group<Element>.Indices { get }
```

--------------------------------

### Accessing Tensor Shape

Source: https://liuliu.github.io/s4nnc/documentation/nnc/tensor/shape

The `shape` property allows you to get the dimensions of a tensor. It is inherited from `AnyTensor`.

```APIDOC
## Instance Property

# shape

Inherited from `AnyTensor.shape`.

```swift
var shape: TensorShape { get }
```

### Description

Retrieves the shape of the tensor.

### Type

`TensorShape`
```

--------------------------------

### init(name:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/identity/init%28name%3A%29

Initializes an object with an optional String parameter for the name.

```APIDOC
## init(name:)

### Description
Initializes an object with an optional name.

### Signature
```swift
init(name: String = "")
```

### Parameters
#### Path Parameters
- **name** (String) - Optional - The name to initialize the object with. Defaults to an empty string.
```

--------------------------------

### init(_:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/bfloat16/init%28_%3A%29-4fi1a

Initializes a bfloat16 value from a standard Float.

```APIDOC
## init(_:)

### Description
Initializes a bfloat16 value from a standard Float.

### Method
Initializer

### Parameters
#### Path Parameters
- **value** (Float) - Description: The Float value to initialize the bfloat16 with.
```

--------------------------------

### scale

Source: https://liuliu.github.io/s4nnc/documentation/nnc/optimizer/scale

The `scale` property is a Float that allows you to get and set a scaling factor. It is a required property.

```APIDOC
## scale

### Description
Represents a scaling factor as a Float value.

### Property
- **scale** (Float) - Required - Can be read and set.
```

--------------------------------

### AnyTensor Initializers

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dynamicgraph/anytensor

Initializes a new AnyTensor instance.

```APIDOC
## init(DynamicGraph.AnyTensor.AnyTensor)

### Description
Initializes a new AnyTensor instance.

### Parameters
None explicitly documented for this initializer signature.
```

--------------------------------

### Access Parameters with Instance Subscript

Source: https://liuliu.github.io/s4nnc/documentation/nnc/model/parameters-swift.class/subscript%28_%3A%29

Use this subscript to get an index into the parameters of a Model.Parameters object.

```swift
subscript(position: Int) -> Model.Parameters { get }
```

--------------------------------

### init(name:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/cmul/init%28name%3A%29

Initializes an object with an optional name. The name parameter defaults to an empty string if not provided.

```APIDOC
## init(name:)

### Description
Initializes an object with an optional name parameter.

### Signature
```swift
init(name: String = "")
```

### Parameters
#### name
- **name** (String) - Optional - The name to initialize the object with. Defaults to an empty string.
```

--------------------------------

### init(name:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/cos/init%28name%3A%29

Initializes an object with an optional name. The name parameter defaults to an empty string if not provided.

```APIDOC
## init(name:)

### Description
Initializes an object with an optional name parameter. If no name is provided, it defaults to an empty string.

### Signature
```swift
init(name: String = "")
```

### Parameters
#### Path Parameters
- **name** (String) - Optional - The name to initialize the object with. Defaults to "".
```

--------------------------------

### Accessing Raw Tensor Value

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dynamicgraph/tensor/rawvalue

Use this property to get the underlying tensor. If the tensor is not available, it will be created.

```swift
var rawValue: Tensor<Element> { get }
```

--------------------------------

### init(bitPattern:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/bfloat16/init%28bitpattern%3A%29

Initializes a BFloat16 value from a given 16-bit unsigned integer pattern.

```APIDOC
## init(bitPattern:)

### Description
Initializes a BFloat16 value from a given 16-bit unsigned integer pattern.

### Method
Initializer

### Parameters
#### Path Parameters
- **bitPattern** (UInt16) - Description: The 16-bit unsigned integer representing the BFloat16 value.
```

--------------------------------

### subscript(_:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dynamicgraph/group/subscript%28_%3A%29-9mvo7

Provides subscript access to the instance, allowing for setting and getting values within a specified range.

```APIDOC
## subscript(_:)

### Description
Provides subscript access to the instance, allowing for setting and getting values within a specified range.

### Method
`subscript(range: (UnboundedRange_) -> ()) -> Self`

### Parameters
#### Path Parameters
- **range** ((UnboundedRange_) -> ()) - Required - The range to access.
```

--------------------------------

### subscript(_:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dynamicgraph/group/subscript%28_%3A%29-9xz3y

Provides access to elements within specified ranges. This method can be used for both getting and setting values.

```APIDOC
## subscript(_:)

### Description
Allows for subscripting using a collection of integer ranges. This operation supports both reading and writing values within the specified ranges.

### Method
`subscript(ranges: [Range<Int>]) -> Self` (get set)

### Parameters
#### Path Parameters
- **ranges** (`[Range<Int>]`) - Description not available in source.
```

--------------------------------

### init(_:_:initBound:trainable:name:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/parameter/init%28_%3A_%3Ainitbound%3Atrainable%3Aname%3A%29

Initializes an object with the specified device kind, tensor shape format, initialization bounds, trainability, and name.

```APIDOC
## init(_:_:initBound:trainable:name:)

### Description
Initializes an object with the specified device kind, tensor shape format, initialization bounds, trainability, and name.

### Parameters
- **kind** (DeviceKind) - The kind of device to use.
- **dimensionFormat** (TensorShapeFormat) - The format of the tensor shape.
- **initBound** (Float) - Optional. The initialization bound, defaults to 0.
- **trainable** (Bool?) - Optional. Whether the object is trainable.
- **name** (String) - Optional. The name of the object, defaults to an empty string.
```

--------------------------------

### Partition Initializer

Source: https://liuliu.github.io/s4nnc/documentation/nnc/partition

Initializes a new Partition object.

```APIDOC
## `init(kth: Int, axis: Int, descending: Bool, name: String)`

### Description
Initializes a Partition object with the specified parameters.

### Parameters
- **kth** (Int) - Description of kth parameter.
- **axis** (Int) - Description of axis parameter.
- **descending** (Bool) - Description of descending parameter.
- **name** (String) - Description of name parameter.
```

--------------------------------

### Get Collection Count

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dynamicgraph/group/count

Access the 'count' property to retrieve the number of items in a collection. This property is read-only.

```swift
var count: Int { get }
```

--------------------------------

### Get Runtime Memory Size

Source: https://liuliu.github.io/s4nnc/documentation/nnc/anymodel/runtimememorysize

Access the size of scratch memory allocated for the model. This is a required property.

```swift
var runtimeMemorySize: UInt64 { get }
```

--------------------------------

### OptionSet Instance Methods

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dynamicgraph/enablebits/optionset-implementations

Provides documentation for various instance methods available on OptionSet types.

```APIDOC
## Instance Methods

`func contains(Self) -> Bool`
Available when `Self` is `Self.Element`.

`func formIntersection(Self)`
Available when `RawValue` conforms to `FixedWidthInteger`.

`func formSymmetricDifference(Self)`
Available when `RawValue` conforms to `FixedWidthInteger`.

`func formUnion(Self)`
Available when `RawValue` conforms to `FixedWidthInteger`.

`func insert(Self.Element) -> (inserted: Bool, memberAfterInsert: Self.Element)`
Available when `Self` is `Self.Element`.

`func intersection(Self) -> Self`

`func remove(Self.Element) -> Self.Element?`
Available when `Self` is `Self.Element`.

`func symmetricDifference(Self) -> Self`

`func union(Self) -> Self`

`func update(with: Self.Element) -> Self.Element?`
Available when `Self` is `Self.Element`.
```

--------------------------------

### init(_:format:shape:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/tensor/init%28_%3Aformat%3Ashape%3A%29

Initializes a tensor with a specific device kind, format, and shape.

```APIDOC
## init(_:format:shape:)

### Description
Initializes a tensor with the specified device kind, tensor format, and tensor shape.

### Method
`init`

### Parameters
- **kind** (`DeviceKind`) - The kind of device to use for the tensor.
- **format** (`TensorFormat`) - The format of the tensor.
- **shape** (`TensorShape`) - The shape of the tensor.

### Request Example
```swift
let tensor = Tensor(DeviceKind.cpu, format: .nhwc, shape: TensorShape(1, 224, 224, 3))
```

### Response
This is an initializer, it does not return a value directly but creates an instance of the tensor.
```

--------------------------------

### starts(with:by:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dynamicgraph/group/starts%28with%3Aby%3A%29

Checks if the sequence begins with the elements of a `possiblePrefix` sequence, using the provided `areEquivalent` closure to compare elements.

```APIDOC
## starts(with:by:)

### Description
Checks if the sequence begins with the elements of a `possiblePrefix` sequence, using the provided `areEquivalent` closure to compare elements. This method is inherited from `Sequence`.

### Signature
```swift
func starts<PossiblePrefix>(with possiblePrefix: PossiblePrefix, by areEquivalent: (Self.Element, PossiblePrefix.Element) throws -> Bool) rethrows -> Bool where PossiblePrefix : Sequence
```

### Parameters
#### Path Parameters
- **possiblePrefix** (PossiblePrefix : Sequence) - The sequence to check as a prefix.
- **areEquivalent** ((Self.Element, PossiblePrefix.Element) throws -> Bool) - A closure that returns `true` if two elements are considered equivalent, `false` otherwise.

### Returns
- **Bool** - `true` if the sequence starts with the `possiblePrefix`, `false` otherwise.
```

--------------------------------

### subscript(_:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/tensor/subscript%28_%3A%29-62cld

Provides access to elements of an instance using a variadic integer index. It supports both getting and setting elements.

```APIDOC
## subscript(_:)

### Description
Allows access to elements of an instance using a variadic integer index. This subscript can be used to get or set elements.

### Signature
```swift
subscript(indices: Int...) -> Element { get set }
```

### Parameters
#### Path Parameters
- **indices** (Int...) - Required - A variadic list of integers representing the index path to the element.

### Return Value
- **Element** - The element at the specified index path, or the type that will be set at the specified index path.
```

--------------------------------

### Parameter Initializers

Source: https://liuliu.github.io/s4nnc/documentation/nnc/parameter

Provides details on the available initializers for the Parameter class, allowing for flexible creation with various device, shape, and training configurations.

```APIDOC
## Initializers

### `init(DeviceKind, TensorShapeFormat, initBound: Float, trainable: Bool?, name: String)`

Initializes a Parameter with a specified device kind, tensor shape format, initial bound, and optional training and name parameters.

### `init(DeviceKind, format: TensorFormat, shape: TensorShape, initBound: Float, trainable: Bool?, name: String)`

Initializes a Parameter with a specified device kind, tensor format, shape, initial bound, and optional training and name parameters.
```

--------------------------------

### Get Parameter Byte Size

Source: https://liuliu.github.io/s4nnc/documentation/nnc/model/parameters-swift.class/size

Access the `size` property to retrieve the byte size of the parameters. This is a read-only property.

```swift
var size: UInt64 { get }
```

--------------------------------

### subscript(_:streamContext:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dynamicgraph_tensorgroup/subscript%28_%3Astreamcontext%3A%29-84pms

This method allows you to get or set values using a range of indices and an optional stream context.

```APIDOC
## subscript(_:streamContext:)

### Description
Allows for subscripting with a list of ranges and an optional stream context.

### Method
`get set`

### Parameters
#### Path Parameters
- **ranges** ([Range<Int>]) - Required - A list of integer ranges.
- **streamContext** (StreamContext?) - Optional - The stream context to use.

### Response
#### Success Response (200)
- **Self** - Returns an instance of `Self`.
```

--------------------------------

### Model Initialization with IO

Source: https://liuliu.github.io/s4nnc/documentation/nnc/model

Allows composing a new model from existing models by applying IO operations. Requires a list of input and output models, and optionally a trainable flag and name.

```swift
convenience init([Model.IO], [Model.IO], trainable: Bool?, name: String)
```

--------------------------------

### init(begin:end:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/hint/border-swift.struct/init%28begin%3Aend%3A%29

Initializes a Border struct with an array of integers for the begin and end points.

```APIDOC
## init(begin:end:)

### Description
Initializes a Border struct with the specified begin and end points.

### Parameters
#### Path Parameters
- **begin** ([Int]) - Description of the begin parameter
- **end** ([Int]) - Description of the end parameter

### Method
Initializer

### Endpoint
N/A (Swift struct initializer)

### Request Example
```swift
let border = Border(begin: [1, 2, 3], end: [4, 5, 6])
```

### Response
N/A (Initializes a struct instance)
```

--------------------------------

### Instance Subscript

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dynamicgraph_tensorgroup/subscript%28_%3A_%3A_%3A%29-4req6

Provides access to elements using integer indices and a range. Supports both getting and setting values.

```APIDOC
## subscript(_:_:_:)

### Description
Allows for subscripting an instance using two integer indices and a `Range<Int>`.

### Method
`subscript(i0: Int, i1: Int, range: Range<Int>) -> Self { get set }`

### Parameters
- **i0** (Int) - The first integer index.
- **i1** (Int) - The second integer index.
- **range** (Range<Int>) - The range of integers to specify the elements.

### Returns
`Self` - The instance itself, allowing for get and set operations.
```

--------------------------------

### init(scale:isCausal:hasAttentionMask:isVariableLength:maxSequenceLength:flags:multiHeadOutputProjectionFused:noBias:trainable:name:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/scaleddotproductattention/init%28scale%3Aiscausal%3Ahasattentionmask%3Aisvariablelength%3Amaxsequencelength%3Aflags%3Amultiheadoutputprojectionfused%3Anobias%3Atrainable%3Aname%3A%29

Initializes the Scaled Dot-Product Attention module with various configuration options.

```APIDOC
## init(scale:isCausal:hasAttentionMask:isVariableLength:maxSequenceLength:flags:multiHeadOutputProjectionFused:noBias:trainable:name:)

### Description
Initializes the Scaled Dot-Product Attention module. This function allows for fine-grained control over the attention mechanism's behavior, including its causal nature, use of attention masks, handling of variable sequence lengths, and output projection.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **scale** (Float) - Required - The scaling factor for the attention scores.
- **isCausal** (Bool) - Optional - Defaults to `false`. If true, enables causal attention (e.g., for autoregressive models).
- **hasAttentionMask** (Bool) - Optional - Defaults to `false`. If true, indicates that an attention mask will be provided.
- **isVariableLength** (Bool) - Optional - Defaults to `false`. If true, the module can handle sequences of varying lengths.
- **maxSequenceLength** (Int, Int)? - Optional - Defaults to `nil`. Specifies the maximum sequence lengths for query and key-value pairs.
- **flags** (Functional.GEMMFlag) - Optional - Defaults to `[]`. Flags to control underlying operations, potentially for performance optimizations.
- **multiHeadOutputProjectionFused** (Bool) - Optional - Defaults to `false`. If true, fuses the multi-head attention output projection.
- **noBias** (Bool) - Optional - Defaults to `false`. If true, disables bias in the projection layers.
- **trainable** (Bool)? - Optional - Defaults to `nil`. Determines if the module's parameters are trainable.
- **name** (String) - Optional - Defaults to `""`. The name of the module.
```

--------------------------------

### Get DataFrame Row Count

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dataframe

Returns the total number of rows in the DataFrame. Essential for understanding the size of your dataset.

```swift
var count: Int
```

--------------------------------

### init(_:nesterov:rate:scale:decay:momentum:dampening:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/sgdoptimizer/init%28_%3Anesterov%3Arate%3Ascale%3Adecay%3Amomentum%3Adampening%3A%29

Initializes the SGD optimizer with a dynamic graph and specific optimization parameters.

```APIDOC
## init(_:nesterov:rate:scale:decay:momentum:dampening:)

### Description
Initializes the Stochastic Gradient Descent (SGD) optimizer. This method requires a `DynamicGraph` object and several floating-point and boolean parameters to configure the optimization process.

### Parameters
- **graph** (DynamicGraph) - The dynamic graph to associate with the optimizer.
- **nesterov** (Bool) - Whether to use Nesterov momentum.
- **rate** (Float) - The learning rate for the optimizer.
- **scale** (Float) - A scaling factor for the gradients.
- **decay** (Float) - The decay rate for the learning rate.
- **momentum** (Float) - The momentum factor.
- **dampening** (Float) - The dampening factor for momentum.
```

--------------------------------

### NCHW Case Example

Source: https://liuliu.github.io/s4nnc/documentation/nnc/tensorformat/nchw

This snippet demonstrates the use of the NCHW case. It is typically used to specify the tensor format.

```plaintext
case NCHW
```

--------------------------------

### AnyTensor init(from:) Initializer

Source: https://liuliu.github.io/s4nnc/documentation/nnc/anytensor/init%28from%3A%29

Use this initializer to create a new AnyTensor instance from an existing AnyTensor. This is a required initializer.

```swift
init(from: any AnyTensor)
```

--------------------------------

### add(dependencies: [Model.IO])

Source: https://liuliu.github.io/s4nnc/documentation/nnc/model/io

Adds non-functional dependencies between IOs. This is useful to enforce system to share memory for example.

```APIDOC
## Instance Methods

### `func add(dependencies: [Model.IO])`

Add non-functional dependencies between IOs. Normally, dependencies are inferred by usage. However, in some cases you want to hack the dependency such that two unrelated ops can establish a dependency. This is useful to enforce system to share memory for example.
```

--------------------------------

### Explicitly Vacuum the Database

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dynamicgraph/store/vacuum%28%29

Call this method to perform an explicit database vacuum operation. No setup or imports are required.

```go
func vacuum() {
}
```

--------------------------------

### init(indices:name:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/permute/init%28indices%3Aname%3A%29

Initializes a new instance with the specified indices and an optional name.

```APIDOC
## init(indices:name:)

### Description
Initializes a new instance with the specified indices and an optional name.

### Signature
```swift
init(
    indices: [Int],
    name: String = ""
)
```

### Parameters
#### Parameters
- **indices** (`[Int]`) - Required - The array of indices.
- **name** (`String`) - Optional - The name for the instance. Defaults to an empty string.
```

--------------------------------

### starts(with:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/tensorshape/starts%28with%3A%29

Determines if the TensorShape begins with the elements of a given sequence. This method is available when the element type of the TensorShape conforms to `Equatable`.

```APIDOC
## starts(with:)

### Description
Checks if the TensorShape starts with the elements of a given sequence.

### Method Signature
```swift
func starts<PossiblePrefix>(with possiblePrefix: PossiblePrefix) -> Bool where PossiblePrefix : Sequence, Self.Element == PossiblePrefix.Element
```

### Constraints
Available when `Element` conforms to `Equatable`.

### Parameters
#### `possiblePrefix`
- **Type**: `PossiblePrefix` (a `Sequence` whose elements are comparable to `Self.Element`)
- **Description**: The sequence to check if it is a prefix of the TensorShape.

### Returns
- **Type**: `Bool`
- **Description**: `true` if the TensorShape starts with the `possiblePrefix`, `false` otherwise.
```

--------------------------------

### init(beta:scale:name:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/swishmul/init%28beta%3Ascale%3Aname%3A%29

Initializes the SwishMul component with optional beta, scale, and name parameters. Beta and scale control scaling factors, while name provides an identifier.

```APIDOC
## init(beta:scale:name:)

### Description
Initializes the SwishMul component with optional beta, scale, and name parameters. Beta and scale control scaling factors, while name provides an identifier.

### Method
Initializer

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **beta** (Float) - Optional - Default value is 1. Controls a scaling factor.
- **scale** (Float) - Optional - Default value is 1. Controls another scaling factor.
- **name** (String) - Optional - Default value is "". Provides an identifier for the component.
```

--------------------------------

### init(name:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/squareroot/init%28name%3A%29

Initializes the square root operation with an optional name.

```APIDOC
## init(name:)

### Description
Initializes the square root operation. An optional name can be provided.

### Signature
```swift
init(name: String = "")
```

### Parameters
#### Path Parameters
- **name** (String) - Optional - The name for the square root operation.
```

--------------------------------

### Border Swift Initializer

Source: https://liuliu.github.io/s4nnc/documentation/nnc/hint/border-swift.struct/init%28begin%3Aend%3A%29

Initializes a Border Swift struct with start and end points. Use this to define the boundaries of a border.

```swift
init(
    begin: [Int],
    end: [Int]
)
```

--------------------------------

### init(_:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dynamicgraph/group/init%28_%3A%29-9wli0

Initializes a new instance with the provided elements. This initializer is part of the dynamic graph group functionality.

```APIDOC
## init(_:)

### Description
Initializes a new instance with the provided elements.

### Signature
```swift
init(_ elements: Element...)
```
```

--------------------------------

### Accessing Execution Node Flags

Source: https://liuliu.github.io/s4nnc/documentation/nnc/model/flags

This property allows you to get and set the flags for the underlying execution node. It is of type Model.EnableBits.

```swift
var flags: Model.EnableBits { get set }
```

--------------------------------

### subscript(_:streamContext:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dynamicgraph_tensorgroup/subscript%28_%3Astreamcontext%3A%29-fhcw

This method allows for subscripting an instance with a range and an optional stream context. It supports both getting and setting values.

```APIDOC
## subscript(_:streamContext:)

### Description
Allows subscripting an instance with a specified range and an optional stream context.

### Method
`subscript(range: Range<Int>, streamContext streamContext: StreamContext?) -> Self { get set }`

### Parameters
#### Path Parameters
- **range** (Range<Int>) - Required - The range of integers to subscript.
- **streamContext** (StreamContext?) - Optional - The stream context to use for the operation.

### Response
#### Success Response (Self)
Returns the instance itself, allowing for chaining or modification.

### Request Example
```swift
// Example of getting a value
let value = instance[0..<5, streamContext: myContext]

// Example of setting a value
instance[0..<5, streamContext: myContext] = newValue
```

### Response Example
```swift
// For get operation, returns the instance or a subset depending on implementation
// For set operation, the instance is modified in place
```
```

--------------------------------

### init(_:_:name:)

Source: https://liuliu.github.io/s4nnc/documentation/nnc/transpose/init%28_%3A_%3Aname%3A%29

Initializes a transpose operation with two axes and an optional name.

```APIDOC
## init(_:_:name:)

### Description
Initializes a transpose operation with two specified axes and an optional name.

### Parameters
#### Path Parameters
- **axisA** (Int) - Required - The first axis for the transpose operation.
- **axisB** (Int) - Required - The second axis for the transpose operation.

#### Query Parameters
- **name** (String) - Optional - A name for the transpose operation. Defaults to an empty string.
```

--------------------------------

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

Source: https://liuliu.github.io/s4nnc/documentation/nnc/dynamicgraph_tensorgroup/subscript%28_%3A_%3A_%3Astreamcontext%3A%29-1a6se

Allows getting and setting instance properties using integer indices and a range within a specified StreamContext.

```APIDOC
## subscript(_:_:_:streamContext:)

### Description
Allows getting and setting instance properties using integer indices and a range within a specified StreamContext.

### Method
`get set`

### Parameters
#### Path Parameters
- **i0** (Int) - Required - The first integer index.
- **i1** (Int) - Required - The second integer index.
- **range** (Range<Int>) - Required - The range of integers.
- **streamContext** (StreamContext?) - Optional - The stream context for the operation.
```
Tokens:
Raw