#include <ITensorRegistry.h>

Collaboration diagram for onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >:

[legend]

Public Types
using	TrainingTensors = std::tuple< TrainableTensor , GradientTensor >

Public Member Functions
ITensor *	getITensor (const ir::OperandIndex &index) override
	Returns pointer of ITensor among native and migrant tensors.

ITensor *	getNativeITensor (const ir::OperandIndex &index) override
	Returns pointer of ITensor among native tensors.

ITensor *	getBackPropITensor (const ir::OperandIndex &index) override
	Returns pointer of ITensor for back propatation.

ITensor *	getGradientITensor (const ir::OperandIndex &index) override
	Returns pointer of ITensor for gradient.

void	iterateTrainableTensors (const std::function< void(const ir::OperandIndex &, const train::ITrainableTensor *)> &fn) const override
	Iterate ITrainableTensors with fn.

IPortableTensor *	getPortableTensor (const ir::OperandIndex &index)

Tensor *	getNonConstTensor (const ir::OperandIndex &index)

TrainableTensor *	getTrainableTensor (const ir::OperandIndex &index)

BackPropTensor *	getBackPropTensor (const ir::OperandIndex &index)

GradientTensor *	getGradientTensor (const ir::OperandIndex &index)

TrainingTensors	getTrainingTensors (const ir::OperandIndex &index)

bool	setMigrantTensor (const ir::OperandIndex &index, IPortableTensor *tensor) override
	Set the Migrant Tensor which are from other backends.

void	setNonConstTensor (const ir::OperandIndex &index, std::unique_ptr< Tensor > tensor)

void	setTrainableTensor (const ir::OperandIndex &index, std::unique_ptr< TrainableTensor > tensor)

void	setBackPropTensor (const ir::OperandIndex &index, std::unique_ptr< BackPropTensor > tensor)

void	setGradientTensor (const ir::OperandIndex &index, std::unique_ptr< GradientTensor > tensor)

const ir::OperandIndexMap< std::unique_ptr< TrainableTensor > > &	trainable_tensors ()

const ir::OperandIndexMap< std::unique_ptr< Tensor > > &	nonconst_tensors ()

const ir::OperandIndexMap< std::unique_ptr< Tensor > > &	back_prop_tensors ()

const ir::OperandIndexMap< std::unique_ptr< GradientTensor > > &	gradient_tensors ()

Public Member Functions inherited from onert::backend::ITensorRegistry
virtual	~ITensorRegistry ()=default
	Deconstruct itself.

Detailed Description

template<typename Tensor, typename TrainableTensor, typename BackPropTensor, typename GradientTensor>
class onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >

Definition at line 72 of file ITensorRegistry.h.

Member Typedef Documentation

◆ TrainingTensors

template<typename Tensor , typename TrainableTensor , typename BackPropTensor , typename GradientTensor >

using onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::TrainingTensors = std::tuple<TrainableTensor *, GradientTensor *>

Definition at line 75 of file ITensorRegistry.h.

Member Function Documentation

◆ back_prop_tensors()

template<typename Tensor , typename TrainableTensor , typename BackPropTensor , typename GradientTensor >

const ir::OperandIndexMap< std::unique_ptr< Tensor > > & onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::back_prop_tensors ( )

inline

Definition at line 229 of file ITensorRegistry.h.

229{ return _back_prop; }

◆ getBackPropITensor()

template<typename Tensor , typename TrainableTensor , typename BackPropTensor , typename GradientTensor >

ITensor * onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::getBackPropITensor ( const ir::OperandIndex & )

inlineoverridevirtual

Returns pointer of ITensor for back propatation.

Note: Return tensor cannot be used longer than dynamic tensor manager

Implements onert::backend::train::ITensorRegistry.

Definition at line 94 of file ITensorRegistry.h.

  {
    return getBackPropTensor(index);
  }

References onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::getBackPropTensor().

◆ getBackPropTensor()

template<typename Tensor , typename TrainableTensor , typename BackPropTensor , typename GradientTensor >

BackPropTensor * onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::getBackPropTensor ( const ir::OperandIndex & index )

inline

Definition at line 140 of file ITensorRegistry.h.

  {
    auto tensor = _back_prop.find(index);
    if (tensor != _back_prop.end())
      return tensor->second.get();
    return nullptr;
  }

Referenced by onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::getBackPropITensor().

◆ getGradientITensor()

template<typename Tensor , typename TrainableTensor , typename BackPropTensor , typename GradientTensor >

ITensor * onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::getGradientITensor ( const ir::OperandIndex & )

inlineoverridevirtual

Returns pointer of ITensor for gradient.

Note: Returned tensor cannot be used longer than dynamic tensor manager

Implements onert::backend::train::ITensorRegistry.

Definition at line 99 of file ITensorRegistry.h.

  {
    return getGradientTensor(index);
  }

References onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::getGradientTensor().

◆ getGradientTensor()

template<typename Tensor , typename TrainableTensor , typename BackPropTensor , typename GradientTensor >

