hls4ml.backends.vivado package

Subpackages

• hls4ml.backends.vivado.passes package
  • Submodules
  • hls4ml.backends.vivado.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.vivado.passes.broadcast_stream module
    • Broadcast
      • Broadcast.initialize()
    • BroadcastConfigTemplate
      • BroadcastConfigTemplate.format()
    • BroadcastFunctionTemplate
      • BroadcastFunctionTemplate.format()
    • BroadcastStream
      • BroadcastStream.match()
      • BroadcastStream.transform()
    • register_broadcast_stream()
  • hls4ml.backends.vivado.passes.conv_same_pad module
    • InsertZeroPaddingBeforeConv1D
      • InsertZeroPaddingBeforeConv1D.match()
      • InsertZeroPaddingBeforeConv1D.name
      • InsertZeroPaddingBeforeConv1D.transform()
    • InsertZeroPaddingBeforeConv2D
      • InsertZeroPaddingBeforeConv2D.match()
      • InsertZeroPaddingBeforeConv2D.name
      • InsertZeroPaddingBeforeConv2D.transform()
  • hls4ml.backends.vivado.passes.conv_stream module
    • GenerateConvStreamingInstructions
      • GenerateConvStreamingInstructions.match()
      • GenerateConvStreamingInstructions.transform()
  • hls4ml.backends.vivado.passes.convolution_templates module
    • Conv1DConfigTemplate
      • Conv1DConfigTemplate.format()
      • Conv1DConfigTemplate.match()
    • Conv1DFunctionTemplate
      • Conv1DFunctionTemplate.format()
      • Conv1DFunctionTemplate.match()
    • Conv2DConfigTemplate
      • Conv2DConfigTemplate.format()
      • Conv2DConfigTemplate.match()
    • Conv2DFunctionTemplate
      • Conv2DFunctionTemplate.format()
      • Conv2DFunctionTemplate.match()
    • DepthwiseConv1DFunctionTemplate
    • DepthwiseConv2DFunctionTemplate
    • SeparableConv1DConfigTemplate
      • SeparableConv1DConfigTemplate.format()
    • SeparableConv1DFunctionTemplate
      • SeparableConv1DFunctionTemplate.format()
    • SeparableConv2DConfigTemplate
      • SeparableConv2DConfigTemplate.format()
    • SeparableConv2DFunctionTemplate
      • SeparableConv2DFunctionTemplate.format()
  • hls4ml.backends.vivado.passes.core_templates module
    • ActivationConfigTemplate
      • ActivationConfigTemplate.format()
    • ActivationFunctionTemplate
      • ActivationFunctionTemplate.format()
    • BatchNormalizationConfigTemplate
      • BatchNormalizationConfigTemplate.format()
    • BatchNormalizationFunctionTemplate
      • BatchNormalizationFunctionTemplate.format()
    • DenseConfigTemplate
      • DenseConfigTemplate.format()
      • DenseConfigTemplate.match()
    • DenseFunctionTemplate
      • DenseFunctionTemplate.format()
      • DenseFunctionTemplate.match()
    • HardActivationConfigTemplate
      • HardActivationConfigTemplate.format()
    • PReLUFunctionTemplate
      • PReLUFunctionTemplate.format()
    • ParamActivationConfigTemplate
      • ParamActivationConfigTemplate.format()
    • ParametrizedActivationFunctionTemplate
      • ParametrizedActivationFunctionTemplate.format()
    • SoftmaxConfigTemplate
      • SoftmaxConfigTemplate.format()
    • SoftmaxFunctionTemplate
      • SoftmaxFunctionTemplate.format()
  • hls4ml.backends.vivado.passes.distributed_arithmetic module
    • DALatencyConvTemplate
      • DALatencyConvTemplate.match()
      • DALatencyConvTemplate.transform()
    • DALatencyDenseTemplate
      • DALatencyDenseTemplate.match()
      • DALatencyDenseTemplate.transform()
    • DistributedArithmeticCodegen
      • DistributedArithmeticCodegen.match()
      • DistributedArithmeticCodegen.transform()
    • DistributedArithmeticEinsumCodegen
      • DistributedArithmeticEinsumCodegen.match()
      • DistributedArithmeticEinsumCodegen.transform()
    • FuseQuantizerIntoDALayers
      • FuseQuantizerIntoDALayers.match()
      • FuseQuantizerIntoDALayers.transform()
    • add_kernel_wrapper()
    • get_kernel_inp_kif()
  • hls4ml.backends.vivado.passes.einsum module
    • EinsumConfigTemplate
      • EinsumConfigTemplate.format()
    • EinsumFunctionTemplate
      • EinsumFunctionTemplate.format()
  • hls4ml.backends.vivado.passes.einsum_dense module
    • EinsumDenseConfigTemplate
      • EinsumDenseConfigTemplate.dense_config()
      • EinsumDenseConfigTemplate.format()
    • EinsumDenseFunctionTemplate
      • EinsumDenseFunctionTemplate.format()
  • hls4ml.backends.vivado.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.vivado.passes.garnet_templates module
    • GarNetConfigTemplate
      • GarNetConfigTemplate.format()
      • GarNetConfigTemplate.get_transforms_config()
    • GarNetFunctionTemplate
      • GarNetFunctionTemplate.format()
    • GarNetStackConfigTemplate
      • GarNetStackConfigTemplate.get_transforms_config()
    • GarNetStackFunctionTemplate
  • hls4ml.backends.vivado.passes.merge_templates module
    • ConcatenateConfigTemplate
      • ConcatenateConfigTemplate.format()
    • DotConfigTemplate
      • DotConfigTemplate.format()
    • MergeConfigTemplate
      • MergeConfigTemplate.format()
    • MergeFunctionTemplate
      • MergeFunctionTemplate.format()
  • hls4ml.backends.vivado.passes.pipeline_style module
    • SetPipelineStyle
      • SetPipelineStyle.transform()
  • hls4ml.backends.vivado.passes.pointwise module
    • OptimizePointwiseConv
      • OptimizePointwiseConv.match()
      • OptimizePointwiseConv.transform()
    • PointwiseConv1DConfigTemplate
    • PointwiseConv1DFunctionTemplate
    • PointwiseConv2DConfigTemplate
    • PointwiseConv2DFunctionTemplate
    • register_pointwise()
  • hls4ml.backends.vivado.passes.pointwise_codegen module
    • GeneratePointwiseConv1D
      • GeneratePointwiseConv1D.match()
      • GeneratePointwiseConv1D.transform()
    • generate_pointwise_conv1d_fn()
  • hls4ml.backends.vivado.passes.pooling_templates module
    • PoolingConfigTemplate
      • PoolingConfigTemplate.format()
    • PoolingFunctionTemplate
      • PoolingFunctionTemplate.format()
  • hls4ml.backends.vivado.passes.quantization_templates module
    • ApplyAlphaConfigTemplate
      • ApplyAlphaConfigTemplate.format()
    • ApplyAlphaFunctionTemplate
      • ApplyAlphaFunctionTemplate.format()
  • hls4ml.backends.vivado.passes.recurrent_templates module
    • RecurrentConfigTemplate
      • RecurrentConfigTemplate.format()
    • RecurrentFunctionTemplate
      • RecurrentFunctionTemplate.format()
    • TimeDistributedConfigTemplate
      • TimeDistributedConfigTemplate.format()
    • TimeDistributedFunctionTemplate
      • TimeDistributedFunctionTemplate.format()
  • hls4ml.backends.vivado.passes.reshaping_templates module
    • CroppingConfigTemplate
      • CroppingConfigTemplate.format()
    • CroppingFunctionTemplate
      • CroppingFunctionTemplate.format()
    • ResizeConfigTemplate
      • ResizeConfigTemplate.format()
    • ResizeFunctionTemplate
      • ResizeFunctionTemplate.format()
    • TransposeConfigTemplate
      • TransposeConfigTemplate.format()
    • TransposeFunctionTemplate
      • TransposeFunctionTemplate.format()
    • ZeroPaddingConfigTemplate
      • ZeroPaddingConfigTemplate.format()
    • ZeroPaddingFunctionTemplate
      • ZeroPaddingFunctionTemplate.format()
  • hls4ml.backends.vivado.passes.resource_strategy module
    • ApplyResourceStrategy
      • ApplyResourceStrategy.match()
      • ApplyResourceStrategy.transform()
  • hls4ml.backends.vivado.passes.transform_types module
    • TransformTypes
      • TransformTypes.transform()
  • hls4ml.backends.vivado.passes.unrolled_codegen module
    • GenerateUnrolledDenseResource
      • GenerateUnrolledDenseResource.match()
      • GenerateUnrolledDenseResource.transform()
  • Module contents

