Skip to content

[hec-assembler]: Update README.md #154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 21, 2025
Merged

[hec-assembler]: Update README.md #154

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eeae56f
[hec-assembler]: Update README.md
joserochh Nov 20, 2025
b48d152
Merge branch 'main' into joserochh-patch-readme
joserochh Nov 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions assembler_tools/hec-assembler-tools/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# HERACLES Code Generation Framework (Reference Implementation)

The tools in this directory are the reference implementation of and Assembler codegenerator that takes a pre-generated Polynomial Instruction Set Architecture (P-ISA) program containing instructions that use an abstract, flat memory model for polynomial operations, such as those applied in homomorphic encryption (HE), and maps them to a corresponding set of instructions compatible with the HERACLES architecture, accounting for hardware restrictions, including memory management for the HERACLES memory model.
The tools in this directory are the reference implementation of an Assembler codegenerator that takes a pre-generated Polynomial Instruction Set Architecture (P-ISA) program containing instructions that use an abstract, flat memory model for polynomial operations, such as those applied in homomorphic encryption (HE), and maps them to a corresponding set of instructions compatible with the HERACLES architecture, accounting for hardware restrictions, including memory management for the HERACLES memory model.

## Table of Contents
1. [Dependencies](#dependencies)
Expand Down Expand Up @@ -65,8 +65,8 @@ Given a P-ISA kernel (`filename.csv`) and corresponding memory mapping file (`fi
python3 he_prep.py filename.csv
```

The preprocessing program can split kernels (see he_prep.py -h for details). Use the split options if you encounter physical memory constraints.

* The preprocessing program can split kernels (see he_prep.py -h for details). Use the split options if you encounter physical memory constraints.
```bash
# pre-process kernel: outputs filename1.tw_<#>.csv & filename1.tw_deps_<#>.csv
python3 he_prep.py filename1.csv --mem_file filename0.mem --split_vars_limit <val> --split_inst_limit <val>
```
Expand Down
Loading