GradientTensor * onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::getGradientTensor ( const ir::OperandIndex & index )

inline

Definition at line 148 of file ITensorRegistry.h.

  {
    auto tensor = _gradient.find(index);
    if (tensor != _gradient.end())
      return tensor->second.get();
    return nullptr;
  }

Referenced by onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::getGradientITensor(), and onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::getTrainingTensors().

◆ getITensor()

template<typename Tensor , typename TrainableTensor , typename BackPropTensor , typename GradientTensor >

ITensor * onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::getITensor ( const ir::OperandIndex & )

inlineoverridevirtual

Returns pointer of ITensor among native and migrant tensors.

Native Tensor is a tensor that is managed by this backend Migrant Tensor is a tensor that is imported from another backend

Note: Return tensor cannot be used longer than dynamic tensor manager

Implements onert::backend::ITensorRegistry.

Definition at line 78 of file ITensorRegistry.h.

  {
    auto _migrant_tensor = _migrant.find(index);
    if (_migrant_tensor != _migrant.end())
      return _migrant_tensor->second;
    return getNativeITensor(index);
  }

References onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::getNativeITensor().

Referenced by onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::setMigrantTensor(), onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::setNonConstTensor(), and onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::setTrainableTensor().

◆ getNativeITensor()

template<typename Tensor , typename TrainableTensor , typename BackPropTensor , typename GradientTensor >

ITensor * onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::getNativeITensor ( const ir::OperandIndex & )

inlineoverridevirtual

Returns pointer of ITensor among native tensors.

Unlike getITensor , this function only searches from native tensors

Note: Returned tensor cannot be used longer than dynamic tensor manager

Implements onert::backend::ITensorRegistry.

Definition at line 86 of file ITensorRegistry.h.

  {
    ITensor *tensor = getTrainableTensor(index);
    if (tensor == nullptr)
      tensor = getNonConstTensor(index);
    return tensor;
  }

References onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::getNonConstTensor(), and onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::getTrainableTensor().

Referenced by onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::getITensor().

◆ getNonConstTensor()

template<typename Tensor , typename TrainableTensor , typename BackPropTensor , typename GradientTensor >

Tensor * onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::getNonConstTensor ( const ir::OperandIndex & index )

inline

Definition at line 123 of file ITensorRegistry.h.

  {
    auto tensor = _non_const.find(index);
    if (tensor != _non_const.end())
      return tensor->second.get();
    return nullptr;
  }

Referenced by onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::getNativeITensor(), and onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::getPortableTensor().

◆ getPortableTensor()

template<typename Tensor , typename TrainableTensor , typename BackPropTensor , typename GradientTensor >

IPortableTensor * onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::getPortableTensor ( const ir::OperandIndex & index )

inline

Definition at line 112 of file ITensorRegistry.h.

  {
    auto tensor = _trainable.find(index);
    if (tensor != _trainable.end())
    {
      if (tensor->second)
        return tensor->second.get();
    }
    return getNonConstTensor(index);
  }

References onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::getNonConstTensor().

◆ getTrainableTensor()

template<typename Tensor , typename TrainableTensor , typename BackPropTensor , typename GradientTensor >

TrainableTensor * onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::getTrainableTensor ( const ir::OperandIndex & index )

inline

Definition at line 131 of file ITensorRegistry.h.

  {
    auto tensor = _trainable.find(index);
    if (tensor != _trainable.end())
      return tensor->second.get();
 
    return nullptr;
  }

Referenced by onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::getNativeITensor(), and onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::getTrainingTensors().

◆ getTrainingTensors()

template<typename Tensor , typename TrainableTensor , typename BackPropTensor , typename GradientTensor >

TrainingTensors onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::getTrainingTensors ( const ir::OperandIndex & index )

inline

Definition at line 156 of file ITensorRegistry.h.

  {
    auto trainable = getTrainableTensor(index);
    if (trainable == nullptr)
      throw std::runtime_error{
        "Tried to get a trainable tensor but the corresponding tensor does not exist."};
 
    auto gradient = getGradientTensor(index);
    if (gradient == nullptr)
      throw std::runtime_error{
        "Tried to get a gradient tensor but the corresponding tensor does not exist."};
 
    return TrainingTensors{std::make_pair(trainable, gradient)};
  }

References onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::getGradientTensor(), and onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::getTrainableTensor().

◆ gradient_tensors()

template<typename Tensor , typename TrainableTensor , typename BackPropTensor , typename GradientTensor >

const ir::OperandIndexMap< std::unique_ptr< GradientTensor > > & onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::gradient_tensors ( )

inline

Definition at line 230 of file ITensorRegistry.h.

  {
    return _gradient;
  }

◆ iterateTrainableTensors()

template<typename Tensor , typename TrainableTensor , typename BackPropTensor , typename GradientTensor >

void onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::iterateTrainableTensors ( const std::function< void(const ir::OperandIndex &, const train::ITrainableTensor *)> & ) const

inlineoverridevirtual

Iterate ITrainableTensors with fn.

