Layer output is non deterministic, i.e. may be different each time the layer is run e.g. Layers which use random number generation such as RandomUniform, Bernoulli, Multinomial These layers will not have outputs precalculated at import time for optimization passes

PixelShaderSingleton

Represents the compute kernel cache for backends that use GPU pixel shaders.

Random

Represents a pseudo-random number generator used by Sentis.

Tensor

Represents data in a multidimensional array-like structure.

Ownership and lifetime:

Disposed needs to be called on the main thread.
Ownership is always to the owner of the object.

Data Representation:

TensorShape represents the data layout of the tensor
Data is held by a tensorData (ITensorData) which can be on a given backend
Data is stored in a flattened row major format
Data can be pending (ie computation is being done in parallel)
- call CompleteAllPendingOperations for a blocking call to finish computing the tensor's data
- call CompleteOperationsAndDownloadAsync/ReadbackRequest for a non blocking call to finish computing the tensor's data Data can be in a non readable type (GPU/NPU)
- Call CompleteOperationsAndDownload to make the tensor readable (this will fetch the data on the backend and convert it to a readable format)
- CompleteOperationsAndDownload is a blocking call if called on its own. for a non blocking call, make sure that CompleteOperationsAndDownloadAsync/ReadbackRequest have been called previously you can check that with IsReadbackRequestDone

Data manipulation

ToReadOnlyArray returns a copy of the tensor's data
dataOnBackend can be manipulated directly to avoid a unnecessary copy see ComputeTensorData/BurstTensorData for info

TensorByte

Represents data in a multidimensional array-like structure.

Ownership and lifetime:

Disposed needs to be called on the main thread.
Ownership is always to the owner of the object.

Data Representation:

TensorShape represents the data layout of the tensor
Data is held by a tensorData (ITensorData) which can be on a given backend
Data is stored in a flattened row major format
Data can be pending (ie computation is being done in parallel)
- call CompleteAllPendingOperations for a blocking call to finish computing the tensor's data
- call CompleteOperationsAndDownloadAsync/ReadbackRequest for a non blocking call to finish computing the tensor's data Data can be in a non readable type (GPU/NPU)
- Call CompleteOperationsAndDownload to make the tensor readable (this will fetch the data on the backend and convert it to a readable format)
- CompleteOperationsAndDownload is a blocking call if called on its own. for a non blocking call, make sure that CompleteOperationsAndDownloadAsync/ReadbackRequest have been called previously you can check that with IsReadbackRequestDone

Data manipulation

ToReadOnlyArray returns a copy of the tensor's data
dataOnBackend can be manipulated directly to avoid a unnecessary copy see ComputeTensorData/BurstTensorData for info

TensorExtensions

Provides extension methods for tensors.

TensorFloat

Represents data in a multidimensional array-like structure.

Ownership and lifetime:

Disposed needs to be called on the main thread.
Ownership is always to the owner of the object.

Data Representation:

TensorShape represents the data layout of the tensor
Data is held by a tensorData (ITensorData) which can be on a given backend
Data is stored in a flattened row major format
Data can be pending (ie computation is being done in parallel)
- call CompleteAllPendingOperations for a blocking call to finish computing the tensor's data
- call CompleteOperationsAndDownloadAsync/ReadbackRequest for a non blocking call to finish computing the tensor's data Data can be in a non readable type (GPU/NPU)
- Call CompleteOperationsAndDownload to make the tensor readable (this will fetch the data on the backend and convert it to a readable format)
- CompleteOperationsAndDownload is a blocking call if called on its own. for a non blocking call, make sure that CompleteOperationsAndDownloadAsync/ReadbackRequest have been called previously you can check that with IsReadbackRequestDone

Data manipulation

ToReadOnlyArray returns a copy of the tensor's data
dataOnBackend can be manipulated directly to avoid a unnecessary copy see ComputeTensorData/BurstTensorData for info

TensorInt

Represents data in a multidimensional array-like structure.

Ownership and lifetime:

Disposed needs to be called on the main thread.
Ownership is always to the owner of the object.

Data Representation:

