package.common.basesession.BaseSession Class Reference

Public Member Functions
	__init__ (self, backend_session=None)
	__getattr__ (self, name)
List[tensorinfo]	get_inputs_tensorinfo (self)
List[tensorinfo]	get_outputs_tensorinfo (self)
	set_inputs (self, size, inputs_array=[])

Data Fields
	session
	inputs
	outputs

Protected Member Functions
	_recreate_session (self, backend_session)
	_set_outputs (self, size)

Detailed Description

Base class providing common functionality for inference and training sessions.

Definition at line 16 of file basesession.py.

Constructor & Destructor Documentation

__init__()

package.common.basesession.BaseSession.__init__	(		self,
			backend_session = None
	)

Initialize the BaseSession with a backend session.
Args:
    backend_session: A backend-specific session object (e.g., nnfw_session).

Reimplemented in package.infer.session.session.

Definition at line 20 of file basesession.py.

    def __init__(self, backend_session=None):
        """
        Initialize the BaseSession with a backend session.
        Args:
            backend_session: A backend-specific session object (e.g., nnfw_session).
        """
        self.session = backend_session
        self.inputs = []
        self.outputs = []
 

Member Function Documentation

__getattr__()

package.common.basesession.BaseSession.__getattr__	(		self,
			name
	)

Delegate attribute access to the bound NNFW_SESSION instance.
Args:
    name (str): The name of the attribute or method to access.
Returns:
    The attribute or method from the bound NNFW_SESSION instance.

Definition at line 30 of file basesession.py.

    def __getattr__(self, name):
        """
        Delegate attribute access to the bound NNFW_SESSION instance.
        Args:
            name (str): The name of the attribute or method to access.
        Returns:
            The attribute or method from the bound NNFW_SESSION instance.
        """
        if name in self.__dict__:
            # First, try to get the attribute from the instance's own dictionary
            return self.__dict__[name]
        elif hasattr(self.session, name):
            # If not found, delegate to the session object
            return getattr(self.session, name)
        else:
            raise AttributeError(
                f"'{type(self).__name__}' object has no attribute '{name}'")
 

References validate_onnx2circle.OnnxRunner.session, onert::api::python::NNFW_SESSION.session, and package.common.basesession.BaseSession.session.

_recreate_session()

package.common.basesession.BaseSession._recreate_session (   self,   backend_session  )

protected

Protected method to recreate the session.
Subclasses can override this method to provide custom session recreation logic.

Definition at line 48 of file basesession.py.

    def _recreate_session(self, backend_session):
        """
        Protected method to recreate the session.
        Subclasses can override this method to provide custom session recreation logic.
        """
        if self.session is not None:
            del self.session  # Clean up the existing session
        self.session = backend_session
 

References validate_onnx2circle.OnnxRunner.session, onert::api::python::NNFW_SESSION.session, and package.common.basesession.BaseSession.session.

_set_outputs()

package.common.basesession.BaseSession._set_outputs (   self,   size  )

protected

Set the output tensors for the session.

Args:
    size (int): Number of output tensors.

        Raises:
    ValueError: If session uninitialized.
    OnertError:  If any C-API call fails.

Definition at line 153 of file basesession.py.

    def _set_outputs(self, size):
        """
        Set the output tensors for the session.
 
        Args:
            size (int): Number of output tensors.
 
        Raises:
            ValueError: If session uninitialized.
            OnertError:  If any C-API call fails.
        """
        if self.session is None:
            raise ValueError(
                "Session is not initialized with a model. Please compile a model before setting outputs."
            )
 
        self.outputs = []
        for i in range(size):
            try:
                output_array = self.session.get_output(i)
            except ValueError:
                raise
            except Exception as e:
                raise OnertError(f"Failed to get output #{i}: {e}") from e
 
            self.outputs.append(output_array)
 
 

