hls4ml.backends.catapult package

Subpackages

• hls4ml.backends.catapult.passes package
  • Submodules
  • hls4ml.backends.catapult.passes.bn_quant module
    • BatchNormalizationQuantizedTanhConfigTemplate
      • BatchNormalizationQuantizedTanhConfigTemplate.format()
    • BatchNormalizationQuantizedTanhFunctionTemplate
      • BatchNormalizationQuantizedTanhFunctionTemplate.format()
    • MergeBatchNormAndQuantizedTanh
      • MergeBatchNormAndQuantizedTanh.match()
      • MergeBatchNormAndQuantizedTanh.transform()
    • QuantizeDenseOutput
      • QuantizeDenseOutput.match()
      • QuantizeDenseOutput.transform()
    • register_bn_quant()
  • hls4ml.backends.catapult.passes.broadcast_stream module
    • Broadcast
      • Broadcast.initialize()
    • BroadcastConfigTemplate
      • BroadcastConfigTemplate.format()
    • BroadcastFunctionTemplate
      • BroadcastFunctionTemplate.format()
    • BroadcastStream
      • BroadcastStream.match()
      • BroadcastStream.transform()
    • register_broadcast_stream()
  • hls4ml.backends.catapult.passes.conv_same_pad module
    • InsertZeroPaddingBeforeConv1D
      • InsertZeroPaddingBeforeConv1D.match()
      • InsertZeroPaddingBeforeConv1D.name
      • InsertZeroPaddingBeforeConv1D.transform()
    • InsertZeroPaddingBeforeConv2D
      • InsertZeroPaddingBeforeConv2D.match()
      • InsertZeroPaddingBeforeConv2D.name
      • InsertZeroPaddingBeforeConv2D.transform()
  • hls4ml.backends.catapult.passes.conv_stream module
    • GenerateConvStreamingInstructions
      • GenerateConvStreamingInstructions.match()
      • GenerateConvStreamingInstructions.transform()
  • hls4ml.backends.catapult.passes.convolution_templates module
    • Conv1DConfigTemplate
      • Conv1DConfigTemplate.format()
    • Conv1DFunctionTemplate
      • Conv1DFunctionTemplate.format()
    • Conv2DConfigTemplate
      • Conv2DConfigTemplate.format()
    • Conv2DFunctionTemplate
      • Conv2DFunctionTemplate.format()
    • DepthwiseConv1DFunctionTemplate
    • DepthwiseConv2DFunctionTemplate
    • SeparableConv1DConfigTemplate
      • SeparableConv1DConfigTemplate.format()
    • SeparableConv1DFunctionTemplate
      • SeparableConv1DFunctionTemplate.format()
    • SeparableConv2DConfigTemplate
      • SeparableConv2DConfigTemplate.format()
    • SeparableConv2DFunctionTemplate
      • SeparableConv2DFunctionTemplate.format()
  • hls4ml.backends.catapult.passes.convolution_winograd module
    • ApplyWinogradKernelTransformation
      • ApplyWinogradKernelTransformation.match()
      • ApplyWinogradKernelTransformation.transform()
  • hls4ml.backends.catapult.passes.core_templates module
    • ActivationConfigTemplate
      • ActivationConfigTemplate.format()
    • ActivationFunctionTemplate
      • ActivationFunctionTemplate.format()
    • BatchNormalizationConfigTemplate
      • BatchNormalizationConfigTemplate.format()
    • BatchNormalizationFunctionTemplate
      • BatchNormalizationFunctionTemplate.format()
    • DenseConfigTemplate
      • DenseConfigTemplate.format()
    • DenseFunctionTemplate
      • DenseFunctionTemplate.format()
    • HardActivationConfigTemplate
      • HardActivationConfigTemplate.format()
    • PReLUFunctionTemplate
      • PReLUFunctionTemplate.format()
    • ParamActivationConfigTemplate
      • ParamActivationConfigTemplate.format()
    • ParametrizedActivationFunctionTemplate
      • ParametrizedActivationFunctionTemplate.format()
    • SoftmaxConfigTemplate
  • hls4ml.backends.catapult.passes.fifo_depth_optimization module
    • FifoDepthOptimization
      • FifoDepthOptimization.transform()
    • generate_max_depth_file()
    • get_vcd_data()
    • populate_values()
    • set_big_fifos()
    • set_fifo_depth()
  • hls4ml.backends.catapult.passes.garnet_templates module
    • GarNetConfigTemplate
      • GarNetConfigTemplate.format()
      • GarNetConfigTemplate.get_transforms_config()
    • GarNetFunctionTemplate
      • GarNetFunctionTemplate.format()
    • GarNetStackConfigTemplate
      • GarNetStackConfigTemplate.get_transforms_config()
    • GarNetStackFunctionTemplate
  • hls4ml.backends.catapult.passes.merge_templates module
    • ConcatenateConfigTemplate
      • ConcatenateConfigTemplate.format()
    • DotConfigTemplate
      • DotConfigTemplate.format()
    • MergeConfigTemplate
      • MergeConfigTemplate.format()
    • MergeFunctionTemplate
      • MergeFunctionTemplate.format()
  • hls4ml.backends.catapult.passes.pointwise module
    • OptimizePointwiseConv
      • OptimizePointwiseConv.match()
      • OptimizePointwiseConv.transform()
    • PointwiseConv1DConfigTemplate
    • PointwiseConv1DFunctionTemplate
    • PointwiseConv2DConfigTemplate
    • PointwiseConv2DFunctionTemplate
    • register_pointwise()
  • hls4ml.backends.catapult.passes.pooling_templates module
    • PoolingConfigTemplate
      • PoolingConfigTemplate.format()
    • PoolingFunctionTemplate
      • PoolingFunctionTemplate.format()
  • hls4ml.backends.catapult.passes.quantization_templates module
    • ApplyAlphaConfigTemplate
      • ApplyAlphaConfigTemplate.format()
    • ApplyAlphaFunctionTemplate
      • ApplyAlphaFunctionTemplate.format()
  • hls4ml.backends.catapult.passes.recurrent_templates module
    • RecurrentConfigTemplate
      • RecurrentConfigTemplate.format()
    • RecurrentFunctionTemplate
      • RecurrentFunctionTemplate.format()
  • hls4ml.backends.catapult.passes.reshaping_templates module
    • ResizeConfigTemplate
      • ResizeConfigTemplate.format()
    • ResizeFunctionTemplate
      • ResizeFunctionTemplate.format()
    • TransposeConfigTemplate
      • TransposeConfigTemplate.format()
    • TransposeFunctionTemplate
      • TransposeFunctionTemplate.format()
    • ZeroPaddingConfigTemplate
      • ZeroPaddingConfigTemplate.format()
    • ZeroPaddingFunctionTemplate
      • ZeroPaddingFunctionTemplate.format()
  • hls4ml.backends.catapult.passes.resource_strategy module
    • ApplyResourceStrategy
      • ApplyResourceStrategy.match()
      • ApplyResourceStrategy.transform()
  • hls4ml.backends.catapult.passes.transform_types module
    • TransformTypes
      • TransformTypes.transform()
  • Module contents

