TosaRescaleOperatorUtils.hpp File Reference

#include <armnn/Exceptions.hpp>

Include dependency graph for TosaRescaleOperatorUtils.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	CreateRawRescaleTosaOperator (const std::string &inputName, const std::string &outputName, const std::vector< int32_t > &multipliers, const std::vector< int32_t > &shifts, int32_t input_zp, int32_t output_zp, bool input_unsigned, bool output_unsigned, bool double_round, bool scale32, bool per_channel, TosaSerializationOperator **op)
	Creates a raw rescale TOSA operator.
void	ComputeMultiplierAndShiftTosaScale32 (double scale, int32_t &multiplier, int32_t &shift)
	The following is taken from mlir/lib/Dialect/Tosa/Utils/QuantUtils.cpp in the LLVM project From a scale value, generates multiplier and shift values where mantissa is in [-1.0,-0.5] or [0.5, 1.0] such that multiplier = mantissa*2^shift for 32-bit scaling.
void	ComputeMultiplierAndShiftTosaScale16 (double scale, int32_t &multiplier, int32_t &shift)
	The following is taken from mlir/lib/Dialect/Tosa/Utils/QuantUtils.cpp in the LLVM project From a scale value, generates multiplier and shift values where mantissa is in [-1.0,-0.5] or [0.5, 1.0] such that multiplier = mantissa*2^shift for 16-bit scaling.
void	CreateRescaleTosaOperator (const std::string &inputName, const std::string &outputName, double scale, int32_t input_zp, int32_t output_zp, bool input_unsigned, bool output_unsigned, bool double_round, bool scale32, TosaSerializationOperator **op)
	Creates a Tosa rescale operator.
void	CreateRescaleTosaOperatorForWeights (const std::string &inputName, const std::string &outputName, int32_t input_zp, int32_t output_zp, bool input_unsigned, bool output_unsigned, bool double_round, bool scale32, double input_scale, double output_scale, const std::vector< float > &weight_scales, TosaSerializationOperator **op)
	Creates a TOSA rescale operator for weight tensors.

Function Documentation

ComputeMultiplierAndShiftTosaScale16()

void ComputeMultiplierAndShiftTosaScale16 ( double scale, int32_t & multiplier, int32_t & shift )

inline

The following is taken from mlir/lib/Dialect/Tosa/Utils/QuantUtils.cpp in the LLVM project From a scale value, generates multiplier and shift values where mantissa is in [-1.0,-0.5] or [0.5, 1.0] such that multiplier = mantissa*2^shift for 16-bit scaling.

Definition at line 137 of file TosaRescaleOperatorUtils.hpp.

{
    const double mantissa = std::frexp(scale, &shift);
    auto shiftedM = std::round(mantissa * (int64_t(1) << 15));
 
    // Can't be greater than 1.0.
    if (!(shiftedM <= (int64_t(1) << 15)))
    {
        throw armnn::Exception("Shifted mantissa exceeds 16 signed bits");
    }
 
    if (shiftedM == (int64_t(1) << 15))
    {
        shiftedM /= 2;
        shift++;
    }
 
    // TOSA expects right shift to be positive and embed (1 << 15) into right
    // shift bits.
    shift = (-shift) + 15;
 
    if (!(shiftedM <= std::numeric_limits<int32_t>::max()))
    {
        throw armnn::Exception("Shifted mantissa exceeds 32-bit signed output type");
    }
 
    multiplier = static_cast<int32_t>(shiftedM);
 
    // Shifting tops out at 62 bits. Right shift to make 62 bits the max.
    // The limit of 62 on shift allows the shift to be decomposed as
    // two right shifts of 31.
    if (shift > 62)
    {
        // Shifting the multiplier by more than 31-bits is unnecessary.
        multiplier = multiplier >> std::min<int32_t>(31, shift - 62);
        shift = 62;
    }
}

Referenced by CreateRescaleTosaOperator(), and CreateRescaleTosaOperatorForWeights().

ComputeMultiplierAndShiftTosaScale32()

void ComputeMultiplierAndShiftTosaScale32 ( double scale, int32_t & multiplier, int32_t & shift )

inline

The following is taken from mlir/lib/Dialect/Tosa/Utils/QuantUtils.cpp in the LLVM project From a scale value, generates multiplier and shift values where mantissa is in [-1.0,-0.5] or [0.5, 1.0] such that multiplier = mantissa*2^shift for 32-bit scaling.

Definition at line 94 of file TosaRescaleOperatorUtils.hpp.

