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
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ ELF is a memory service for LLM agents that stores short, evidence-linked facts
Use the canonical setup guide:

- `docs/guide/getting_started.md`
- For single-user production operation, backup, restore, and Qdrant rebuild, use
[docs/guide/single_user_production.md](docs/guide/single_user_production.md).

Fast path:

Expand All @@ -56,6 +58,9 @@ curl -fsS http://127.0.0.1:51892/health
```

For provider-backed development, copy `elf.example.toml` to `elf.toml` and fill the provider blocks.
For production use, do not rely on these quickstart commands; follow the single-user
production runbook linked above so backup, restore, rollback, and provider config
handling are explicit.

## Architecture

Expand Down Expand Up @@ -136,6 +141,7 @@ Detailed evidence and interpretation:
- [Live Baseline Benchmark Report - June 9, 2026](docs/guide/benchmarking/2026-06-09-live-baseline-report.md)
- [Synthetic Production Corpus Benchmark Report - June 9, 2026](docs/guide/benchmarking/2026-06-09-production-corpus-report.md)
- [Live Baseline Benchmark Runbook](docs/guide/benchmarking/live_baseline_benchmark.md)
- [Single-User Production Runbook](docs/guide/single_user_production.md)

Quick comparison snapshot (objective/high-level).
This table compares capability coverage, not overall project quality.
Expand Down Expand Up @@ -191,7 +197,8 @@ Latest external research refresh: June 8, 2026.

- Start here: `docs/index.md`
- Operational guide index: `docs/guide/index.md`
- Single-user production runbook: `docs/guide/single_user_production.md`
- Single-user production runbook:
[docs/guide/single_user_production.md](docs/guide/single_user_production.md)
- Benchmarking guides and reports: `docs/guide/benchmarking/index.md`
- Research index: `docs/guide/research/index.md`
- Specifications: `docs/spec/index.md`
Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ services:
timeout: 5s
retries: 10
volumes:
- elf-postgres-data:/var/lib/postgresql/data
- elf-postgres-data:/var/lib/postgresql

qdrant:
image: qdrant/qdrant:v1.16.3
Expand Down
5 changes: 5 additions & 0 deletions docs/guide/benchmarking/2026-06-09-live-baseline-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,11 @@ calls, worker indexing, Qdrant rebuild/search, lifecycle checks, soak, and conta
overhead. Whether that is acceptable depends on the production workflow: it is a
cold/backfill measurement, not an interactive-ingest target.

This report is benchmark evidence, not the production operating procedure. Use
`docs/guide/single_user_production.md` for Docker Compose production start, stop,
health, backup, restore, Qdrant rebuild, rollback, provider config handling, and
cleanup commands.

Throughput work should focus on:

- micro-batching provider embedding requests;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,11 @@ Verification: Compare this Markdown summary with the source JSON before committi
- Same-corpus summary: `1 pass`, `0 fail`, `0 incomplete`
- Full check summary: `7/7 pass`

This report is production-corpus benchmark evidence only. Use
`docs/guide/single_user_production.md` for the single-user Docker Compose production
runbook, including backup, restore, Qdrant rebuild, rollback, provider config
handling, and cleanup commands.

## Projects

| Project | Status | Retrieval | Checks | Elapsed | Reason |
Expand Down
4 changes: 4 additions & 0 deletions docs/guide/benchmarking/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ Outputs: The smallest benchmarking guide or report needed to continue.
- You need to extend the benchmark matrix with new projects, profiles, or lifecycle
checks.

Do not use benchmark commands as the production operating procedure. For single-user
Docker Compose production start, stop, backup, restore, Qdrant rebuild, rollback, and
cleanup, use `docs/guide/single_user_production.md`.

## Guides And Reports

- `live_baseline_benchmark.md`: run, clean up, publish, and interpret the live
Expand Down
4 changes: 4 additions & 0 deletions docs/guide/benchmarking/live_baseline_benchmark.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ Verification: `cargo make baseline-live-docker` writes `tmp/live-baseline/live-b

## Scope

This guide is for benchmark evidence, not for operating a personal production ELF service. For
single-user Docker Compose production start, stop, health, backup, restore, Qdrant rebuild,
rollback, and cleanup commands, use `docs/guide/single_user_production.md`.

The runner covers ELF plus the six external projects in the README comparison table:

- ELF
Expand Down
Loading