Skip to content

Show the status as a note and fold reference sections #12

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
rustfuture merged 1 commit into from
Oct 2, 2026
Merged

Show the status as a note and fold reference sections #12

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: 18 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ Repository Intelligence searches local code and returns verbatim source lines fo
[![CI](https://github.com/rustfuture/repository-intelligence/actions/workflows/ci.yml/badge.svg)](https://github.com/rustfuture/repository-intelligence/actions/workflows/ci.yml)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

**Status:** Experimental research prototype (v0.1.0) for local code inspection.
> [!NOTE]
> **Status:** Experimental research prototype (v0.1.0) for local code inspection.

- Searches code using text matching, offline hash embeddings, or local neural models.
- Responds to questions by quoting exact source lines instead of generating text; quotes match the source, but relevance is not guaranteed.
Expand Down Expand Up @@ -120,13 +121,18 @@ For the extended results table and historical notes, see [docs/measured-results.

Reproduce the evaluation into a new directory (existing outputs are never overwritten):

<details>
<summary>Reproduction details</summary>

```sh
python3 evaluation/v3/evaluate.py --output evaluation/v3/my-run
python3 evaluation/v3/evaluate.py --render-only evaluation/v3/my-run # re-render, no model calls
```

The output `summary.json` separates `false_accepts`, `false_rejects`, `model_called`, and `pre_model_refusals`. A pre-model refusal indicates the index lacked a lexical anchor and the model was not called. Historical notes on superseded claims are relocated to [docs/measured-results.md](docs/measured-results.md).

</details>

## Tests

```sh
Expand All @@ -139,8 +145,13 @@ python3 evaluation/evaluate.py
python3 evaluation/evaluate_modes.py
```

<details>
<summary>More test commands</summary>

The test suite validates formatting, static analysis, 37 Rust unit and regression tests covering indexing and retrieval, and 5 Python evaluator tests.

</details>

## Limitations

- **Quotation integrity is not correctness.** Matching source text proves the excerpt
Expand All @@ -167,6 +178,10 @@ The test suite validates formatting, static analysis, 37 Rust unit and regressio
## Repository Map

| Path | Contents |

<details>
<summary>Repository map</summary>

|---|---|
| `src/lib.rs` | Index, retrieval modes, git sync, evidence assembly |
| `src/extractive.rs` | `extractive-selection-v1` validation and rendering |
Expand All @@ -177,6 +192,8 @@ The test suite validates formatting, static analysis, 37 Rust unit and regressio
| `evaluation/v3/` | Evaluator, questions, and committed run records |
| `docs/architecture.md` | Component and trust boundaries |

</details>

## License

MIT — see [LICENSE](LICENSE). The evaluation corpus is authored for this project.
Loading