{
    const double mantissa = std::frexp(scale, &shift);
    auto shiftedM = std::round(mantissa * (int64_t(1) << 31));
 
    // Can't be greater than 1.0.
    if (!(shiftedM <= (int64_t(1) << 31)))
    {
        throw armnn::Exception("Shifted mantissa exceeds 32 signed bits");
    }
 
    if (shiftedM == (int64_t(1) << 31))
    {
        shiftedM /= 2;
        shift++;
    }
 
    // TOSA expects right shift to be positive, and embed (1 << 31) into right
    // shift bits.
    shift = (-shift) + 31;
 
    if (!(shiftedM <= std::numeric_limits<int32_t>::max()))
    {
        throw armnn::Exception("Shifted mantissa exceeds 32-bit signed output type");
    }
 
    multiplier = static_cast<int32_t>(shiftedM);
 
    // Shifting tops out at 47 bits. Right shift to make 47 bits the max.
    int32_t maxShiftValue = 47;
    if (shift > maxShiftValue)
    {
        multiplier = multiplier >> std::min<int32_t>(31, shift - maxShiftValue);
        shift = maxShiftValue;
    }
}

Referenced by ConvertReduceToTosaOperator(), CreateRescaleTosaOperator(), and CreateRescaleTosaOperatorForWeights().

CreateRawRescaleTosaOperator()

void CreateRawRescaleTosaOperator ( const std::string & inputName, const std::string & outputName, const std::vector< int32_t > & multipliers, const std::vector< int32_t > & shifts, int32_t input_zp, int32_t output_zp, bool input_unsigned, bool output_unsigned, bool double_round, bool scale32, bool per_channel, TosaSerializationOperator ** op )

inline

Creates a raw rescale TOSA operator.

This inline function creates a raw rescale operator for TOSA that adjusts the quantization parameters for an input tensor. It validates the multipliers and shifts vectors, ensuring they meet specific criteria for per-channel or global quantization. If any validation fails, an exception is thrown.

Parameters

inputName	: The name of the input tensor.
outputName	: The name of the output tensor.
multipliers	: A vector of multiplier values for scaling.
shifts	: A vector of shift values corresponding to the multipliers.
input_zp	: The zero point for the input tensor.
output_zp	: The zero point for the output tensor.
input_unsigned	: Indicates if the input tensor is unsigned.
output_unsigned	: Indicates if the output tensor is unsigned.
double_round	: If true, applies double rounding during quantization.
scale32	: If true, performs 32-bit scaling; otherwise, 16-bit scaling is used.
per_channel	: Determines whether per-channel quantization is applied.
op	: Pointer to store the created TosaSerializationOperator.

Definition at line 32 of file TosaRescaleOperatorUtils.hpp.

{
    if (!op)
    {
        throw armnn::Exception("CreateRawRescaleTosaOperator: nullptr op.");
    }
 
    if (multipliers.empty())
    {
        throw armnn::Exception("CreateRawRescaleTosaOperator: multipliers is empty.");
    }
 
    if (multipliers.size() != shifts.size())
    {
        throw armnn::Exception("CreateRawRescaleTosaOperator: multipliers and shift not same size.");
    }
 
    if (multipliers.size() == 1 && per_channel)
    {
        throw armnn::Exception("CreateRawRescaleTosaOperator: \
                                multipliers must be greater than 1 if per_channel is true.");
    }
 
    if (multipliers.size() > 1 && !per_channel)
    {
        throw armnn::Exception("CreateRawRescaleTosaOperator: \
                                multipliers size must be 1 if per_channel is false.");
    }
 
    TosaRescaleAttribute attribute(input_zp,
                                   output_zp,
                                   multipliers,
                                   shifts,
                                   scale32,
                                   double_round,
                                   per_channel,
                                   input_unsigned,
                                   output_unsigned);
 
    // op
    *op = new TosaSerializationOperator(Op_RESCALE, Attribute_RescaleAttribute, &attribute, {inputName}, {outputName});
    if (!(*op))
    {
        throw armnn::Exception("CreateRescaleTosaOperator: failed to created operator");
    }
}

Referenced by ConvertReduceToTosaOperator(), CreateRescaleTosaOperator(), and CreateRescaleTosaOperatorForWeights().

CreateRescaleTosaOperator()

void CreateRescaleTosaOperator ( const std::string & inputName, const std::string & outputName, double scale, int32_t input_zp, int32_t output_zp, bool input_unsigned, bool output_unsigned, bool double_round, bool scale32, TosaSerializationOperator ** op )

inline

Creates a Tosa rescale operator.

This inline function computes the multiplier and shift values based on the given scale using either 32-bit or 16-bit scaling. It then creates a raw rescale operator that adjusts the quantization parameters for the input tensor.

Parameters

