afe.apis.defines

This file contains definitions of the types exposed by the development API for AFE.

Attributes

InputValues
gen1_target
gen2_target
BT_COLOR_COEFF
YUV2RGB_FULL_RANGE_CONSTANTS
default_quantization
int16_quantization

Classes

ExceptionFuncType	Generic enumeration.
ColorSpaceStandard	Color space standards for YUV and RGB conversion.
ColorConversion	Color conversion direction.
ChromaSampling	Chroma sub-sampling representation.
ResizeMethod	Interpolation method used in resize transform.
ResizeDepositLocation	Deposit location of resized image in padded frame.
CalibrationMethod
MinMaxMethod
HistogramMSEMethod
MovingAverageMinMaxMethod
HistogramEntropyMethod
HistogramPercentileMethod
QuantizationScheme	Quantization scheme.
QuantizationParams	Parameters controlling how to quantize a network.

Functions

default_calibration(→ CalibrationMethod)
quantization_scheme(→ QuantizationScheme)	Constructs quantization scheme.
bfloat16_scheme(→ QuantizationScheme)	Constructs a bfloat16 quantization scheme.

Module Contents

afe.apis.defines.InputValues

afe.apis.defines.gen1_target

afe.apis.defines.gen2_target

class afe.apis.defines.ExceptionFuncType

Generic enumeration.

Derive from this class to define new enumerations.

LOADED_NET_LOAD

LOADED_NET_EXECUTE

LOADED_NET_QUANTIZE

LOADED_NET_CONVERT

MODEL_EXECUTE

MODEL_SAVE

MODEL_LOAD

MODEL_COMPILE

MODEL_CREATE_AUXILIARY

MODEL_COMPOSE

MODEL_EVALUATE

MODEL_PERFORMANCE

GENERATE_ELF_FILES

QUANTIZATION_ERROR_ANALYSIS

class afe.apis.defines.ColorSpaceStandard

Color space standards for YUV and RGB conversion. BT601 is for SD video; BT709 is for HD video; BT2020 is for HDR.

BT601 = 'BT601'

BT709 = 'BT709'

BT2020 = 'BT2020'

afe.apis.defines.BT_COLOR_COEFF: Dict[ColorSpaceStandard, List[float]]

afe.apis.defines.YUV2RGB_FULL_RANGE_CONSTANTS: Dict[str, List[float]]

class afe.apis.defines.ColorConversion

Color conversion direction.

YUV2RGB = 'YUV2RGB'

RGB2YUV = 'RGB2YUV'

BGR2RGB = 'BGR2RGB'

RGB2BGR = 'RGB2BGR'

class afe.apis.defines.ChromaSampling

Chroma sub-sampling representation.

NV12 = 'NV12'

YUV420 = 'YUV420'

YUV422 = 'YUV422'

class afe.apis.defines.ResizeMethod

Interpolation method used in resize transform.

LINEAR = 'linear'

NEAREST = 'nearest'

AREA = 'area'

CUBIC = 'cubic'

class afe.apis.defines.ResizeDepositLocation

Deposit location of resized image in padded frame.

TOPLEFT = 'topleft'

CENTER = 'center'

BOTTOMRIGHT = 'bottomright'

class afe.apis.defines.CalibrationMethod

property name

static from_str(method: str)

class afe.apis.defines.MinMaxMethod

class afe.apis.defines.HistogramMSEMethod(num_bins)

num_bins: int

class afe.apis.defines.MovingAverageMinMaxMethod

class afe.apis.defines.HistogramEntropyMethod(num_bins)

num_bins: int

class afe.apis.defines.HistogramPercentileMethod(percentile_value, num_bins)

percentile_value: float

num_bins: int

afe.apis.defines.default_calibration() → CalibrationMethod

class afe.apis.defines.QuantizationScheme

Quantization scheme.

Parameters:

• asymmetric – Whether to use asymmetric quantization.

• per_channel – Whether to use per-channel quantization.

• bits – Number of bits of precision to use in the quantized representation

• bf16 – Whether to use bfloat16. If True, then asymmetric, per_channel, and bits are ignored.

asymmetric: bool

per_channel: bool

bits: int = 8

bf16: bool = False

afe.apis.defines.quantization_scheme(asymmetric: bool, per_channel: bool, bits: int = 8) → QuantizationScheme

Constructs quantization scheme.

afe.apis.defines.bfloat16_scheme() → QuantizationScheme

Constructs a bfloat16 quantization scheme. It directs the compiler to use bfloat16 instead of integer quantization.

class afe.apis.defines.QuantizationParams

Parameters controlling how to quantize a network.

Parameters:

• calibration_method – Calibration method.

• activation_quantization_scheme – Quantization scheme for activation tensors.

• weight_quantization_scheme – Quantization scheme for weights tensors.

• requantization_mode – A way of doing quantized arithmetic.

• node_names – Nodes to prevent from quantizing.

• custom_quantization_configs – Dictionary setting the node’s custom quantization options.

• biascorr_type – Selection of bias correction: regular/iterative/none

• channel_equalization – If True, channel equalization is enabled.

• smooth_quant – If True, smooth quant is enabled.

calibration_method: CalibrationMethod

activation_quantization_scheme: QuantizationScheme

weight_quantization_scheme: QuantizationScheme

requantization_mode: afe.ir.defines.RequantizationMode

node_names: Set[str]

custom_quantization_configs: Dict[afe.ir.defines.NodeName, Dict[str, Any]] | None = None

biascorr_type: afe.ir.defines.BiasCorrectionType

channel_equalization: bool = False

smooth_quant: bool = False

with_calibration(method: CalibrationMethod) → QuantizationParams

with_activation_quantization(scheme: QuantizationScheme) → QuantizationParams

with_weight_quantization(scheme: QuantizationScheme) → QuantizationParams

with_requantization_mode(requantization_mode: afe.ir.defines.RequantizationMode)

with_unquantized_nodes(node_names: Set[str]) → QuantizationParams

with_custom_quantization_configs(custom_quantization_configs: Dict[afe.ir.defines.NodeName, Dict[str, Any]])

with_bias_correction(enable: bool | afe.ir.defines.BiasCorrectionType = True)

with_channel_equalization(enable: bool = True)

with_smooth_quant(enable: bool = True)

afe.apis.defines.default_quantization: QuantizationParams

afe.apis.defines.int16_quantization: QuantizationParams