Submodules

hls4ml.backends.vivado.vivado_backend module

class hls4ml.backends.vivado.vivado_backend.VivadoBackend

Bases: FPGABackend

build(model, reset=False, csim=True, synth=True, cosim=False, validation=False, export=False, vsynth=False, fifo_opt=False)

create_initial_config(part='xcvu13p-flga2577-2-e', clock_period=5, clock_uncertainty='12.5%', io_type='io_parallel', namespace=None, write_weights_txt=True, write_tar=False, tb_output_stream='both', **_)

Create initial configuration of the Vivado backend.

Parameters:

• part (str, optional) – The FPGA part to be used. Defaults to ‘xcvu13p-flga2577-2-e’.

• clock_period (int, optional) – The clock period. Defaults to 5.

• clock_uncertainty (str, optional) – The clock uncertainty. Defaults to 12.5%.

• io_type (str, optional) – Type of implementation used. One of ‘io_parallel’ or ‘io_stream’. Defaults to ‘io_parallel’.

• namespace (str, optional) – If defined, place all generated code within a namespace. Defaults to None.

• write_weights_txt (bool, optional) – If True, writes weights to .txt files which speeds up compilation. Defaults to True.

• write_tar (bool, optional) – If True, compresses the output directory into a .tar.gz file. Defaults to False.