inputName	: The name of the input tensor.
outputName	: The name of the output tensor.
scale	: The scale factor used to compute the multiplier and shift.
input_zp	: The zero point for the input tensor.
output_zp	: The zero point for the output tensor.
input_unsigned	: Indicates if the input tensor is unsigned.
output_unsigned	Indicates if the output tensor is unsigned.
double_round	: If true, uses double rounding for quantization.
scale32	: If true, performs 32-bit scaling; otherwise, 16-bit scaling is used.
op	: Pointer to a variable that will store the created TosaSerializationOperator.

Definition at line 197 of file TosaRescaleOperatorUtils.hpp.

{
    int32_t multiplier;
    int32_t shift;
 
    if (scale32)
    {
        ComputeMultiplierAndShiftTosaScale32(scale, multiplier, shift);
    }
    else
    {
        ComputeMultiplierAndShiftTosaScale16(scale, multiplier, shift);
    }
 
    const std::vector<int32_t> multipliers{multiplier};
    const std::vector<int32_t> shifts{shift};
 
    CreateRawRescaleTosaOperator(inputName,
                                 outputName,
                                 multipliers,
                                 shifts,
                                 input_zp,
                                 output_zp,
                                 input_unsigned,
                                 output_unsigned,
                                 double_round,
                                 scale32,
                                 false,
                                 op);
}

References ComputeMultiplierAndShiftTosaScale16(), ComputeMultiplierAndShiftTosaScale32(), and CreateRawRescaleTosaOperator().

Referenced by ConvertElementwiseBinaryToTosaOperator(), ConvertLeakyReluToTosaOperator(), ConvertPReluToTosaOperator(), ConvertQuantizeToTosaOperator(), ConvertReduceToTosaOperator(), ConvertReluToTosaOperator(), ConvertResizeToTosaOperator(), ConvertSoftmaxToTosaOperator(), and ConvertSquaredDifferenceToTosaOperator().

CreateRescaleTosaOperatorForWeights()

void CreateRescaleTosaOperatorForWeights ( const std::string & inputName, const std::string & outputName, int32_t input_zp, int32_t output_zp, bool input_unsigned, bool output_unsigned, bool double_round, bool scale32, double input_scale, double output_scale, const std::vector< float > & weight_scales, TosaSerializationOperator ** op )

inline

Creates a TOSA rescale operator for weight tensors.

This function computes multipliers and shift values for each weight scale by combining the input scale, weight scale, and output scale. It determines the quantization parameters using either 32-bit or 16-bit calculations based on the scale32 flag. The per_channel flag is set true if the provided weight scales are more than one. An exception is thrown if any computation fails.

Parameters

inputName	: The name of the input tensor.
outputName	: The name of the output tensor.
input_zp	: The zero point for the input tensor.
output_zp	: The zero point for the output tensor.
input_unsigned	: Indicates if the input tensor is unsigned.
output_unsigned	: Indicates if the output tensor is unsigned.
double_round	: If true, uses double rounding for quantization.
scale32	: If true, uses 32-bit scaling; otherwise, uses 16-bit scaling.
input_scale	: The scaling factor for the input tensor.
output_scale	: The scaling factor for the output tensor.
weight_scales	: Vector of weight scales for per-channel quantization.
op	: Pointer to store the created TosaSerializationOperator.

Definition at line 258 of file TosaRescaleOperatorUtils.hpp.

{
    std::vector<int32_t> op_tensor_multipliers;
    std::vector<int32_t> op_tensor_shifts;
    op_tensor_multipliers.reserve(weight_scales.size());
    op_tensor_shifts.reserve(weight_scales.size());
 
    for (const float& weight_scale : weight_scales)
    {
        double op_tensor_scale = (input_scale * weight_scale) / output_scale;
        int32_t multiplier;
        int32_t shift;
 
        if (scale32)
        {
            ComputeMultiplierAndShiftTosaScale32(op_tensor_scale, multiplier, shift);
        }
        else
        {
            ComputeMultiplierAndShiftTosaScale16(op_tensor_scale, multiplier, shift);
        }
 
        op_tensor_multipliers.push_back(multiplier);
        op_tensor_shifts.push_back(shift);
    }
 
    bool per_channel = weight_scales.size() == 1 ? false : true;
    CreateRawRescaleTosaOperator(inputName,
                                 outputName,
                                 op_tensor_multipliers,
                                 op_tensor_shifts,
                                 input_zp,
                                 output_zp,
                                 input_unsigned,
                                 output_unsigned,
                                 double_round,
                                 scale32,
                                 per_channel,
                                 op);
}

References ComputeMultiplierAndShiftTosaScale16(), ComputeMultiplierAndShiftTosaScale32(), and CreateRawRescaleTosaOperator().

Referenced by ConvertBatchMatMulToTosaOperator(), ConvertConv2dToTosaOperator(), ConvertConv3dToTosaOperator(), ConvertDepthwiseConv2dToTosaOperator(), and ConvertFullyConnectedToTosaOperator().