Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,5 @@ prof/
# Rust build artifacts
target/
Cargo.lock

fuzz
12 changes: 8 additions & 4 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,9 @@ Future metrics (e.g., audio coverage, state-graph coverage) will follow the same
│ ├── videos/ # Small sample MP4s for integration tests
│ └── smb/ # Super Smash Bros recordings for stress tests
├── docs/
│ └── design.md # Architecture and design documentation
│ ├── api.md # API reference documentation
│ ├── frame_cov.md # Architecture and design documentation
│ └── tuning.md # Radius/threshold tuning guide with empirical results
├── rustfmt.toml # Rust formatting config
├── .pre-commit-config.yaml # Pre-commit hooks (Python + Rust)
├── .github/workflows/ # CI: pytest, mypy, ruff, pylint, rust (fmt/clippy/test)
Expand All @@ -74,7 +76,9 @@ Run Rust linting: `cargo clippy --all-targets --all-features -- -D warnings`

## Design

See [docs/design.md](docs/design.md) for the coverage framework architecture, frame coverage pipeline, BK-tree optimization, and loading strategies.
See [docs/frame_cov.md](docs/frame_cov.md) for the coverage framework architecture, frame coverage pipeline, BK-tree optimization, and loading strategies.

See [docs/api.md](docs/api.md) for detailed API reference documentation including configuration options.

## Key Modules (quick reference)

Expand All @@ -88,7 +92,7 @@ See [docs/design.md](docs/design.md) for the coverage framework architecture, fr
| `writer.py` | `write_mp4()`, `write_mp4_cv2()` |
| `stitch.py` | `stitch_images()` (panorama via AffineStitcher) |
| `generator.py` | Hypothesis strategies: `frames()`, `frames_lists` |
| `env.py` | `RADIUS` env var (Hamming distance threshold, default `5`) |
| `env.py` | `RADIUS` env var (default Hamming distance threshold, `10`); use constructor params to override |

## Environment and Dependencies

Expand Down Expand Up @@ -142,7 +146,7 @@ Some tests require assets in `assets/videos/` or `assets/smb/` and will skip if

### Environment variables for tests

- `RADIUS` — Hamming distance threshold (default `5`).
- `RADIUS` — Default Hamming distance threshold (default `10`). Prefer passing `radius=` to monitor constructors.
- `N_MAX` — Maximum number of recordings to process in monotonicity tests (default `100`).

## Benchmarks
Expand Down
Loading