NWAVE SDK Documentation
The NWave SDK helps you prepare data, perform inference & train spiking neural networks, model hardware non-idealities for the H1 chip, and evaluate results. This documentation is organized to guide from setup to experiments.
How the Documentation Is Organized
- Environment Setup: Install the SDK and validate your environment before you start.
- Introduction to H1: Learn the target hardware and its constraints.
- Data Preparation: Supported input formats and the preprocessing pipeline of H1.
- Losses: Network-level and hardware-aware loss functions.
- Metrics: Evaluation metrics and analysis tools.
- Utilities: Plotting and helper utilities.
- Tutorials: End-to-end workflows for common training and deployment scenarios.
- Reference: API-style details for layers and surrogate functions.
- FAQ: Quick answers to common questions.
What to Read First
- Environment Setup → Procedure To Install The Environment
- Introduction to H1 → Chip Overview
- Data Preparation → Data Formats
- Tutorials → Start with Tutorial 1: LIF Regression
- Reference → Layers and Surrogates
Key Sections (Quick Links)
- Environment Setup: Install the SDK
- Introduction to H1: Chip Overview · Chip Constraints & non-idealities
- Data Preparation: Data Formats · Preprocessing Pipeline
- Losses: Overview · Network-level losses · Hardware-aware losses
- Metrics: Network Metrics & Analysis
- Utilities: Plotting Utilities
- Tutorials: Tutorial 1 · Tutorial 2 · Tutorial 3 · Tutorial 4 · Tutorial 5
- Reference: Layers · Surrogates
- FAQ: Frequently Asked Questions