Parameters

fn	function to be called with OperandIndex and a pointer to ITrainableTensor

Implements onert::backend::train::ITensorRegistry.

Definition at line 104 of file ITensorRegistry.h.

  {
    for (const auto &[index, tensor] : _trainable)
      fn(index, tensor.get());
  }

◆ nonconst_tensors()

template<typename Tensor , typename TrainableTensor , typename BackPropTensor , typename GradientTensor >

const ir::OperandIndexMap< std::unique_ptr< Tensor > > & onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::nonconst_tensors ( )

inline

Definition at line 228 of file ITensorRegistry.h.

228{ return _non_const; }

◆ setBackPropTensor()

template<typename Tensor , typename TrainableTensor , typename BackPropTensor , typename GradientTensor >

void onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::setBackPropTensor	(	const ir::OperandIndex &	index,
		std::unique_ptr< BackPropTensor >	tensor
	)

inline

Definition at line 202 of file ITensorRegistry.h.

  {
    assert(tensor != nullptr);
    auto itr = _back_prop.find(index);
    if (itr != _back_prop.end())
      throw std::runtime_error{"Tried to set a back propagation tensor but another back "
                               "propagation tensor already exists."};
 
    _back_prop[index] = std::move(tensor);
  }

◆ setGradientTensor()

template<typename Tensor , typename TrainableTensor , typename BackPropTensor , typename GradientTensor >

void onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::setGradientTensor	(	const ir::OperandIndex &	index,
		std::unique_ptr< GradientTensor >	tensor
	)

inline

Definition at line 213 of file ITensorRegistry.h.

  {
    assert(tensor != nullptr);
    auto itr = _gradient.find(index);
    if (itr != _gradient.end())
      throw std::runtime_error{
        "Tried to set a gradient tensor but another gradient tensor already exists."};
 
    _gradient[index] = std::move(tensor);
  }

◆ setMigrantTensor()

template<typename Tensor , typename TrainableTensor , typename BackPropTensor , typename GradientTensor >

bool onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::setMigrantTensor	(	const ir::OperandIndex &	,
		IPortableTensor *
	)

inlineoverridevirtual

Set the Migrant Tensor which are from other backends.

Returns: true if supported; false if not supported

Reimplemented from onert::backend::ITensorRegistry.

Definition at line 171 of file ITensorRegistry.h.

  {
    assert(tensor != nullptr);
    if (getITensor(index) != nullptr)
      throw std::runtime_error{
        "Tried to set a trainable tensor but another tensor already exists."};
 
    _migrant[index] = tensor;
    return true;
  }

References onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::getITensor().

◆ setNonConstTensor()

template<typename Tensor , typename TrainableTensor , typename BackPropTensor , typename GradientTensor >

void onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::setNonConstTensor	(	const ir::OperandIndex &	index,
		std::unique_ptr< Tensor >	tensor
	)

inline

Definition at line 182 of file ITensorRegistry.h.

  {
    assert(tensor != nullptr);
    if (getITensor(index) != nullptr)
      throw std::runtime_error{
        "Tried to set a trainable tensor but another tensor already exists."};
 
    _non_const[index] = std::move(tensor);
  }

References onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::getITensor().

◆ setTrainableTensor()

template<typename Tensor , typename TrainableTensor , typename BackPropTensor , typename GradientTensor >

void onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::setTrainableTensor	(	const ir::OperandIndex &	index,
		std::unique_ptr< TrainableTensor >	tensor
	)

inline

Definition at line 192 of file ITensorRegistry.h.

  {
    assert(tensor != nullptr);
    if (getITensor(index) != nullptr)
      throw std::runtime_error{
        "Tried to set a trainable tensor but another tensor already exists."};
 
    _trainable[index] = std::move(tensor);
  }

References onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::getITensor().

◆ trainable_tensors()

template<typename Tensor , typename TrainableTensor , typename BackPropTensor , typename GradientTensor >

const ir::OperandIndexMap< std::unique_ptr< TrainableTensor > > & onert::backend::train::PortableTensorRegistryTemplate< Tensor, TrainableTensor, BackPropTensor, GradientTensor >::trainable_tensors ( )

inline

Definition at line 224 of file ITensorRegistry.h.

  {
    return _trainable;
  }

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

runtime/onert/core/include/backend/train/ITensorRegistry.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ TrainingTensors

Member Function Documentation

◆ back_prop_tensors()

◆ getBackPropITensor()

◆ getBackPropTensor()

◆ getGradientITensor()

◆ getGradientTensor()

◆ getITensor()

◆ getNativeITensor()

◆ getNonConstTensor()

◆ getPortableTensor()

◆ getTrainableTensor()

◆ getTrainingTensors()

◆ gradient_tensors()

◆ iterateTrainableTensors()

◆ nonconst_tensors()

◆ setBackPropTensor()

◆ setGradientTensor()

◆ setMigrantTensor()

◆ setNonConstTensor()

◆ setTrainableTensor()

◆ trainable_tensors()