Skip to content

docs: link the Intent Layer AGENTS.md files and global invariants from CLAUDE.md #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
satyamshivam13 merged 1 commit into from
Jul 14, 2026
Merged

docs: link the Intent Layer AGENTS.md files and global invariants from CLAUDE.md #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,25 @@ A Python toolkit and set of Streamlit applications that estimate how likely text
## Cross-Cutting Concerns
<!-- GSD:architecture-end -->

## Intent Layer

**Before modifying code in a subdirectory, read its AGENTS.md first** to understand local patterns and invariants.

- **Analyzers**: `src/analyzers/AGENTS.md` — Detection pipeline, BaseAnalyzer contract, lazy imports, EnsembleAnalyzer fusion logic
- **Utils**: `src/utils/AGENTS.md` — TextProcessor, ChartGenerator, ui_contract helpers, logging setup
- **Models & Config**: `src/models/AGENTS.md` — AnalysisResult dataclasses, Settings singleton, enums, thresholds

### Global Invariants

- All text analysis flows through `analyzer.analyze(text) → AnalysisResult`. Never call `_perform_analysis` directly.
- `AnalysisResult`, `TextMetrics`, `DetectionScore` are dataclasses — do not add logic-heavy methods; keep them plain data containers.
- `get_settings()` is an `@lru_cache` singleton. Never instantiate `Settings()` directly.
- `BaseAnalyzer.__init__` sets `self.thresholds = self.settings.thresholds` — always use `self.thresholds` in subclasses, never hardcode threshold values.
- Transformer-backed analyzers (`GPT2Analyzer`, `RoBERTaAnalyzer`, `EnsembleAnalyzer`) are lazily imported from `src/analyzers/__init__.py` so `app.py` runs without `torch`.
- All Streamlit entry points (`app.py`, `ensemble.py`, `test.py`) do `sys.path.insert(0, ".../src")` at the top — never move this.
- Error handling contract: on any analysis failure, set `Verdict.UNCERTAIN`, zero confidence, and append a warning — never let exceptions surface to the UI uncaught.
- Code style: Black @ line length 100, isort `--profile=black`, flake8 max 100. Run `make format && make lint` before committing.

<!-- GSD:workflow-start source:GSD defaults -->
## GSD Workflow Enforcement

Expand Down
Loading