Logo

Introduction

  • Introduction
  • Status and Features
  • Setup and Quick Start
  • Frequently asked questions
  • Release Notes
  • Citation, Acknowledgments, and Contributors

User Guide

  • Concepts
  • Configuration
  • Command Line Interface (deprecated)
  • Saving/Loading hls4ml models

Frontends

  • Keras and QKeras
  • PyTorch and Brevitas
  • ONNX and QONNX

Backends

  • Vivado/Vitis
  • VivadoAccelerator
  • oneAPI
  • Catapult
  • Quartus
  • SymbolicExpression

Advanced Features

  • Profiling
  • Automatic precision inference
  • High Granularity Quantization (HGQ)
  • FIFO Buffer Depth Optimization
  • Extension API
  • Hardware-aware Optimization API
  • Loading weights from external BRAM

Internals

  • Internal representation
  • ModelGraph Class
  • Optimizer Passes and Flows
  • Layer attributes

Autogenerated API Reference

  • hls4ml.backends package
  • hls4ml.converters package
  • hls4ml.model package
  • hls4ml.optimization package
    • Subpackages
    • Module contents
  • hls4ml.report package
  • hls4ml.utils package
  • hls4ml.writer package
hls4ml
  • hls4ml.optimization package
  • Edit on GitHub

hls4ml.optimization package

Subpackages

  • hls4ml.optimization.dsp_aware_pruning package
    • Subpackages
      • hls4ml.optimization.dsp_aware_pruning.keras package
        • Submodules
        • hls4ml.optimization.dsp_aware_pruning.keras.builder module
        • hls4ml.optimization.dsp_aware_pruning.keras.config module
        • hls4ml.optimization.dsp_aware_pruning.keras.masking module
        • hls4ml.optimization.dsp_aware_pruning.keras.reduction module
        • hls4ml.optimization.dsp_aware_pruning.keras.regularizers module
        • hls4ml.optimization.dsp_aware_pruning.keras.utils module
        • Module contents
      • hls4ml.optimization.dsp_aware_pruning.objectives package
        • Submodules
        • hls4ml.optimization.dsp_aware_pruning.objectives.gpu_objectives module
        • hls4ml.optimization.dsp_aware_pruning.objectives.vivado_objectives module
        • Module contents
    • Submodules
    • hls4ml.optimization.dsp_aware_pruning.attributes module
    • hls4ml.optimization.dsp_aware_pruning.config module
      • SUPPORTED_STRUCTURES
        • SUPPORTED_STRUCTURES.BLOCK
        • SUPPORTED_STRUCTURES.PATTERN
        • SUPPORTED_STRUCTURES.STRUCTURED
        • SUPPORTED_STRUCTURES.UNSTRUCTURED
    • hls4ml.optimization.dsp_aware_pruning.knapsack module
    • hls4ml.optimization.dsp_aware_pruning.scheduler module
    • Module contents

Module contents

Previous Next

© Copyright 2025, Fast Machine Learning Lab.

Built with Sphinx using a theme provided by Read the Docs.