Submodules

hls4ml.backends.catapult.catapult_backend module

class hls4ml.backends.catapult.catapult_backend.CatapultBackend

Bases: FPGABackend

build(model, reset=False, csim=True, synth=True, cosim=False, validation=False, vhdl=False, verilog=True, export=False, vsynth=False, fifo_opt=False, bitfile=False, ran_frame=5, sw_opt=False, power=False, da=False, bup=False)

create_initial_config(tech='fpga', part='xcku115-flvb2104-2-i', asiclibs='nangate-45nm', fifo=None, clock_period=5, io_type='io_parallel')

Create the minimal conversion config for the backend.

Subclasses should implement this method to provide the initial configuration for the conversion.

get_default_flow()

The name of the default flow of the backend.

Default flow is used as the conversion target if the target flow has not been specified.

get_writer_flow()

init_base_layer(layer)

init_conv1d(layer)

init_conv2d(layer)

init_dense(layer)

init_depconv2d(layer)

init_embed(layer)

init_garnet(layer)

init_garnet_stack(layer)

init_global_pooling1d(layer)

init_global_pooling2d(layer)

init_gru(layer)

init_lstm(layer)

init_pooling1d(layer)

init_pooling2d(layer)

init_sepconv1d(layer)

init_sepconv2d(layer)

init_softmax(layer)

hls4ml.backends.catapult.catapult_types module

class hls4ml.backends.catapult.catapult_types.CatapultArrayVariableConverter(type_converter)

Bases: ArrayVariableConverter

class hls4ml.backends.catapult.catapult_types.CatapultArrayVariableDefinition

Bases: VariableDefinition

definition_cpp(name_suffix='', as_reference=False)

class hls4ml.backends.catapult.catapult_types.CatapultInplaceArrayVariableConverter(type_converter)

Bases: ArrayVariableConverter

class hls4ml.backends.catapult.catapult_types.CatapultInplaceArrayVariableDefinition

Bases: VariableDefinition

definition_cpp()

class hls4ml.backends.catapult.catapult_types.CatapultInplaceStreamVariableConverter(type_converter)

Bases: InplaceStreamVariableConverter

class hls4ml.backends.catapult.catapult_types.CatapultInplaceStreamVariableDefinition

Bases: VariableDefinition

definition_cpp()

class hls4ml.backends.catapult.catapult_types.CatapultStreamVariableConverter(type_converter)

Bases: StreamVariableConverter

class hls4ml.backends.catapult.catapult_types.CatapultStreamVariableDefinition

Bases: VariableDefinition

definition_cpp(name_suffix='', as_reference=False)

class hls4ml.backends.catapult.catapult_types.CatapultStructMemberVariableConverter(type_converter)

Bases: StructMemberVariableConverter

class hls4ml.backends.catapult.catapult_types.CatapultStructMemberVariableDefinition

Bases: VariableDefinition

definition_cpp(name_suffix='', as_reference=False)

Module contents