hls4ml package

Subpackages

• hls4ml.backends package
  • Subpackages
    • hls4ml.backends.catapult package
      • Subpackages
      • Submodules
      • hls4ml.backends.catapult.catapult_backend module
      • hls4ml.backends.catapult.catapult_types module
      • Module contents
    • hls4ml.backends.fpga package
      • Subpackages
      • Submodules
      • hls4ml.backends.fpga.fpga_backend module
      • hls4ml.backends.fpga.fpga_layers module
      • hls4ml.backends.fpga.fpga_types module
      • Module contents
    • hls4ml.backends.oneapi package
      • Subpackages
      • Submodules
      • hls4ml.backends.oneapi.oneapi_backend module
      • hls4ml.backends.oneapi.oneapi_template module
      • hls4ml.backends.oneapi.oneapi_types module
      • Module contents
    • hls4ml.backends.quartus package
      • Subpackages
      • Submodules
      • hls4ml.backends.quartus.quartus_backend module
      • hls4ml.backends.quartus.quartus_types module
      • Module contents
    • hls4ml.backends.symbolic package
      • Subpackages
      • Submodules
      • hls4ml.backends.symbolic.symbolic_backend module
      • Module contents
    • hls4ml.backends.vitis package
      • Subpackages
      • Submodules
      • hls4ml.backends.vitis.vitis_backend module
      • Module contents
    • hls4ml.backends.vivado package
      • Subpackages
      • Submodules
      • hls4ml.backends.vivado.vivado_backend module
      • hls4ml.backends.vivado.vivado_types module
      • Module contents
    • hls4ml.backends.vivado_accelerator package
      • Subpackages
      • Submodules
      • hls4ml.backends.vivado_accelerator.vivado_accelerator_backend module
      • hls4ml.backends.vivado_accelerator.vivado_accelerator_config module
      • Module contents
  • Submodules
  • hls4ml.backends.backend module
    • Backend
      • Backend.create_initial_config()
      • Backend.create_layer_class()
      • Backend.get_available_flows()
      • Backend.get_custom_source()
      • Backend.get_default_flow()
      • Backend.register_pass()
      • Backend.register_source()
      • Backend.register_template()
    • get_available_backends()
    • get_backend()
    • register_backend()
  • hls4ml.backends.template module
    • FunctionCallTemplate
      • FunctionCallTemplate.transform()
    • LayerConfigTemplate
    • Template
      • Template.format()
      • Template.get_name()
      • Template.match()
      • Template.transform()
  • Module contents
• hls4ml.cli package
  • Module contents
    • main()
• hls4ml.contrib package
  • Submodules
  • hls4ml.contrib.garnet module
  • Module contents
