API reference

• Akida runtime
  • __version__
  • Model
    • Model
      • Model.add()
      • Model.add_classes()
      • Model.compile()
      • Model.evaluate()
      • Model.fit()
      • Model.forward()
      • Model.from_dict()
      • Model.from_json()
      • Model.get_layer()
      • Model.get_layer_count()
      • Model.input_shape
      • Model.ip_version
      • Model.layers
      • Model.learning
      • Model.map()
      • Model.metrics
      • Model.output_shape
      • Model.pop_layer()
      • Model.power_events
      • Model.predict()
      • Model.predict_classes()
      • Model.save()
      • Model.sequences
      • Model.statistics
      • Model.summary()
      • Model.to_buffer()
      • Model.to_dict()
      • Model.to_json()
  • Layer
    • Layer
      • Layer
        • Layer.get_learning_histogram()
        • Layer.get_variable()
        • Layer.get_variable_names()
        • Layer.inbounds
        • Layer.input_bits
        • Layer.input_dims
        • Layer.mapping
        • Layer.name
        • Layer.output_dims
        • Layer.output_signed
        • Layer.parameters
        • Layer.set_variable()
        • Layer.to_dict()
        • Layer.variables
    • Mapping
      • Mapping
        • Mapping.nps
  • Akida layers
    • InputData
  • Akida V1 layers
    • InputConvolutional
    • FullyConnected
    • Convolutional
    • SeparableConvolutional
  • Akida V2 layers
    • InputConv2D
    • Stem
    • Conv2D
    • Conv2DTranspose
    • Dense1D
    • Dense2D
    • DepthwiseConv2D
    • DepthwiseConv2DTranspose
    • Attention
    • VitEncoderBlock
    • Add
    • Concatenate
    • ExtractToken
    • BatchNormalization
    • MadNorm
    • Shiftmax
    • Dequantizer
  • Layer parameters
    • LayerType
      • LayerType
    • Padding
      • Padding
    • PoolType
      • PoolType
  • Optimizers
    • Optimizer
      • Optimizer.get()
    • AkidaUnsupervised
  • Sequence
    • Sequence
      • Sequence
        • Sequence.backend
        • Sequence.name
        • Sequence.passes
        • Sequence.program
        • Sequence.program_parts
    • BackendType
      • BackendType
    • Pass
      • Pass
        • Pass.layers
  • Device
    • Device
      • Device
        • Device.desc
        • Device.mesh
        • Device.version
      • devices()
      • AKD1000()
      • TwoNodesIP()
    • HwVersion
      • HwVersion
        • HwVersion.major_rev
        • HwVersion.minor_rev
        • HwVersion.product_id
        • HwVersion.vendor_id
  • HWDevice
    • HWDevice
      • HardwareDevice
        • HardwareDevice.fit()
        • HardwareDevice.forward()
        • HardwareDevice.inference_power_events
        • HardwareDevice.learn_enabled
        • HardwareDevice.learn_mem
        • HardwareDevice.memory
        • HardwareDevice.metrics
        • HardwareDevice.predict()
        • HardwareDevice.program
        • HardwareDevice.program_external()
        • HardwareDevice.reset_top_memory()
        • HardwareDevice.soc
        • HardwareDevice.unprogram()
    • SocDriver
      • SocDriver
        • SocDriver.clock_mode
        • SocDriver.power_measurement_enabled
        • SocDriver.power_meter
    • ClockMode
      • ClockMode
  • PowerMeter
    • PowerMeter
      • PowerMeter.events()
      • PowerMeter.floor
    • PowerEvent
      • PowerEvent.current
      • PowerEvent.power
      • PowerEvent.ts
      • PowerEvent.voltage
  • NP
    • Mesh
      • Mesh.dma_conf
      • Mesh.dma_event
      • Mesh.nps
      • Mesh.skip_dmas
    • Info
      • Info.ident
      • Info.types
    • Ident
      • Ident.col
      • Ident.id
      • Ident.row
    • Type
    • Mapping
      • Mapping.filters
      • Mapping.ident
      • Mapping.single_buffer
      • Mapping.type
  • MapMode
    • MapMode
      • MapMode.AllNps
      • MapMode.HwPr
      • MapMode.Minimal
  • Tools
    • Sparsity
      • evaluate_sparsity()
