Skip to content

Commit 4fc26a2

Browse files
committed
docs: update README with all new features, add .env.example
README updates: - Added 11 recent fixes/features with details - Bug fixes: mutation confidence, RL boundary, circular import, enriched events - New features: CI pipeline, SQLite, sessions, multi-LLM, fallback, decay profiles - Updated limitations and roadmap sections - All 638 tests passing Added .env.example: - Template for all configuration options - Sections: storage, LLM provider, belief ecology, thresholds - Includes OpenAI/Anthropic API key placeholders Updated .gitignore: - Block .env and .env.local from git
1 parent dda40be commit 4fc26a2

File tree

3 files changed

+101
-10
lines changed

3 files changed

+101
-10
lines changed

.env.example

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# ABES Configuration
2+
# Copy to .env and fill in your values
3+
4+
# =============================================================================
5+
# STORAGE
6+
# =============================================================================
7+
# Options: memory (default), sqlite
8+
STORAGE_BACKEND=memory
9+
10+
# SQLite database path (only used if STORAGE_BACKEND=sqlite)
11+
DATABASE_URL=sqlite+aiosqlite:///./data/abes.db
12+
13+
# =============================================================================
14+
# LLM PROVIDER
15+
# =============================================================================
16+
# Options: ollama (default), openai, anthropic, none
17+
LLM_PROVIDER=ollama
18+
19+
# If true, falls back to showing raw beliefs when LLM is unavailable
20+
LLM_FALLBACK_ENABLED=true
21+
22+
# --- Ollama (default) ---
23+
OLLAMA_BASE_URL=http://localhost:11434
24+
OLLAMA_MODEL=llama3.1:8b-instruct-q4_0
25+
26+
# --- OpenAI ---
27+
OPENAI_API_KEY=
28+
OPENAI_MODEL=gpt-4o-mini
29+
OPENAI_BASE_URL=https://api.openai.com/v1
30+
31+
# --- Anthropic ---
32+
ANTHROPIC_API_KEY=
33+
ANTHROPIC_MODEL=claude-3-haiku-20240307
34+
35+
# =============================================================================
36+
# BELIEF ECOLOGY
37+
# =============================================================================
38+
# Decay profile: aggressive (0.99), moderate (0.995), conservative (0.999), persistent (0.9999)
39+
DECAY_PROFILE=moderate
40+
41+
# Or set decay rate directly (overrides profile)
42+
# DECAY_RATE=0.995
43+
44+
# Embedding model (sentence-transformers)
45+
EMBEDDING_MODEL=all-MiniLM-L6-v2
46+
47+
# =============================================================================
48+
# THRESHOLDS
49+
# =============================================================================
50+
CONFIDENCE_THRESHOLD_DECAYING=0.3
51+
TENSION_THRESHOLD_MUTATION=0.5
52+
CLUSTER_SIMILARITY_THRESHOLD=0.7
53+
REINFORCEMENT_SIMILARITY_THRESHOLD=0.7
54+
MAX_ACTIVE_BELIEFS=10000
55+
56+
# =============================================================================
57+
# LLM GENERATION
58+
# =============================================================================
59+
LLM_TEMPERATURE=0.7
60+
LLM_MAX_TOKENS=1024
61+
LLM_CONTEXT_BELIEFS=15

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
# ABES spec (internal only)
22
abes_spec_md.md
33

4+
# Environment files (contains secrets)
5+
.env
6+
.env.local
7+
.env.*.local
8+
49
# Python
510
__pycache__/
611
*.py[cod]

README.md

Lines changed: 35 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -269,29 +269,54 @@ d4dd4f5c4a777eac6d2954cd25030f74c9a4e7f27275f1c5e19fa21795d247c5 results/decay_
269269

270270
## Recent Fixes (2026-01-30)
271271

272-
All tests now pass. Here's what was fixed:
272+
All 638 tests passing. Here's what was fixed and added:
273+
274+
### Bug Fixes
273275

274276
1. **Mutation engineer confidence calculation**
275-
- Updated test to match intended design: mutated beliefs preserve relative confidence with a tension-based penalty
276-
- Original belief at 0.4 confidence with 0.7 tension becomes 0.3 (floor value)
277-
- This preserves the relative strength of beliefs rather than resetting to neutral
277+
- Mutated beliefs preserve relative confidence with tension-based penalty
278+
- Formula: `original - 0.1 - (tension * 0.1)`, floor 0.3
278279

279280
2. **RL environment action decoding**
280281
- Fixed boundary condition in test assertion (> changed to >=)
281-
- Positive actions correctly increase parameters to their expected values
282282

283283
3. **Circular import in storage/core modules**
284284
- Moved imports to function level with TYPE_CHECKING guard
285-
- Direct script imports now work without errors
286285

287286
4. **ContradictionDetectedEvent enriched**
288-
- Added contradicting_belief_id, belief_content, contradicting_content, similarity_score fields
289-
- Events now carry full context for debugging and UI display
287+
- Added: contradicting_belief_id, belief_content, contradicting_content, similarity_score
288+
289+
### New Features
290+
291+
5. **GitHub Actions CI Pipeline** (`.github/workflows/ci.yml`)
292+
- Runs pytest on push/PR to main
293+
- Includes lint checks with ruff
294+
295+
6. **SQLite Persistence** (`STORAGE_BACKEND=sqlite`)
296+
- Beliefs survive server restarts
297+
- Async support via aiosqlite
298+
299+
7. **Session Isolation** (`session_id` on beliefs)
300+
- Multi-user support ready
301+
- Filter beliefs by session
302+
303+
8. **Multiple LLM Providers**
304+
- Ollama (default), OpenAI, Anthropic
305+
- Set via `LLM_PROVIDER` env var
306+
307+
9. **LLM Fallback Mode**
308+
- If LLM fails, returns raw beliefs
309+
- Set `LLM_FALLBACK_ENABLED=true`
310+
311+
10. **Configurable Decay Profiles**
312+
- `DECAY_PROFILE`: aggressive (0.99), moderate (0.995), conservative (0.999), persistent (0.9999)
313+
314+
11. **Configurable Embedding Model**
315+
- `EMBEDDING_MODEL` env var (default: all-MiniLM-L6-v2)
290316

291-
### Known Issues Being Worked On
317+
### Remaining Known Issues
292318

293319
- Contradiction detection uses embeddings and antonym lists, not full semantic understanding
294-
- The decay factor default (0.995) might be too aggressive for some use cases
295320

296321
---
297322

0 commit comments

Comments
 (0)