• tb_output_stream (str, optional) – Controls where to write the output. Options are ‘stdout’, ‘file’ and ‘both’. Defaults to ‘both’.

Returns:

initial configuration.

Return type:

dict

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_depconv1d(layer)

init_depconv2d(layer)

init_einsum(layer: Einsum) → None

init_einsum_dense(layer: EinsumDense) → None

init_embed(layer)

init_garnet(layer)

init_garnet_stack(layer)

init_gru(layer)

init_lstm(layer)

init_pooling1d(layer)

init_pooling2d(layer)

init_sepconv1d(layer)

init_sepconv2d(layer)

init_time_distributed(layer)

hls4ml.backends.vivado.vivado_types module

class hls4ml.backends.vivado.vivado_types.VivadoArrayVariableConverter(type_converter)

Bases: ArrayVariableConverter

class hls4ml.backends.vivado.vivado_types.VivadoArrayVariableDefinition

Bases: VariableDefinition

definition_cpp(name_suffix='', as_reference=False)

class hls4ml.backends.vivado.vivado_types.VivadoInplaceArrayVariableConverter(type_converter)

Bases: ArrayVariableConverter

class hls4ml.backends.vivado.vivado_types.VivadoInplaceArrayVariableDefinition

Bases: VariableDefinition

definition_cpp()

class hls4ml.backends.vivado.vivado_types.VivadoInplaceStreamVariableConverter(type_converter)

Bases: InplaceStreamVariableConverter

class hls4ml.backends.vivado.vivado_types.VivadoInplaceStreamVariableDefinition

Bases: VariableDefinition

definition_cpp()

class hls4ml.backends.vivado.vivado_types.VivadoStreamVariableConverter(type_converter)

Bases: StreamVariableConverter

class hls4ml.backends.vivado.vivado_types.VivadoStreamVariableDefinition

Bases: VariableDefinition

definition_cpp(name_suffix='', as_reference=False)

Module contents