TensorShape represents the data layout of the tensor
Data is held by a tensorData (ITensorData) which can be on a given backend
Data is stored in a flattened row major format
Data can be pending (ie computation is being done in parallel)
- call CompleteAllPendingOperations for a blocking call to finish computing the tensor's data
- call CompleteOperationsAndDownloadAsync/ReadbackRequest for a non blocking call to finish computing the tensor's data Data can be in a non readable type (GPU/NPU)
- Call CompleteOperationsAndDownload to make the tensor readable (this will fetch the data on the backend and convert it to a readable format)
- CompleteOperationsAndDownload is a blocking call if called on its own. for a non blocking call, make sure that CompleteOperationsAndDownloadAsync/ReadbackRequest have been called previously you can check that with IsReadbackRequestDone

Data manipulation

ToReadOnlyArray returns a copy of the tensor's data
dataOnBackend can be manipulated directly to avoid a unnecessary copy see ComputeTensorData/BurstTensorData for info

TensorShort

Represents data in a multidimensional array-like structure.

Ownership and lifetime:

Disposed needs to be called on the main thread.
Ownership is always to the owner of the object.

Data Representation:

TensorShape represents the data layout of the tensor
Data is held by a tensorData (ITensorData) which can be on a given backend
Data is stored in a flattened row major format
Data can be pending (ie computation is being done in parallel)
- call CompleteAllPendingOperations for a blocking call to finish computing the tensor's data
- call CompleteOperationsAndDownloadAsync/ReadbackRequest for a non blocking call to finish computing the tensor's data Data can be in a non readable type (GPU/NPU)
- Call CompleteOperationsAndDownload to make the tensor readable (this will fetch the data on the backend and convert it to a readable format)
- CompleteOperationsAndDownload is a blocking call if called on its own. for a non blocking call, make sure that CompleteOperationsAndDownloadAsync/ReadbackRequest have been called previously you can check that with IsReadbackRequestDone

Data manipulation

ToReadOnlyArray returns a copy of the tensor's data
dataOnBackend can be manipulated directly to avoid a unnecessary copy see ComputeTensorData/BurstTensorData for info

TextureConverter

Provides methods for converting between textures and tensors.

TextureTensorData

Represents the data storage for a 'Tensor' as a render texture, for backends that use GPU pixel shaders.

Sentis packs the tensor data into the pixels of an RGBA float4 texture.

Sentis chooses a single tensor dimension as the blocked axis, across which data is chunked in float4 blocks.

Tensor dimensions don't map directly to texture dimensions. Sentis creates the texture with dimensions large enough to fit all the data and pixel shaders index the data based on both the tensor and texture dimensions (see example below).

WorkerExtensions

Provides extension methods for the IWorker interface.

WorkerFactory

Provides methods for instantiating workers and ops on given back ends.

Structs

ExecutionContext

Represents a context object that holds the model operations and variables for layer execution.

InputDef

Represents an input definition of a model at build time. This holds a data type and shape.

Model.Input

Represents an input to a model.

Model.Output

Represents an output to a model.

SymbolicTensorDim

Represents a single dimension of a SymbolicTensorShape.

SymbolicTensorShape

Represents the shape of an input tensor, or the predicted shape of a tensor before Sentis executes.

TensorIndex

Represents a set of indices corresponding to each axis of a tensor

TensorNDIterator

Represents a struct used to iterate over a TensorShape.

TensorShape

Represents the shape of a tensor.

TextureTransform

Represents settings for converting between textures and tensors.

Create an instance of TextureTransform using the constructor, then use the TextureTransform object as a parameter in TextureConverter methods.

For example: TextureTransform settings = new TextureTransform().SetDimensions(256, 256, 4).SetTensorLayout(TensorLayout.NHWC);

WorkerFactory.WorkerConfiguration

Represents the configuration for a WorkerFactory.

Specify inputs.
Schedule the work.
Get outputs.

Internally, IWorker translates the neural network from a Model into a set of operations, then sends the operations to the hardware device for asynchronous execution.

Use WorkerFactory.CreateWorker or Model.CreateWorker to create a new instance of a worker.

Namespace Unity.Sentis

Classes

Structs

Interfaces

Enums