How waleed-sh/nkdsl works
nkDSL lets users describe discrete operators symbolically and compile them into executable JAX-backed operators compatible with NetKet. The main workflow is DSL construction (iteration domains, predicates, updates and emissions), symbolic IR, compiler passes, backend lowering, then execution through a compiled operator. The compiler also supports artifact caching, diagnostics and configurable lowering targets. Connections below are limited to README statements and relationships listed in the supplied SOURCE INDEX; unsampled implementation details are not inferred.
Main entry points: compiler.py Compiler orchestration · operator.py Operator DSL · jax_lowerer.py JAX lowerer · term.py Term IR
Components 28
Operator authoring
- Operator DSL
src/nkdsl/dsl/operator.py - Iteration clauses
src/nkdsl/dsl/iterators/defaults.py - Predicate clauses
src/nkdsl/dsl/predicates - Emission clauses
src/nkdsl/dsl/emissions - Update programs
src/nkdsl/dsl/rewrite.py
Symbolic representation
- Amplitude expressions
src/nkdsl/ir/expressions.py - Predicate IR
src/nkdsl/ir/predicates.py - Update IR
src/nkdsl/ir/update.py - Term IR
src/nkdsl/ir/term.py - Operator IR
src/nkdsl/ir/program.py - Symbolic operator
src/nkdsl/core/operator.py
Compilation
- Compiler orchestration
src/nkdsl/compiler/compiler.py - Pass pipeline
src/nkdsl/compiler/core/pipeline.py - Compilation context
src/nkdsl/compiler/core/context.py - Compiled artifact
src/nkdsl/compiler/core/artifact.py - Artifact cache
src/nkdsl/compiler/cache/store.py - JAX lowerer
src/nkdsl/compiler/lowering/jax_lowerer.py - Connectivity analysis
src/nkdsl/compiler/core/connectivity.py - Diagnostics
src/nkdsl/compiler/diagnostics - Cache signature
src/nkdsl/compiler/core/signature.py - Compiler options
src/nkdsl/compiler/core/options.py - Pass reports
src/nkdsl/compiler/core/pass_report.py - Kernel representation
src/nkdsl/compiler/core/kernel.py
Execution and integration
- Compiled operator
src/nkdsl/core/compiled.py - Compiler configuration
src/nkdsl/configs.py - Debug and profiling
src/nkdsl/debug.py
Other components
- Operator author
- NetKet user
Connections 29
- Operator author → Operator DSL: defines operator
- Operator DSL → Iteration clauses: selects domains
src/nkdsl/dsl/operator.py - Operator DSL → Predicate clauses: adds conditions
src/nkdsl/dsl/operator.py - Operator DSL → Emission clauses: adds emissions
src/nkdsl/dsl/operator.py - Operator DSL → Update programs: defines updates
src/nkdsl/dsl/operator.py - Operator DSL → Symbolic operator: builds
src/nkdsl/core/operator.py - Symbolic operator → Operator IR: compiles from terms
src/nkdsl/core/operator.py - Operator IR → Term IR: contains terms
src/nkdsl/ir/program.py - Term IR → Amplitude expressions: uses amplitudes
src/nkdsl/ir/term.py - Term IR → Predicate IR: uses predicates
src/nkdsl/ir/term.py - Term IR → Update IR: uses updates
src/nkdsl/ir/term.py - Symbolic operator → Compiler orchestration: compile request
src/nkdsl/core/operator.py - Compiler orchestration → Compilation context: creates context
src/nkdsl/compiler/compiler.py - Compiler orchestration → Pass pipeline: runs passes
src/nkdsl/compiler/compiler.py - Pass pipeline → Compilation context: mutates state
src/nkdsl/compiler/core/pipeline.py - Compiler orchestration → Artifact cache: looks up artifact
src/nkdsl/compiler/compiler.py - Compiler orchestration → Cache signature: creates cache key
src/nkdsl/compiler/compiler.py - Compiler orchestration → JAX lowerer: dispatches lowering
src/nkdsl/compiler/compiler.py - JAX lowerer → Compiled artifact: creates artifact
src/nkdsl/compiler/lowering/jax_lowerer.py - Compiler orchestration → Compiled artifact: stores result
src/nkdsl/compiler/compiler.py - JAX lowerer → Connectivity analysis: uses connectivity
src/nkdsl/compiler/lowering/jax_lowerer.py - JAX lowerer → Compiled operator: builds operator
src/nkdsl/compiler/lowering/jax_lowerer.py - Compiled operator → NetKet user: provides execution
- Compiler configuration → JAX lowerer: selects target
- Compiler orchestration → Compiler options: accepts options
src/nkdsl/compiler/compiler.py - Compilation context → Pass reports: records reports
src/nkdsl/compiler/core/context.py - JAX lowerer → Kernel representation: uses kernel lowering
src/nkdsl/compiler/lowering/jax_lowerer.py - Compiler orchestration → Diagnostics: runs diagnostics
- Compiler orchestration → Debug and profiling: emits debug events
src/nkdsl/compiler/compiler.py