• hls4ml.converters package
  • Subpackages
    • hls4ml.converters.keras package
      • Submodules
      • hls4ml.converters.keras.convolution module
      • hls4ml.converters.keras.core module
      • hls4ml.converters.keras.graph module
      • hls4ml.converters.keras.hgq_proxy_model module
      • hls4ml.converters.keras.merge module
      • hls4ml.converters.keras.model module
      • hls4ml.converters.keras.pooling module
      • hls4ml.converters.keras.qkeras module
      • hls4ml.converters.keras.recurrent module
      • hls4ml.converters.keras.reshape module
      • hls4ml.converters.keras.reshaping module
      • Module contents
    • hls4ml.converters.keras_v3 package
      • Subpackages
      • Submodules
      • hls4ml.converters.keras_v3.conv module
      • hls4ml.converters.keras_v3.core module
      • hls4ml.converters.keras_v3.einsum_dense module
      • hls4ml.converters.keras_v3.merge module
      • hls4ml.converters.keras_v3.pooling module
      • Module contents
    • hls4ml.converters.onnx package
      • Submodules
      • hls4ml.converters.onnx.convolution module
      • hls4ml.converters.onnx.core module
      • hls4ml.converters.onnx.merge module
      • hls4ml.converters.onnx.pooling module
      • hls4ml.converters.onnx.reshape module
      • Module contents
    • hls4ml.converters.pytorch package
      • Submodules
      • hls4ml.converters.pytorch.convolution module
      • hls4ml.converters.pytorch.core module
      • hls4ml.converters.pytorch.merge module
      • hls4ml.converters.pytorch.pooling module
      • hls4ml.converters.pytorch.recurrent module
      • hls4ml.converters.pytorch.reshape module
      • Module contents
  • Submodules
  • hls4ml.converters.keras_v2_to_hls module
    • KerasFileReader
      • KerasFileReader.get_weights_data()
    • KerasModelReader
      • KerasModelReader.get_weights_data()
    • KerasNestedFileReader
    • KerasReader
      • KerasReader.get_weights_data()
    • KerasWrappedLayerFileReader
    • KerasWrappedLayerReader
      • KerasWrappedLayerReader.get_weights_data()
    • get_layer_handlers()
    • get_model_arch()
    • get_supported_keras_layers()
    • get_weights_data()
    • keras_handler()
    • keras_v2_to_hls()
    • parse_default_keras_layer()
    • parse_keras_model()
    • register_keras_layer_handler()
  • hls4ml.converters.keras_v3_to_hls module
    • KerasV3HandlerDispatcher
      • KerasV3HandlerDispatcher.v2_call()
      • KerasV3HandlerDispatcher.v3_call()
    • UniqueName
      • UniqueName.next_name()
      • UniqueName.reset()
    • get_io_tensors()
    • keras_v3_to_hls()
    • parse_keras_v3_model()
    • resolve_dependency_relation()
  • hls4ml.converters.onnx_to_hls module
    • compute_pads_1d()
    • compute_pads_2d()
    • get_constant_value()
    • get_global_input_shape()
    • get_input_shape()
    • get_onnx_attribute()
    • get_out_layer_name()
    • get_supported_onnx_layers()
    • onnx_handler()
    • onnx_to_hls()
    • parse_onnx_model()
    • register_onnx_layer_handler()
    • replace_char_inconsitency()
    • sanitize_layer_name()
  • hls4ml.converters.pytorch_to_hls module
    • PyTorchFileReader
    • PyTorchModelReader
      • PyTorchModelReader.get_weights_data()
    • get_supported_pytorch_layers()
    • get_weights_data()
    • parse_pytorch_model()
    • pytorch_handler()
    • pytorch_to_hls()
    • register_pytorch_layer_handler()
  • hls4ml.converters.utils module
    • compute_padding_1d()
    • compute_padding_1d_pytorch()
    • compute_padding_2d()
    • compute_padding_2d_pytorch()
    • parse_data_format()
  • Module contents
    • convert_from_config()
    • convert_from_keras_model()
    • convert_from_onnx_model()
    • convert_from_pytorch_model()
    • convert_from_symbolic_expression()
    • link_existing_project()
    • load_saved_model()
    • parse_yaml_config()
