Integration tests & updated docs #59

tafk7 · 2025-09-15T18:42:25Z

Add core integration test suite and documentation improvements

Summary

Adds integration tests for core DSE functionality with fixture-based architecture
Enhances documentation with summary/guidance readme and additional docs
Simplifies BERT demo with blueprint-based configuration
Fixes critical bugs in parser API and plugin registry

Core Changes

Bug Fixes & API Improvements

Refactored BlueprintParser class to standalone parse_blueprint() function
Fixed plugin registry lazy loading issues in find() and all() methods
Corrected DSE tree node counting and depth calculation to include root node
Enhanced registry reset to properly clear initialization state

Testing Infrastructure

Integration tests for blueprint parsing with inheritance and step operations
DSE execution tests validating tree construction and artifact sharing
Plugin system tests covering registration, discovery, and framework integration
Mock plugin ecosystem with test kernels, transforms, and build steps

Documentation

Dataflow modeling guide explaining kernel abstractions and tiling strategies
Plugin registry documentation with examples and best practices
BERT example README with quickstart instructions
Improved design space exploration docs with clearer examples

BERT Example Improvements

Replaced CLI arguments with blueprint-driven configuration
Added bert_quicktest.yaml for rapid testing (single layer, minimal folding)
Quicktest blueprint extends base with test-specific overrides

- Add pytest configuration and test fixtures - Add tests for blueprint parser, DSE execution, and plugin system - Add fixture plugins for testing kernels, steps, and transforms - Add test utilities and helper functions - Bug fix tree depth calculation to include root

- Add docs for dataflow modeling, hardware kernels, plugin registry - Rename execution_tree_dse.md to design_space_exploration.md - Delete plugin_library.md (replaced by plugin_registry.md) - Add BERT example README and quicktest yaml - Add plugin error handling tests - Update parser with help text and schema generation

- Simplify Brainsmith Library section to reference plugin registry - Add concrete transform example with SetPumpedCompute - Add base_finn_config fixture for testing - Add inheritance blueprint helpers for parent/grandparent testing - Add ExpectedExecutionLevel dataclass for tree validation

… diagram - Add comprehensive examples for all 5 kernel components - Include kernel creation workflow diagram - Add pre-release notes about ongoing standardization - Link to documentation from main README

tafk7 · 2025-09-17T22:00:32Z

Troubleshooting some issues with the BERT example after my changes, but documentation and basic integration test suite are ready for review. Both are far from comprehensive, but a good start to empower our collaborators.

…rser inheritance - Fix recursive inheritance handling in blueprint parser for multi-level extends - Update bert_quicktest.yaml to extend bert_demo.yaml instead of bert.yaml - Enable split_large_fifos in bert_demo.yaml FINN config - Disable pre-calc folding for quicktest to circumvent bug - Remove quicktest_folding.json testing artifact

docs/blueprint_schema.md

docs/hardware_kernels.md

docs/kernel-integrator-user-guide.md

docs/plugin_registry.md

docs/README.md

jsmonson

Looks great! PLease see my comments.

tafk7 added 5 commits September 12, 2025 17:15

docs: expand hardware kernel documentation with examples and workflow…

69e6be8

… diagram - Add comprehensive examples for all 5 kernel components - Include kernel creation workflow diagram - Add pre-release notes about ongoing standardization - Link to documentation from main README

Tweaked pre-release disclaimers

176e667

tafk7 marked this pull request as ready for review September 17, 2025 21:59

tafk7 requested a review from a team as a code owner September 17, 2025 21:59

tafk7 requested review from STFleming, auphelia and jsmonson September 17, 2025 21:59

tafk7 added 2 commits September 19, 2025 18:47

Typo fix

c397ad6