Accelerator Class Reference

Accelerator Class Reference#

Runtime Library: mobilint::Accelerator Class Reference
Runtime Library v0.30
Mobilint SDK qb

Represents an accelerator, i.e., an NPU, used for executing models. More...

#include <acc.h>

Public Member Functions

 Accelerator (const Accelerator &other)=delete
 Accelerator (Accelerator &&other) noexcept
Acceleratoroperator= (const Accelerator &rhs)=delete
Acceleratoroperator= (Accelerator &&rhs) noexcept
 ~Accelerator ()
 Destroys the Accelerator object and releases resources.
std::vector< CoreIdgetAvailableCores () const
 Retrieves a list of available NPU cores.

Static Public Member Functions

static std::unique_ptr< Acceleratorcreate (StatusCode &sc)
 Creates an Accelerator object for executing models, using device number 0.
static std::unique_ptr< Acceleratorcreate (int dev_no, StatusCode &sc)
 Creates an Accelerator object for a specific device.
static std::unique_ptr< Acceleratorcreate (int dev_no, bool verbose, StatusCode &sc)

Friends

class Model
class AsyncModel

Detailed Description

Represents an accelerator, i.e., an NPU, used for executing models.

Definition at line 66 of file acc.h.

Member Function Documentation

◆ create() [1/3]

std::unique_ptr< Accelerator > mobilint::Accelerator::create ( StatusCode & sc)
static

Creates an Accelerator object for executing models, using device number 0.

This function is useful when only one device is attached, in which case the default device (device 0) will be used.

Parameters
[out]scReference to a StatusCode that will be updated with the result of the creation.
Returns
A unique pointer to the created Accelerator object.

◆ create() [2/3]

std::unique_ptr< Accelerator > mobilint::Accelerator::create ( int dev_no,
StatusCode & sc )
static

Creates an Accelerator object for a specific device.

The dev_no parameter represents the device number. For example, on Linux, if an ARIES NPU is attached as /dev/aries0, the device number is 0.

Parameters
dev_noThe device number to associate with the Accelerator.
[out]scReference to a StatusCode that will be updated with the result of the creation.
Returns
A unique pointer to the created Accelerator object.

◆ create() [3/3]

std::unique_ptr< Accelerator > mobilint::Accelerator::create ( int dev_no,
bool verbose,
StatusCode & sc )
static
Deprecated
Use std::unique_ptr<Accelerator> create(int dev_no, StatusCode& sc) instead.

◆ getAvailableCores()

std::vector< CoreId > mobilint::Accelerator::getAvailableCores ( ) const

Retrieves a list of available NPU cores.

An available core is one that can be allocated for newly created Model objects.

Note
Availability checks are only supported on Linux. On Windows, this function returns all NPU cores without checking availability.
Returns
A vector containing the IDs of available cores.

◆ Model

friend class Model
friend

Definition at line 130 of file acc.h.

◆ AsyncModel

friend class AsyncModel
friend

Definition at line 131 of file acc.h.


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