• hls4ml.model package
  • Subpackages
    • hls4ml.model.flow package
      • Submodules
      • hls4ml.model.flow.flow module
      • Module contents
    • hls4ml.model.optimizer package
      • Subpackages
      • Submodules
      • hls4ml.model.optimizer.optimizer module
      • Module contents
  • Submodules
  • hls4ml.model.attributes module
    • Attribute
      • Attribute.config_name
      • Attribute.validate_value()
    • AttributeDict
    • AttributeMapping
    • ChoiceAttribute
      • ChoiceAttribute.validate_value()
    • CodeAttrubute
    • CodeMapping
    • ConfigurableAttribute
    • TypeAttribute
    • TypeMapping
    • VariableMapping
    • WeightAttribute
    • WeightMapping
  • hls4ml.model.graph module
    • HLSConfig
      • HLSConfig.deserialize()
      • HLSConfig.get_bram_size()
      • HLSConfig.get_compression()
      • HLSConfig.get_config_value()
      • HLSConfig.get_conv_implementation()
      • HLSConfig.get_layer_config()
      • HLSConfig.get_layer_config_value()
      • HLSConfig.get_output_dir()
      • HLSConfig.get_precision()
      • HLSConfig.get_project_dir()
      • HLSConfig.get_project_name()
      • HLSConfig.get_reuse_factor()
      • HLSConfig.get_strategy()
      • HLSConfig.get_target_cycles()
      • HLSConfig.get_writer_config()
      • HLSConfig.is_resource_strategy()
      • HLSConfig.parse_name_config()
      • HLSConfig.serialize()
      • HLSConfig.set_name_config()
    • ModelGraph
      • ModelGraph.apply_flow()
      • ModelGraph.build()
      • ModelGraph.compile()
      • ModelGraph.deserialize()
      • ModelGraph.from_layer_list()
      • ModelGraph.from_saved_state()
      • ModelGraph.get_input_variables()
      • ModelGraph.get_layer_output_variable()
      • ModelGraph.get_layers()
      • ModelGraph.get_output_variables()
      • ModelGraph.get_weight_variables()
      • ModelGraph.insert_node()
      • ModelGraph.make_node()
      • ModelGraph.next_layer()
      • ModelGraph.predict()
      • ModelGraph.register_output_variable()
      • ModelGraph.remove_node()
      • ModelGraph.replace_node()
      • ModelGraph.save()
      • ModelGraph.serialize()
      • ModelGraph.split_node()
      • ModelGraph.trace()
      • ModelGraph.write()
    • MultiModelGraph
      • MultiModelGraph.build()
      • MultiModelGraph.compile()
      • MultiModelGraph.from_model_graph()
      • MultiModelGraph.get_input_variables()
      • MultiModelGraph.get_layers()
      • MultiModelGraph.parse_nn_config()
      • MultiModelGraph.predict()
      • MultiModelGraph.trace()
      • MultiModelGraph.write()
      • MultiModelGraph.write_tb_inputs()
    • to_multi_model_graph()
  • hls4ml.model.layers module
    • Activation
      • Activation.initialize()
    • ApplyAlpha
      • ApplyAlpha.add_bias()
      • ApplyAlpha.add_weights()
      • ApplyAlpha.initialize()
    • BatchNormOnnx
      • BatchNormOnnx.initialize()
    • BatchNormalization
      • BatchNormalization.initialize()
    • BiasAdd
      • BiasAdd.initialize()
    • Concatenate
      • Concatenate.initialize()
    • Constant
      • Constant.initialize()
    • Conv
      • Conv.initialize()
    • Conv1D
      • Conv1D.initialize()
    • Conv2D
      • Conv2D.initialize()
    • Conv2DBatchnorm
      • Conv2DBatchnorm.initialize()
    • Cropping1D
      • Cropping1D.initialize()
    • Cropping2D
      • Cropping2D.initialize()
    • Dense
      • Dense.initialize()
    • DepthwiseConv1D
      • DepthwiseConv1D.initialize()
    • DepthwiseConv2D
      • DepthwiseConv2D.initialize()
    • Dot
      • Dot.initialize()
    • Einsum
      • Einsum.initialize()
    • EinsumDense
      • EinsumDense.initialize()
    • Embedding
      • Embedding.initialize()
    • GRU
      • GRU.initialize()
    • GarNet
      • GarNet.initialize()
      • GarNet.ref_impl
    • GarNetStack
    • GlobalPooling1D
      • GlobalPooling1D.initialize()
    • GlobalPooling2D
      • GlobalPooling2D.initialize()
    • HardActivation
      • HardActivation.initialize()
    • Input
      • Input.initialize()
    • LSTM
      • LSTM.initialize()
    • Layer
      • Layer.add_bias()
      • Layer.add_output_variable()
      • Layer.add_weights()
      • Layer.add_weights_variable()
      • Layer.class_name
      • Layer.expected_attributes
      • Layer.get_attr()
      • Layer.get_input_node()
      • Layer.get_input_variable()
      • Layer.get_layer_precision()
      • Layer.get_output_nodes()
      • Layer.get_output_use_map()
      • Layer.get_output_variable()
      • Layer.get_variables()
      • Layer.get_weights()
      • Layer.initialize()
      • Layer.serialize_state()
      • Layer.set_attr()
    • LayerGroup
      • LayerGroup.initialize()
    • MatMul
      • MatMul.initialize()
    • Merge
      • Merge.initialize()
    • PReLU
      • PReLU.initialize()
    • ParametrizedActivation
      • ParametrizedActivation.initialize()
    • Pooling1D
      • Pooling1D.initialize()
    • Pooling2D
      • Pooling2D.initialize()
    • Quant
      • Quant.initialize()
    • Reshape
      • Reshape.initialize()
    • Resize
      • Resize.initialize()
    • SeparableConv1D
      • SeparableConv1D.initialize()
    • SeparableConv2D
      • SeparableConv2D.initialize()
    • SimpleRNN
      • SimpleRNN.initialize()
    • Softmax
      • Softmax.initialize()
    • SymbolicExpression
      • SymbolicExpression.initialize()
    • TernaryTanh
      • TernaryTanh.initialize()
    • TimeDistributed
      • TimeDistributed.initialize()
    • Transpose
      • Transpose.initialize()
    • ZeroPadding1D
      • ZeroPadding1D.initialize()
    • ZeroPadding2D
      • ZeroPadding2D.initialize()
    • classproperty
    • register_layer()
  • hls4ml.model.profiling module
  • hls4ml.model.quantizers module
    • BinaryQuantizer
      • BinaryQuantizer.serialize_state()
    • QKerasBinaryQuantizer
      • QKerasBinaryQuantizer.serialize_state()
    • QKerasPO2Quantizer
      • QKerasPO2Quantizer.serialize_state()
    • QKerasQuantizer
      • QKerasQuantizer.serialize_state()
    • QuantNodeQuantizer
      • QuantNodeQuantizer.serialize_state()
    • Quantizer
      • Quantizer.serialize_state()
    • TernaryQuantizer
      • TernaryQuantizer.serialize_state()
  • hls4ml.model.types module
    • CompressedType
      • CompressedType.serialize_state()
    • CompressedWeightVariable
      • CompressedWeightVariable.next()
    • ExponentPrecisionType
    • ExponentType
    • ExponentWeightVariable
      • ExponentWeightVariable.next()
    • FixedPrecisionType
      • FixedPrecisionType.fractional
      • FixedPrecisionType.max
      • FixedPrecisionType.min
      • FixedPrecisionType.rounding_mode
      • FixedPrecisionType.saturation_bits
      • FixedPrecisionType.saturation_mode
      • FixedPrecisionType.serialize_state()
    • InplaceTensorVariable
      • InplaceTensorVariable.deserialize()
      • InplaceTensorVariable.serialize_state()
    • IntegerPrecisionType
      • IntegerPrecisionType.fractional
      • IntegerPrecisionType.integer
      • IntegerPrecisionType.rounding_mode
      • IntegerPrecisionType.saturation_bits
      • IntegerPrecisionType.saturation_mode
    • NamedType
      • NamedType.serialize_state()
    • PackedType
      • PackedType.serialize_state()
    • PrecisionType
      • PrecisionType.serialize_state()
    • RoundingMode
      • RoundingMode.RND
      • RoundingMode.RND_CONV
      • RoundingMode.RND_INF
      • RoundingMode.RND_MIN_INF
      • RoundingMode.RND_ZERO
      • RoundingMode.TRN
      • RoundingMode.TRN_ZERO
      • RoundingMode.from_string()
    • SaturationMode
      • SaturationMode.SAT
      • SaturationMode.SAT_SYM
      • SaturationMode.SAT_ZERO
      • SaturationMode.WRAP
      • SaturationMode.from_string()
    • Serializable
      • Serializable.deserialize()
      • Serializable.serialize()
      • Serializable.serialize_class_name()
      • Serializable.serialize_state()
    • Source
      • Source.serialize_class_name()
      • Source.serialize_state()
    • TensorVariable
      • TensorVariable.deserialize()
      • TensorVariable.get_shape()
      • TensorVariable.serialize_state()
      • TensorVariable.size()
      • TensorVariable.size_cpp()
    • UnspecifiedPrecisionType
    • Variable
      • Variable.serialize_state()
    • WeightVariable
      • WeightVariable.deserialize()
      • WeightVariable.next()
      • WeightVariable.serialize_state()
      • WeightVariable.update_precision()
    • XnorPrecisionType
    • find_minimum_width()
  • Module contents