• CNN2SNN
  • Akida version
    • AkidaVersion
      • AkidaVersion.v1
      • AkidaVersion.v2
    • get_akida_version()
    • set_akida_version()
  • Conversion
    • convert()
    • check_model_compatibility()
  • Legacy quantization API
    • Utils
      • check_model_compatibility()
      • load_quantized_model()
    • Calibration
      • QuantizationSampler()
      • bias_correction()
      • adaround()
    • Transforms
      • sequentialize()
      • syncretize()
      • invert_batchnorm_pooling()
      • fold_batchnorm()
      • weights_homogeneity()
      • normalize_separable_layer()
      • normalize_separable_model()
      • reshape()
    • Constraint
      • MinValueConstraint
    • Quantization
      • quantize()
      • quantize_layer()
    • Quantizers
      • WeightQuantizer
        • WeightQuantizer
          • WeightQuantizer.bitwidth
          • WeightQuantizer.get_config()
          • WeightQuantizer.quantize()
          • WeightQuantizer.scale_factor()
      • LinearWeightQuantizer
        • LinearWeightQuantizer
          • LinearWeightQuantizer.quantize()
          • LinearWeightQuantizer.scale_factor()
      • StdWeightQuantizer
        • StdWeightQuantizer
          • StdWeightQuantizer.get_config()
          • StdWeightQuantizer.scale_factor()
          • StdWeightQuantizer.sigma_()
          • StdWeightQuantizer.threshold
      • StdPerAxisQuantizer
        • StdPerAxisQuantizer
          • StdPerAxisQuantizer.sigma_()
      • MaxQuantizer
        • MaxQuantizer
          • MaxQuantizer.max_range_()
          • MaxQuantizer.scale_factor()
      • MaxPerAxisQuantizer
        • MaxPerAxisQuantizer
          • MaxPerAxisQuantizer.max_range_()
    • Quantized layers
      • QuantizedConv2D
        • QuantizedConv2D
          • QuantizedConv2D.call()
          • QuantizedConv2D.get_config()
      • QuantizedDense
        • QuantizedDense
          • QuantizedDense.call()
          • QuantizedDense.get_config()
      • QuantizedSeparableConv2D
        • QuantizedSeparableConv2D
          • QuantizedSeparableConv2D.call()
          • QuantizedSeparableConv2D.get_config()
      • QuantizedActivation
        • QuantizedActivation
          • QuantizedActivation.bitwidth
          • QuantizedActivation.call()
          • QuantizedActivation.get_config()
          • QuantizedActivation.quantized_activation()
          • QuantizedActivation.step
          • QuantizedActivation.threshold
      • ActivationDiscreteRelu
        • ActivationDiscreteRelu
          • ActivationDiscreteRelu.step
      • QuantizedReLU
        • QuantizedReLU
          • QuantizedReLU.get_config()
          • QuantizedReLU.step
