Logo

Contents:

  • Project Status
  • Installation Guide
  • Getting Started with alkaid
  • Alkaid Low-Level Intermediate Representation (ALIR)
  • CMVM Optimization Algorithm
  • Conversion Plugin
  • FAQs

API Reference:

  • alkaid package
    • Subpackages
      • alkaid.cmvm package
      • alkaid.codegen package
        • Subpackages
        • Module contents
      • alkaid.converter package
      • alkaid.trace package
      • alkaid.typing package
    • Submodules
    • alkaid.types module
    • Module contents
alkaid
  • alkaid package
  • alkaid.codegen package
  • Edit on GitHub

alkaid.codegen package

Subpackages

  • alkaid.codegen.hls package
    • Submodules
    • alkaid.codegen.hls.hls_codegen module
      • gen_mem_def()
      • gen_table_name_defline()
      • get_io_types()
      • get_typestr_fn()
      • hls_logic_and_bridge_gen()
      • kif_to_hlslib_type()
      • kif_to_oneapi_type()
      • kif_to_vitis_type()
      • output_gen()
      • ssa_gen()
    • alkaid.codegen.hls.hls_model module
      • HLSModel
        • HLSModel.compile()
        • HLSModel.predict()
        • HLSModel.write()
    • Module contents
  • alkaid.codegen.rtl package
    • Subpackages
      • alkaid.codegen.rtl.verilog package
        • Submodules
        • alkaid.codegen.rtl.verilog.comb module
        • alkaid.codegen.rtl.verilog.io_wrapper module
        • alkaid.codegen.rtl.verilog.pipeline module
        • Module contents
      • alkaid.codegen.rtl.vhdl package
        • Submodules
        • alkaid.codegen.rtl.vhdl.comb module
        • alkaid.codegen.rtl.vhdl.io_wrapper module
        • alkaid.codegen.rtl.vhdl.pipeline module
        • Module contents
    • Submodules
    • alkaid.codegen.rtl.rtl_model module
      • RTLModel
        • RTLModel.compile()
        • RTLModel.predict()
        • RTLModel.write()
      • at_path
      • binder_gen()
      • canon_name()
      • get_io_kifs()
      • verilog_comb_logic_gen_xls()
    • Module contents
  • alkaid.codegen.xls package
    • Submodules
    • alkaid.codegen.xls.xls_codegen module
      • build_xls_function()
      • build_xls_io_wrapper()
      • negate()
      • shift_adder()
    • alkaid.codegen.xls.xls_model module
      • XLSModel
        • XLSModel.compile()
        • XLSModel.jit()
        • XLSModel.predict()
    • Module contents

Module contents

Previous Next

© Copyright 2025-2026, Chang Sun.

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