Skip to content

Documentation: API reference, developer guide, expanded theory and tutorials#297

Merged
Kiguli merged 4 commits intoverivital:masterfrom
Kiguli:master
Apr 2, 2026
Merged

Documentation: API reference, developer guide, expanded theory and tutorials#297
Kiguli merged 4 commits intoverivital:masterfrom
Kiguli:master

Conversation

@Kiguli
Copy link
Copy Markdown
Collaborator

@Kiguli Kiguli commented Apr 2, 2026

Summary

Significant expansion of the GitHub Pages documentation site at https://verivital.github.io/nnv/ with new sections for API reference, developer extensibility guide, and expanded theory/tutorial content based on NNV3 feature papers.

New sections

  • Developer Guide (6 pages): Architecture overview with exact code-level details of the reachability pipeline, custom verification workflows (FFNN/CNN/GNN/NNCS), how to add new layers/sets/reachability methods, testing & CI/CD (merged from standalone testing section)
  • API Reference (8 pages): NN class, GNN class, all set types, 48 layer types, NNCS classes, utility functions, and reachOptions struct -- all verified against source code

Expanded theory pages (based on published papers)

  • GNN Reachability: GraphStar sets, GCN/GINE reachability, subgraph verification, soundness guarantees (GNNV paper, under review)
  • Weight Perturbation (ModelStar): Perturbation maps, quantization connection, INN relationship (Zubair et al., IEEE CAI 2025)
  • Probabilistic Verification: Double-step PAC guarantee, surrogate-based approach, deflative PCA, comparison with randomized smoothing (Hashemi et al., NeurIPS 2025)
  • Fairness Verification (FairNNV): Formal definitions, VF score, adversarial debiasing analysis (Tumlin et al., ICAIF 2024)

New tutorials

  • Weight perturbation tutorial with quantization interpretation
  • Fairness verification tutorial with VF score walkthrough
  • Expanded semantic segmentation with probabilistic verification results
  • Expanded GNN tutorial with CORA comparison results

Structural improvements

  • Testing section merged into Developer Guide (developer-only content)
  • Courses page moved to bottom of main menu
  • Copyright updated to 2026
  • Theory pages cleaned: experimental content moved to tutorial pages

Test plan

  • sphinx-build passes with zero warnings
  • All pages render correctly at localhost:8000
  • No MATLAB source code modified -- CI tests unaffected
  • API signatures verified against actual source code

Kiguli added 4 commits April 1, 2026 15:50
Add comprehensive theory page for Graph Neural Network verification
covering GraphStar sets, GCN/GINE reachability, subgraph verification,
soundness guarantees, and experimental results summary. Based on the
GNNV paper (under review).

Also fix RST indentation warning in acasxu.rst.
Theory pages:
- GNN reachability: GraphStar sets, GCN/GINE reachability, subgraph
  verification, soundness guarantees (based on GNNV paper, under review)
- Weight perturbation (ModelStar): perturbation maps, exact/over-approximate
  reachability, quantization connection, INN relationship (based on
  Zubair et al. IEEE CAI 2025 + JAIR accepted)
- Probabilistic verification: substantially expanded with double-step PAC
  guarantee, nonconformity scores, surrogate-based approach, deflative PCA,
  pixel-level classification, randomized smoothing comparison, experimental
  results (based on Hashemi et al. NeurIPS 2025)

Tutorial:
- Weight perturbation example with quantization interpretation table
Theory pages now contain only theoretical foundations:
- fairness.md: removed results table and key observations
- probabilistic.md: removed experimental summary table and comparison numbers
- gnn-reachability.md: removed experimental results summary

Example/tutorial pages now contain all experimental content:
- NEW fairness.rst: complete FairNNV tutorial with results table, debiasing
  paradox finding, and VF score walkthrough
- semantic-segmentation.rst: added probabilistic verification results table
  (M2NIST, Lung Seg, OCTA-500, CamVid, Cityscapes) with comparison numbers
- gnn.rst: added experimental results summary with CORA comparison
…veloper guide

New sections:
- API Reference: NN class, GNN class, set types, 48 layer types, NNCS classes,
  utilities, and reachOptions struct reference
- Developer Guide: architecture overview, custom verification workflows,
  adding new layers/sets/methods, testing & CI/CD

Navigation improvements:
- Developer Guide appears before API Reference in sidebar
- Testing section merged into Developer Guide (developer-only content)
- Courses page moved to bottom of main menu as standalone item
- Copyright updated to 2026

API accuracy fixes (verified against source code):
- verify_vnnlib returns [result, X] not just result
- verify_specification: 0=failed, 1=satisfied, 2=unknown
- matlab2nnv also accepts LayerGraph
- WPutils is a static class with weightPerturb property
- Added verify_safety and verify_segmentation to NN methods
@Kiguli Kiguli merged commit 57a8307 into verivital:master Apr 2, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant