START_HERE.md

Start Here - InterfaceML

Minimal navigation for the core package docs.

---

Use InterfaceML

• Project overview and installation: README.md
• 5-minute usage examples (CLI / Web / API): QUICK_START.md
• End-to-end tutorial: docs/GETTING_STARTED.md
• Canonical core APIs live in interfaceml/core; legacy CLI scripts in build_heterojunctions/ delegate to core when available.

---

Layer splitting

• Practical guide: docs/LAYER_SPLITTING.md
• Algorithm details (smart splitting): docs/SMART_SPLITTING_ALGORITHM.md

---

Math and Algorithms

• Mathematical and algorithmic overview: docs/MATHEMATICAL_OVERVIEW.md

---

CLI reference

• Full CLI/options reference: build_heterojunctions/README.md

---

Templates (optional)

• Templates: templates/
• How to use templates: templates/README_templates.md

---

Documentation map

InterfaceML/
|-- README.md
|-- QUICK_START.md
|-- START_HERE.md
|-- docs/
|   |-- GETTING_STARTED.md
|   |-- LAYER_SPLITTING.md
|   |-- MATHEMATICAL_OVERVIEW.md
|   `-- SMART_SPLITTING_ALGORITHM.md
|-- build_heterojunctions/
|   `-- README.md
`-- templates/
    |-- new_cli_tool_template.py
    |-- new_core_module_template.py
    `-- README_templates.md