• QuantizeML
  • Layers
    • Reshaping
      • QuantizedFlatten
      • QuantizedPermute
      • QuantizedReshape
    • Activations
      • QuantizedReLU
    • Attention
      • Attention
      • QuantizedAttention
      • string_to_softmax()
    • Normalization
      • QuantizedBatchNormalization
      • LayerMadNormalization
      • QuantizedLayerNormalization
    • Convolution
      • PaddedConv2D
      • QuantizedConv2D
      • QuantizedConv2DTranspose
    • Depthwise convolution
      • QuantizedDepthwiseConv2D
      • DepthwiseConv2DTranspose
      • QuantizedDepthwiseConv2DTranspose
    • Separable convolution
      • QuantizedSeparableConv2D
    • Dense
      • QuantizedDense
    • Skip connection
      • Add
      • QuantizedAdd
      • QuantizedConcatenate
    • Pooling
      • QuantizedMaxPool2D
      • QuantizedGlobalAveragePooling2D
    • Shiftmax
      • Shiftmax
      • QuantizedShiftmax
      • shiftmax()
    • Transformers
      • ClassToken
      • QuantizedClassToken
      • AddPositionEmbs
      • QuantizedAddPositionEmbs
      • ExtractToken
      • QuantizedExtractToken
    • Rescaling
      • QuantizedRescaling
    • Dropout
      • QuantizedDropout
    • Quantizers
      • Quantizer
      • WeightQuantizer
        • WeightQuantizer.build()
        • WeightQuantizer.call()
        • WeightQuantizer.get_config()
      • AlignedWeightQuantizer
        • AlignedWeightQuantizer.call()
      • OutputQuantizer
        • OutputQuantizer.build()
        • OutputQuantizer.call()
        • OutputQuantizer.get_config()
      • Dequantizer
        • Dequantizer.call()
    • Calibration
      • OutputObserver
    • Recording
      • recording()
      • TensorRecorder
      • FixedPointRecorder
      • QFloatRecorder
      • NonTrackVariable
      • NonTrackFixedPointVariable
  • Models
    • Transforms
      • align_rescaling()
      • invert_batchnorm_pooling()
      • fold_batchnorms()
      • insert_layer()
      • insert_rescaling()
      • invert_relu_maxpool()
      • remove_zeropadding2d()
      • replace_lambda()
      • sanitize()
    • Quantization
      • quantize()
      • dump_config()
      • record_quantization_variables()
    • Quantization parameters
      • QuantizationParams
      • get_quantization_params()
      • quantization()
    • Calibration
      • calibrate()
      • calibration_required()
    • Utils
      • apply_weights_to_model()
  • Tensors
    • QTensor
      • QTensor
        • QTensor.Spec
        • QTensor.assert_per_tensor()
        • QTensor.clone()
        • QTensor.name
        • QTensor.per_tensor
        • QTensor.to_float()
    • FixedPoint
      • FixedPoint
        • FixedPoint.Spec
        • FixedPoint.abs()
        • FixedPoint.align()
        • FixedPoint.downscale()
        • FixedPoint.expand()
        • FixedPoint.floor()
        • FixedPoint.max_frac_bits()
        • FixedPoint.name
        • FixedPoint.per_tensor
        • FixedPoint.promote()
        • FixedPoint.quantize()
        • FixedPoint.rescale()
        • FixedPoint.shift()
        • FixedPoint.sign
        • FixedPoint.to_float()
        • FixedPoint.upscale()
    • QFloat
      • QFloat
        • QFloat.Spec
        • QFloat.expand()
        • QFloat.max_frac_bits()
        • QFloat.name
        • QFloat.optimal_scales()
        • QFloat.per_tensor
        • QFloat.promote()
        • QFloat.quantize()
        • QFloat.quantize_scales()
        • QFloat.to_fixed_point()
        • QFloat.to_float()
        • QFloat.upscale()
  • ONNX support
    • Layers
      • OnnxLayer()
      • QuantizedConv2D()
      • QuantizedDepthwise2D()
      • QuantizedConv2DTranspose()
      • QuantizedDepthwise2DTranspose()
      • QuantizedDense1D()
      • QuantizedAdd()
      • QuantizedConcat()
      • InputQuantizer()
      • Dequantizer()
    • Custom patterns
      • custom_pattern_scope()
  • Model I/O
    • load_model()
    • save_model()
  • Analysis
    • Kernel distribution
      • plot_kernel_distribution()
    • Quantization error
      • measure_layer_quantization_error()
      • measure_cumulative_quantization_error()
    • Metrics
      • SMAPE()
      • Saturation()
      • print_metric_table()