References Operation.outputs, Request.outputs, circlechef::CircleImport.outputs(), crew::Part.outputs, luci::CircleReader.outputs(), luci::PGroup.outputs, mio::circle::Reader.outputs(), moco::ModelSignature.outputs(), nnc::sir::CallFunction.outputs, validate_onnx2circle.OnnxRunner.outputs, tflinspect::Reader.outputs(), tflchef::TFliteImport.outputs(), tflread::Reader.outputs(), luci_interpreter::CircleReader.outputs(), onert_micro::core::reader::OMCircleReader.outputs(), mio::circle::Reader.outputs(), loco::Graph.outputs(), nnkit::support::onnx::Runner.outputs(), ann::Operation.outputs(), loco::Graph.outputs(), onert_micro::execute::OMRuntimeKernel.outputs, nnfw_custom_kernel_params.outputs, package.common.basesession.BaseSession.outputs, package.infer.session.session.outputs, onert::exec::IODescription.outputs, validate_onnx2circle.OnnxRunner.session, onert::api::python::NNFW_SESSION.session, and package.common.basesession.BaseSession.session.

get_inputs_tensorinfo()

List[tensorinfo] package.common.basesession.BaseSession.get_inputs_tensorinfo

(

self

)

Retrieve tensorinfo for all input tensors.

Raises:
    OnertError: If the underlying C-API call fails.

Returns:
    list[tensorinfo]: A list of tensorinfo objects for each input.

Definition at line 57 of file basesession.py.

    def get_inputs_tensorinfo(self) -> List[tensorinfo]:
        """
        Retrieve tensorinfo for all input tensors.
 
        Raises:
            OnertError: If the underlying C-API call fails.
 
        Returns:
            list[tensorinfo]: A list of tensorinfo objects for each input.
        """
        num_inputs: int = self.session.input_size()
        infos: List[tensorinfo] = []
        for i in range(num_inputs):
            try:
                infos.append(self.session.input_tensorinfo(i))
            except ValueError:
                raise
            except Exception as e:
                raise OnertError(f"Failed to get input tensorinfo #{i}: {e}") from e
        return infos
 

References validate_onnx2circle.OnnxRunner.session, onert::api::python::NNFW_SESSION.session, and package.common.basesession.BaseSession.session.

Referenced by package.infer.session.session.infer().

get_outputs_tensorinfo()

List[tensorinfo] package.common.basesession.BaseSession.get_outputs_tensorinfo

(

self

)

Retrieve tensorinfo for all output tensors.

Raises:
    OnertError: If the underlying C-API call fails.

Returns:
    list[tensorinfo]: A list of tensorinfo objects for each output.

Definition at line 78 of file basesession.py.

    def get_outputs_tensorinfo(self) -> List[tensorinfo]:
        """
        Retrieve tensorinfo for all output tensors.
 
        Raises:
            OnertError: If the underlying C-API call fails.
 
        Returns:
            list[tensorinfo]: A list of tensorinfo objects for each output.
        """
        num_outputs: int = self.session.output_size()
        infos: List[tensorinfo] = []
        for i in range(num_outputs):
            try:
                infos.append(self.session.output_tensorinfo(i))
            except ValueError:
                raise
            except Exception as e:
                raise OnertError(f"Failed to get output tensorinfo #{i}: {e}") from e
        return infos
 

References validate_onnx2circle.OnnxRunner.session, onert::api::python::NNFW_SESSION.session, and package.common.basesession.BaseSession.session.

set_inputs()

package.common.basesession.BaseSession.set_inputs	(		self,
			size,
			inputs_array = []
	)

Set the input tensors for the session.

Args:
    size (int): Number of input tensors.
    inputs_array (list): List of numpy arrays for the input data.

Raises:
    ValueError: If session uninitialized.
    OnertError:  If any C-API call fails.

