NN::NeuralNet Class Reference

Abstract base class for neural networks. More...

#include <NeuralNet.h>

Inheritance diagram for NN::NeuralNet:

Public Member Functions
virtual tl::expected< std::vector< Tensor >, NeuralError >	infer (const Tensor &input)=0
	Perform inference on the given input tensor.
tl::expected< std::vector< Tensor >, NeuralError >	operator() (const Tensor &input)
	Call the infer method with the given input tensor.
virtual size_t	inputCount () const =0
	Get the number of inputs of the neural network.
virtual size_t	outputCount () const =0
	Get the number of outputs of the neural network.
virtual Shape	inputShape (size_t idx=0) const =0
	Get the input shape of the neural network. This might contain dynamic dimensions (e.g., -1 for batch size).
virtual Shape	outputShape (size_t idx=0) const =0
	Get the output shape of the neural network. This might contain dynamic dimensions (e.g., -1 for batch size).
virtual std::string	inputName (size_t idx=0) const =0
	Get the name of the input tensor.
virtual std::string	outputName (size_t idx=0) const =0
	Get the name of the output tensor.
virtual int	gpuId () const =0
	Get the GPU ID used by the neural network if it is configured to use GPU.

Detailed Description

Abstract base class for neural networks.

This class defines the interface for neural networks, including methods for inference, input/output shape queries, and operator overloading for convenience.

See also

NeuralNetPtr for a smart pointer alias to this class.

Member Function Documentation

gpuId()

virtual int NN::NeuralNet::gpuId ( ) const

pure virtual

Get the GPU ID used by the neural network if it is configured to use GPU.

Returns

int The GPU ID, or -1 if the neural network does not use GPU.

This method returns the ID of the GPU that the neural network uses for inference. If the neural network is not using GPU, it returns -1.

Implemented in NN::OrtNeuralNet.

infer()

virtual tl::expected< std::vector< Tensor >, NeuralError > NN::NeuralNet::infer ( const Tensor &  input )

pure virtual

Perform inference on the given input tensor.

Parameters

input

The input tensor to the neural network. This tensor must have the correct shape and data type expected by the model.

Returns

tl::expected<std::vector<Tensor>, NeuralError> The output tensors or an error object.

This method takes an input tensor, processes it through the neural network, and returns the output tensors. The input tensor must match the expected input shape of the model. If the input tensor is invalid or the inference fails, an error object is returned.

Implemented in NN::OrtNeuralNet.

inputCount()

virtual size_t NN::NeuralNet::inputCount ( ) const

pure virtual

Get the number of inputs of the neural network.

Returns

size_t The number of inputs.

Implemented in NN::OrtNeuralNet.

inputName()

virtual std::string NN::NeuralNet::inputName ( size_t  idx = 0 ) const

pure virtual

Get the name of the input tensor.

Parameters

idx	The index of the input to query (default is 0). Valid indices are in the range [0, inputCount()).

Returns

std::string The name of the input tensor.

Implemented in NN::OrtNeuralNet.

inputShape()

virtual Shape NN::NeuralNet::inputShape ( size_t  idx = 0 ) const

pure virtual

Get the input shape of the neural network. This might contain dynamic dimensions (e.g., -1 for batch size).

Parameters

idx	The index of the input to query (default is 0). Valid indices are in the range [0, inputCount()).

Returns

Shape The input shape of the neural network.

Implemented in NN::OrtNeuralNet.

operator()()

tl::expected< std::vector< Tensor >, NeuralError > NN::NeuralNet::operator() ( const Tensor &  input )

inline

Call the infer method with the given input tensor.

Parameters

input

The input tensor to the neural network.

Returns

tl::expected<std::vector<Tensor>, NeuralError> The output tensors or an error object.

See also

infer(const Tensor& input) for more details.

outputCount()

virtual size_t NN::NeuralNet::outputCount ( ) const

pure virtual

Get the number of outputs of the neural network.

Returns

size_t The number of outputs.

Implemented in NN::OrtNeuralNet.

outputName()

virtual std::string NN::NeuralNet::outputName ( size_t  idx = 0 ) const

pure virtual

Get the name of the output tensor.

Parameters

idx	The index of the output to query (default is 0). Valid indices are in the range [0, outputCount()).

Returns

std::string The name of the output tensor.

Implemented in NN::OrtNeuralNet.

outputShape()

virtual Shape NN::NeuralNet::outputShape ( size_t  idx = 0 ) const

pure virtual

Get the output shape of the neural network. This might contain dynamic dimensions (e.g., -1 for batch size).

Parameters

idx	The index of the output to query (default is 0). Valid indices are in the range [0, outputCount()).

Returns

Shape The output shape of the neural network.

Implemented in NN::OrtNeuralNet.

---

The documentation for this class was generated from the following file:

• iVS3D/src/iVS3D-neuralNet/include/NeuralNet.h