tidaldb/applications/iknowyou/engine/README.md
jordan eca7765e8d fix: heal_region re-delivers missed WAL batches so partitioned followers converge immediately after heal
- Extract redeliver_missed(tx, db, log) helper into cluster_transport.rs
- heal_region now removes partition then immediately ships any missed
  batch-log entries to the healed follower's channel
- await_convergence refactored to call the same helper (no logic change)
- tidal-server: reload_text_index before search in cluster mode
- tidal-server: write_signal returns Result instead of panicking on unknown signal
- tidal-server: leader shows lag_events=0 (writes directly, no receiver thread)
- tidal-server: fix cluster mode error propagation (ServerError::from)
- docs/runbooks/cluster.md: add full cluster operations runbook
- docker/: add Dockerfile for containerised cluster deployment
- README.md: add tidal-server HTTP API getting-started section
- Split oversized source files per CODING_GUIDELINES §9

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-02-25 11:57:01 -07:00

51 lines
1.2 KiB
Markdown

# iknowyou-engine
`iknowyou-engine` moves personalization state into embedded `tidalDB` and keeps Synap optional for auxiliary observation memory.
## What this crate covers
- User/item state and ranking signals in `tidalDB`
- Session lifecycle and session-scoped signals (`start_session` / `session_signal` / `close_session`)
- Hard negatives (`hide`, `mute`, `block`) written as durable relationships for replay-safe filtering
- PG1 evaluator (`run_pg1_eval`) for:
- hard-negative leak rate
- adaptation latency p95
- useful-item uplift vs baseline
- repeated-unwanted-item rate
## Run the PG1 evaluator
```bash
cargo run -p iknowyou-engine --bin pg1_eval
```
Optional persistent path:
```bash
cargo run -p iknowyou-engine --bin pg1_eval /tmp/iknowyou-pg1
```
## Run the HTTP server
```bash
cargo run -p iknowyou-engine --bin server --features synap-aux
```
Server defaults:
- bind: `127.0.0.1:7777`
- data dir: `${TMPDIR}/iknowyou_engine_data`
Override with:
- `IKY_ENGINE_BIND`
- `IKY_ENGINE_DATA_DIR`
## Optional Synap auxiliary memory
Enable `synap-aux` to use `SynapAuxMemory` for observation storage while keeping core personalization in `tidalDB`.
```bash
cargo test -p iknowyou-engine --features synap-aux
```