• hls4ml.optimization package
  • Subpackages
    • hls4ml.optimization.dsp_aware_pruning package
      • Subpackages
      • Submodules
      • hls4ml.optimization.dsp_aware_pruning.attributes module
      • hls4ml.optimization.dsp_aware_pruning.config module
      • hls4ml.optimization.dsp_aware_pruning.knapsack module
      • hls4ml.optimization.dsp_aware_pruning.scheduler module
      • Module contents
  • Module contents
• hls4ml.report package
  • Submodules
  • hls4ml.report.catapult_report module
    • get_latest_project_prj_directory()
    • get_latest_project_version_directory()
    • parse_catapult_report()
    • qofr()
    • read_catapult_report()
  • hls4ml.report.oneapi_report module
    • parse_oneapi_report()
    • print_oneapi_report()
  • hls4ml.report.quartus_report module
    • parse_quartus_report()
    • read_js_object()
    • read_quartus_report()
  • hls4ml.report.vivado_report module
    • aggregate_graph_reports()
    • parse_vivado_report()
    • print_vivado_report()
    • read_vivado_report()
  • Module contents
• hls4ml.utils package
  • Submodules
  • hls4ml.utils.attribute_descriptions module
  • hls4ml.utils.config module
    • config_from_keras_model()
    • config_from_onnx_model()
    • config_from_pytorch_model()
    • create_config()
  • hls4ml.utils.dependency module
    • requires()
  • hls4ml.utils.einsum_utils module
    • EinsumRecipe
      • EinsumRecipe.C
      • EinsumRecipe.I
      • EinsumRecipe.L0
      • EinsumRecipe.L1
      • EinsumRecipe.direct_sum_axis
      • EinsumRecipe.in_transpose_idxs
      • EinsumRecipe.out_interpert_shape
      • EinsumRecipe.out_transpose_idxs
    • einsum()
    • parse_einsum()
  • hls4ml.utils.example_models module
    • fetch_example_list()
    • fetch_example_model()
  • hls4ml.utils.fixed_point_utils module
    • FixedPointEmulator
      • FixedPointEmulator.exp_float()
      • FixedPointEmulator.inv_float()
      • FixedPointEmulator.set_msb_bits()
      • FixedPointEmulator.to_float()
    • ceil_log2()
    • next_pow2()
    • uint_to_binary()
  • hls4ml.utils.link module
    • FilesystemModelGraph
      • FilesystemModelGraph.VariableWrapper
      • FilesystemModelGraph.build()
      • FilesystemModelGraph.compile()
      • FilesystemModelGraph.get_input_variables()
      • FilesystemModelGraph.get_output_variables()
      • FilesystemModelGraph.predict()
  • hls4ml.utils.plot module
    • add_edge()
    • check_pydot()
    • model_to_dot()
    • plot_model()
  • hls4ml.utils.profiling_utils module
  • hls4ml.utils.qinterval module
    • QIntervalArray
      • QIntervalArray.dtype
      • QIntervalArray.from_kif()
      • QIntervalArray.ravel()
      • QIntervalArray.reshape()
      • QIntervalArray.rmatmul()
      • QIntervalArray.sample()
      • QIntervalArray.shape
      • QIntervalArray.to_kif()
      • QIntervalArray.transpose()
    • einsum()
    • minimal_kif()
  • hls4ml.utils.serialization module
    • deserialize_model()
    • serialize_model()
  • hls4ml.utils.simulation_utils module
    • annotate_axis_stream_widths()
    • parse_component_xml()
    • prepare_tb_inputs()
    • prepare_zero_inputs()
    • read_testbench_log()
    • write_verilog_testbench()
  • hls4ml.utils.string_utils module
    • convert_to_pascal_case()
    • convert_to_snake_case()
  • hls4ml.utils.symbolic_utils module
    • LUTFunction
    • generate_operator_complexity()
    • init_pysr_lut_functions()
    • register_pysr_lut_function()
  • hls4ml.utils.torch module
  • hls4ml.utils.transpose_utils module
    • transpose_config_gen()
  • Module contents