• Akida models
  • Layer blocks
    • CNN blocks
      • conv_block()
      • separable_conv_block()
      • dense_block()
    • Transformers blocks
      • mlp_block()
      • multi_head_attention()
      • transformer_block()
    • Transposed blocks
      • conv_transpose_block()
      • sepconv_transpose_block()
    • Detection block
      • yolo_head_block()
  • Helpers
    • Gamma constraint
      • add_gamma_constraint()
    • Unfusing SeparableConvolutional
      • unfuse_sepconv2d()
    • Extract samples
      • extract_samples()
  • Knowledge distillation
    • Distiller
    • DeitDistiller
    • KLDistillationLoss()
  • MACS
    • get_flops()
    • display_macs()
  • Model I/O
    • load_model()
    • load_weights()
    • save_weights()
    • get_model_path()
  • Utils
    • fetch_file()
    • get_tensorboard_callback()
    • get_params_by_version()
  • Model zoo
    • AkidaNet
      • ImageNet
        • akidanet_imagenet()
        • akidanet_imagenet_pretrained()
        • akidanet_edge_imagenet()
        • akidanet_edge_imagenet_pretrained()
        • akidanet18_imagenet()
        • akidanet18_imagenet_pretrained()
        • akidanet_faceidentification_pretrained()
        • akidanet_faceidentification_edge_pretrained()
        • akidanet_plantvillage_pretrained()
        • akidanet_vww_pretrained()
        • Preprocessing
          • get_preprocessed_samples()
          • preprocess_image()
          • index_to_label()
    • Mobilenet
      • ImageNet
        • mobilenet_imagenet()
        • mobilenet_imagenet_pretrained()
    • DS-CNN
      • KWS
        • ds_cnn_kws()
        • ds_cnn_kws_pretrained()
        • Preprocessing
          • AudioProcessor
            • AudioProcessor.get_augmented_data_for_wav()
            • AudioProcessor.get_data()
            • AudioProcessor.get_features_for_wav()
            • AudioProcessor.maybe_download_and_extract_dataset()
            • AudioProcessor.prepare_background_data()
            • AudioProcessor.prepare_data_index()
            • AudioProcessor.prepare_processing_graph()
    • VGG
      • UTK Face
        • vgg_utk_face()
        • vgg_utk_face_pretrained()
        • Preprocessing
          • load_data()
    • YOLO
      • yolo_base()
      • yolo_widerface_pretrained()
      • yolo_voc_pretrained()
      • Detection data
        • get_detection_datasets()
        • get_voc_dataset()
        • get_coco_dataset()
        • get_widerface_dataset()
        • Preprocessing
          • preprocess_dataset()
        • Utils
          • remove_empty_objects()
          • get_dataset_length()
          • Coord
      • YOLO Toolkit
        • Processing
          • load_image()
          • preprocess_image()
          • get_affine_transform()
          • apply_affine_transform_to_bboxes()
          • desize_bboxes()
          • decode_output()
          • create_yolo_targets()
          • BoundingBox
            • BoundingBox.get_label()
            • BoundingBox.get_score()
            • BoundingBox.iou()
        • YOLO Data Augmentation
          • augment_sample()
          • build_yolo_aug_pipeline()
          • init_random_vars()
        • Performance
          • MapEvaluation
            • MapEvaluation.evaluate_map()
            • MapEvaluation.on_epoch_end()
        • Anchors
          • generate_anchors()
        • Utils
          • xywh_to_xyxy()
          • xyxy_to_xywh()
          • compute_overlap()
          • compute_center_xy()
          • compute_center_wh()
    • PointNet++
      • ModelNet40
        • pointnet_plus_modelnet40()
        • pointnet_plus_modelnet40_pretrained()
        • Processing
          • get_modelnet_from_file()
          • get_modelnet()
    • GXNOR
      • MNIST
        • gxnor_mnist()
        • gxnor_mnist_pretrained()
    • CenterNet
      • centernet_base()
      • centernet_voc_pretrained()
      • decode_output()
      • create_centernet_targets()
      • build_centernet_aug_pipeline()
      • CenternetLoss
    • AkidaUNet
      • akida_unet_portrait128()
      • akida_unet_portrait128_pretrained()
    • Transformers
      • ViT
        • vit_imagenet()
        • vit_ti16()
        • bc_vit_ti16()
        • bc_vit_ti16_imagenet_pretrained()
        • vit_s16()
        • vit_s32()
        • vit_b16()
        • vit_b32()
        • vit_l16()
        • vit_l32()
      • DeiT
        • deit_imagenet()
        • deit_ti16()
        • bc_deit_ti16()
        • bc_deit_dist_ti16_imagenet_pretrained()
        • deit_s16()
        • deit_b16()