Lightning Core Docs Index

Use one of the paths below depending on your goal.

Task Goal Go To Why
Install / First Run Quickstart: Install Set up, build, import, and run your first checks quickly.
Performance / Tuning Advanced: Benchmark Suite Benchmark, tune runtime/session behavior, and inspect profiles.
Capability / Environment Contracts Capability Matrix Check runtime backend capability surfaces and validated test environments.
Interop Contracts Phase E Contracts Inspect engine-federation reason-code/budget constants used by CI gates.
Import/Export Scope Import/Export Matrix See supported bridge import/export/dtype/layout/shape constraints in one table.
Tested Release Matrix Test Matrix Verify tested macOS/Python/Torch environments used for release evidence.
Phase F RC Freeze Phase F Contracts Track API/ABI freeze constants and RC audit requirements.
API Surface Navigation API Index Jump directly to Python/C++/C API entry points and source links.
Generated API Reference Python API (Generated) Auto-generated symbol inventory for pybind module functions/classes.
Contribute / Code Changes Contributor: Validation Checklist Follow contribution workflow, naming rules, and validation steps.
Release / Deployment Ops Advanced: Python Packaging and Release Use release workflow and repository rename operation guidance.

Beginner Path

Start here if you are using the project for the first time.

Covers:

  • install/import check
  • first build
  • first C API run
  • first test run
  • minimal C++ and Python examples

Advanced Path

Use this when you need tuning, benchmarking, and operations details.

Covers:

  • benchmark sweeps and generated artifacts
  • resident policy/session tuning
  • runtime profile env controls
  • model-wrapper caveats
  • release workflow and rename operations

API Navigation Path

Use this when you need to find exact API entry points quickly.

Covers:

  • Python API surfaces (lightning_core, lightning_core.api)
  • public C++ headers
  • public C API header and implementation mapping

Contributor Path

Use this when you are changing code and preparing commits.

Covers:

  • development setup
  • codebase structure and naming policy
  • compatibility/shim expectations
  • python binding module policy
  • validation checklist before commit