• hls4ml.writer package
  • Submodules
  • hls4ml.writer.catapult_writer module
    • CatapultWriter
      • CatapultWriter.print_array_to_cpp()
      • CatapultWriter.write_bridge()
      • CatapultWriter.write_build_script()
      • CatapultWriter.write_defines()
      • CatapultWriter.write_generated_code()
      • CatapultWriter.write_hls()
      • CatapultWriter.write_nnet_utils()
      • CatapultWriter.write_output_dir()
      • CatapultWriter.write_parameters()
      • CatapultWriter.write_project_cpp()
      • CatapultWriter.write_project_header()
      • CatapultWriter.write_tar()
      • CatapultWriter.write_test_bench()
      • CatapultWriter.write_weights()
      • CatapultWriter.write_yml()
  • hls4ml.writer.oneapi_writer module
    • OneAPIWriter
      • OneAPIWriter.get_max_reuse_factor()
      • OneAPIWriter.print_array_to_cpp()
      • OneAPIWriter.write_activation_tables()
      • OneAPIWriter.write_bridge()
      • OneAPIWriter.write_build_script()
      • OneAPIWriter.write_defines()
      • OneAPIWriter.write_hls()
      • OneAPIWriter.write_nnet_utils()
      • OneAPIWriter.write_parameters()
      • OneAPIWriter.write_project_cpp()
      • OneAPIWriter.write_project_dir()
      • OneAPIWriter.write_project_header()
      • OneAPIWriter.write_tar()
      • OneAPIWriter.write_test_bench()
      • OneAPIWriter.write_weights()
      • OneAPIWriter.write_yml()
  • hls4ml.writer.quartus_writer module
    • QuartusWriter
      • QuartusWriter.get_max_reuse_factor()
      • QuartusWriter.next_pow2()
      • QuartusWriter.print_array_to_cpp()
      • QuartusWriter.write_activation_tables()
      • QuartusWriter.write_bridge()
      • QuartusWriter.write_build_script()
      • QuartusWriter.write_defines()
      • QuartusWriter.write_hls()
      • QuartusWriter.write_nnet_utils()
      • QuartusWriter.write_parameters()
      • QuartusWriter.write_project_cpp()
      • QuartusWriter.write_project_dir()
      • QuartusWriter.write_project_header()
      • QuartusWriter.write_tar()
      • QuartusWriter.write_test_bench()
      • QuartusWriter.write_testbench_parallel()
      • QuartusWriter.write_testbench_stream()
      • QuartusWriter.write_weights()
      • QuartusWriter.write_yml()
  • hls4ml.writer.symbolic_writer module
    • SymbolicExpressionWriter
      • SymbolicExpressionWriter.write_build_script()
      • SymbolicExpressionWriter.write_hls()
      • SymbolicExpressionWriter.write_nnet_utils()
  • hls4ml.writer.vitis_writer module
    • VitisWriter
      • VitisWriter.write_board_script_override()
      • VitisWriter.write_build_opts()
      • VitisWriter.write_hls()
      • VitisWriter.write_nnet_utils_overrides()
  • hls4ml.writer.vivado_accelerator_writer module
    • VivadoAcceleratorWriter
      • VivadoAcceleratorWriter.modify_build_script()
      • VivadoAcceleratorWriter.write_axi_wrapper()
      • VivadoAcceleratorWriter.write_board_script()
      • VivadoAcceleratorWriter.write_driver()
      • VivadoAcceleratorWriter.write_hls()
      • VivadoAcceleratorWriter.write_new_tar()
      • VivadoAcceleratorWriter.write_wrapper_test()
  • hls4ml.writer.vivado_writer module
    • VivadoWriter
      • VivadoWriter.print_array_to_cpp()
      • VivadoWriter.write_bridge()
      • VivadoWriter.write_bridge_multigraph()
      • VivadoWriter.write_build_script()
      • VivadoWriter.write_build_script_multigraph()
      • VivadoWriter.write_defines()
      • VivadoWriter.write_generated_code()
      • VivadoWriter.write_hls()
      • VivadoWriter.write_multigraph_weights()
      • VivadoWriter.write_nnet_utils()
      • VivadoWriter.write_parameters()
      • VivadoWriter.write_project_cpp()
      • VivadoWriter.write_project_dir()
      • VivadoWriter.write_project_header()
      • VivadoWriter.write_tar()
      • VivadoWriter.write_test_bench()
      • VivadoWriter.write_weights()
      • VivadoWriter.write_yml()
  • hls4ml.writer.writers module
    • Writer
      • Writer.write_hls()
    • get_writer()
    • register_writer()
  • Module contents

Module contents

hls4ml.reseed(newseed)