Definition at line 99 of file basesession.py.

    def set_inputs(self, size, inputs_array=[]):
        """
        Set the input tensors for the session.
 
        Args:
            size (int): Number of input tensors.
            inputs_array (list): List of numpy arrays for the input data.
 
        Raises:
            ValueError: If session uninitialized.
            OnertError:  If any C-API call fails.
        """
        if self.session is None:
            raise ValueError(
                "Session is not initialized with a model. Please compile with a model before setting inputs."
            )
 
        self.inputs = []
        for i in range(size):
            try:
                input_tensorinfo = self.session.input_tensorinfo(i)
            except ValueError:
                raise
            except Exception as e:
                raise OnertError(f"Failed to get input tensorinfo #{i}: {e}") from e
 
            if len(inputs_array) > i:
                input_array = np.array(inputs_array[i], dtype=input_tensorinfo.dtype)
            else:
                print(
                    f"Model's input size is {size}, but given inputs_array size is {len(inputs_array)}.\n{i}-th index input is replaced by an array filled with 0."
                )
                input_array = np.zeros((num_elems(input_tensorinfo)),
                                       dtype=input_tensorinfo.dtype)
 
            # Check if the shape of input_array matches the dims of input_tensorinfo
            if input_array.shape != tuple(input_tensorinfo.dims):
                # If not, set the input tensor info to match the input_array shape
                try:
                    input_tensorinfo.rank = len(input_array)
                    input_tensorinfo.dims = list(input_array.shape)
                    self.session.set_input_tensorinfo(i, input_tensorinfo)
                except Exception as e:
                    raise OnertError(f"Failed to set input tensor info #{i}: {e}") from e
 
            try:
                self.session.set_input(i, input_array)
            except ValueError:
                raise
            except Exception as e:
                raise OnertError(f"Failed to set input #{i}: {e}") from e
 
            self.inputs.append(input_array)
 

References Operation.inputs, Request.inputs, circlechef::CircleImport.inputs(), crew::Part.inputs, luci::CircleReader.inputs(), luci::PGroup.inputs, luci::pass::Expression.inputs, mio::circle::Reader.inputs(), moco::ModelSignature.inputs(), nnc::sir::CallFunction.inputs, validate_onnx2circle.OnnxRunner.inputs, tflinspect::Reader.inputs(), tflchef::TFliteImport.inputs(), tflread::Reader.inputs(), luci_interpreter::CircleReader.inputs(), onert_micro::core::reader::OMCircleReader.inputs(), moco::tf::test::TFNodeBuildTester.inputs(), moco::test::TFNodeBuildTester.inputs(), moco::test::TFNodeBuildTester.inputs(), luci::CircleFakeQuant.inputs(), moco::TFFakeQuantWithMinMaxVars.inputs(), luci::CircleAddN.inputs(), luci::CircleCustom.inputs(), luci::CircleAddN.inputs(), luci::CircleCustom.inputs(), loco::Graph.inputs(), nnkit::support::onnx::Runner.inputs(), ann::Operation.inputs(), loco::Graph.inputs(), luci::CircleFakeQuant.inputs(), moco::TFFakeQuantWithMinMaxVars.inputs(), onert_micro::execute::OMRuntimeKernel.inputs, nnfw_custom_kernel_params.inputs, package.common.basesession.BaseSession.inputs, onert::exec::IODescription.inputs, package.common.basesession.num_elems(), validate_onnx2circle.OnnxRunner.session, onert::api::python::NNFW_SESSION.session, and package.common.basesession.BaseSession.session.

Field Documentation

inputs

package.common.basesession.BaseSession.inputs

Definition at line 27 of file basesession.py.

Referenced by package.experimental.train.dataloader.DataLoader.__init__(), validate_onnx2circle.OnnxRunner.feed_random_inputs(), package.common.basesession.BaseSession.set_inputs(), and package.experimental.train.dataloader.DataLoader.split().

outputs

package.common.basesession.BaseSession.outputs

Definition at line 28 of file basesession.py.

Referenced by package.common.basesession.BaseSession._set_outputs(), and validate_onnx2circle.OnnxRunner.get_outputs().

session

package.common.basesession.BaseSession.session

Definition at line 26 of file basesession.py.

Referenced by package.common.basesession.BaseSession.__getattr__(), package.experimental.train.session.TrainSession.__init__(), package.experimental.train.session.TrainSession._batch_step(), package.common.basesession.BaseSession._recreate_session(), package.experimental.train.session.TrainSession._run_phase(), package.common.basesession.BaseSession._set_outputs(), package.infer.session.session._update_inputs_tensorinfo(), validate_onnx2circle.OnnxRunner.feed_random_inputs(), package.common.basesession.BaseSession.get_inputs_tensorinfo(), validate_onnx2circle.OnnxRunner.get_outputs(), package.common.basesession.BaseSession.get_outputs_tensorinfo(), package.infer.session.session.infer(), validate_onnx2circle.OnnxRunner.load(), package.common.basesession.BaseSession.set_inputs(), and package.experimental.train.session.TrainSession.train().

---

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

• runtime/onert/api/python/package/common/basesession.py