forkledger 0.4.0__tar.gz

forkledger-0.4.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

forkledger-0.4.0/PKG-INFO

@@ -0,0 +1,432 @@
+Metadata-Version: 2.4
+Name: forkledger
+Version: 0.4.0
+Summary: Branch-based decision memory for AI agents — stores choices, alternatives, and regret.
+Author: sliper82
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/sliper82/forkledger
+Project-URL: Documentation, https://github.com/sliper82/forkledger#readme
+Project-URL: Repository, https://github.com/sliper82/forkledger
+Project-URL: Bug Tracker, https://github.com/sliper82/forkledger/issues
+Project-URL: Changelog, https://github.com/sliper82/forkledger/blob/main/CHANGELOG.md
+Keywords: rust,performance,fts,ai,memory,agents,decision-engine,counterfactuals,regret,sqlite,fastapi,mcp,langchain,llm
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: api
+Requires-Dist: fastapi>=0.110; extra == "api"
+Requires-Dist: uvicorn[standard]>=0.29; extra == "api"
+Requires-Dist: pydantic>=2.0; extra == "api"
+Provides-Extra: embeddings
+Requires-Dist: sentence-transformers>=2.7; extra == "embeddings"
+Requires-Dist: numpy>=1.26; extra == "embeddings"
+Provides-Extra: mcp
+Requires-Dist: mcp>=1.0; extra == "mcp"
+Requires-Dist: fastmcp>=0.1; extra == "mcp"
+Provides-Extra: faiss
+Requires-Dist: faiss-cpu>=1.7; extra == "faiss"
+Provides-Extra: postgres
+Requires-Dist: psycopg2-binary>=2.9; extra == "postgres"
+Provides-Extra: dashboard
+Requires-Dist: streamlit>=1.35; extra == "dashboard"
+Requires-Dist: pandas>=2.0; extra == "dashboard"
+Requires-Dist: altair>=5.0; extra == "dashboard"
+Provides-Extra: all
+Requires-Dist: fastapi>=0.110; extra == "all"
+Requires-Dist: uvicorn[standard]>=0.29; extra == "all"
+Requires-Dist: pydantic>=2.0; extra == "all"
+Requires-Dist: sentence-transformers>=2.7; extra == "all"
+Requires-Dist: numpy>=1.26; extra == "all"
+Requires-Dist: mcp>=1.0; extra == "all"
+Requires-Dist: fastmcp>=0.1; extra == "all"
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: httpx>=0.27; extra == "dev"
+Requires-Dist: fastapi>=0.110; extra == "dev"
+Requires-Dist: pydantic>=2.0; extra == "dev"
+Requires-Dist: ruff>=0.4; extra == "dev"
+Dynamic: license-file
+
+<p align="center">
+  <img src=".github/assets/logo.png" width="720" alt="ForkLedger" />
+</p>
+
+<p align="center">
+  <a href="https://github.com/sliper82/forkledger/actions"><img src="https://github.com/sliper82/forkledger/actions/workflows/ci.yml/badge.svg" alt="CI" /></a>
+  <a href="https://github.com/sliper82/forkledger/releases"><img src="https://img.shields.io/github/v/release/sliper82/forkledger?color=40c8ff&label=version" alt="Version" /></a>
+  <img src="https://img.shields.io/badge/python-3.10%2B-blue" alt="Python 3.10+" />
+  <a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-blue" alt="License" /></a>
+  <a href="https://github.com/sliper82/forkledger/blob/main/COMPARISON.md"><img src="https://img.shields.io/badge/vs-Mem0%20%7C%20Hindsight%20%7C%20LangMem-555" alt="Comparison" /></a>
+</p>
+
+<p align="center">
+  <b>The memory layer your AI agents actually need.</b><br/>
+  Not what was said — but what was chosen, what it cost, and what to do differently next time.
+</p>
+
+---
+
+## The problem with AI memory today
+
+Every major memory system stores **what happened**: messages, chunks, embeddings, facts.
+
+None of them store **why a decision was made** — or what it cost.
+
+That means every time your agent faces the same situation, it starts from zero. It can't learn from its own mistakes. It has no way to say: *"Last time I chose this, it cost me 3 points. Don't do it again."*
+
+**ForkLedger fixes this.**
+
+---
+
+## What ForkLedger stores
+
+```
+situation before the choice
+        ↓
+[ branch A ] [ branch B ✓ chosen ] [ branch C ]
+                     ↓
+               observed outcome
+                     ↓
+     regret vector — what each path cost relative to the best
+```
+
+Over time, ForkLedger learns which branches produce the lowest regret under similar conditions — and surfaces that knowledge when it matters.
+
+---
+
+## Install
+
+```bash
+pip install forkledger              # core — zero dependencies
+pip install forkledger[mcp]         # + MCP server (Claude Desktop, Cursor, VS Code)
+pip install forkledger[api]         # + REST API (FastAPI)
+pip install forkledger[embeddings]  # + semantic similarity
+pip install forkledger[all]         # everything
+```
+
+---
+
+## 60-second demo
+
+```python
+from forkledger import ForkLedgerEngine, ForkRecord, Branch, OutcomeEstimate
+
+engine = ForkLedgerEngine("decisions.db", backend="sqlite")
+
+# Record a decision and its outcome
+engine.add_record(ForkRecord(
+    fork_id   = "trade-001",
+    pre_state = {"market": "BTC", "signal": "breakout", "volume": "high"},
+    trigger   = "RSI crossed 70 with volume confirmation",
+    possible_branches = [Branch("enter"), Branch("wait"), Branch("short")],
+    chosen_branch     = "enter",
+    realized_value    = 2.4,
+    estimated_outcomes = [
+        OutcomeEstimate("wait",  estimated_value=0.0),
+        OutcomeEstimate("short", estimated_value=-1.5),
+    ],
+    confidence = 0.8,
+    tags = ["crypto", "momentum"],
+))
+
+# Update with actual result after the fact
+engine.update_outcome("trade-001", realized_value=1.9)
+
+# Ask: given this new situation, what should I do?
+recs = engine.recommend(
+    current_state = {"market": "ETH", "signal": "breakout", "volume": "high"},
+)
+# → [{"branch": "enter", "score": 0.82}, ...]
+
+# What patterns have emerged from repeated decisions?
+policies = engine.policies()
+# → [{"recommended_branch": "enter", "win_rate": {"enter": 0.72}, ...}]
+
+# Win rates across all historical decisions
+win_rates = engine.win_rates()
+
+# CFR-style accumulated regret (time-decay weighted)
+regret = engine.accumulated_regret()
+
+# Full audit trail with effective weights
+trail = engine.audit_trail()
+```
+
+---
+
+## MCP Server — works with Claude Desktop, Cursor, VS Code
+
+```bash
+pip install forkledger[mcp]
+```
+
+Add to your Claude Desktop config (`~/.config/claude/claude_desktop_config.json`):
+
+```json
+{
+  "mcpServers": {
+    "forkledger": {
+      "command": "forkledger",
+      "args": ["mcp", "--store", "/path/to/decisions.db", "--backend", "sqlite"]
+    }
+  }
+}
+```
+
+Your Claude agent can now:
+- `record_decision(...)` — store a decision with alternatives and outcome
+- `get_recommendation(...)` — ask what worked in similar past situations
+- `update_outcome(...)` — update realized value after observing results
+- `get_policies(...)` — see distilled patterns from repeated decisions
+- `list_decisions(...)` — browse decision history
+- `memory_stats()` — store health and statistics
+
+**No code required. Works with any MCP-compatible client.**
+
+---
+
+## REST API
+
+```bash
+pip install forkledger[api]
+forkledger serve --backend sqlite --store decisions.db
+# → http://localhost:8000/docs  (Swagger UI)
+```
+
+| Method | Path | Description |
+|--------|------|-------------|
+| `GET` | `/health` | Health check |
+| `GET` | `/stats` | Store statistics |
+| `GET` | `/forks` | List (filterable by tags, confidence) |
+| `POST` | `/forks` | Add one fork |
+| `POST` | `/forks/bulk` | Bulk add |
+| `PATCH` | `/forks/{id}/outcome` | Update realized value |
+| `DELETE` | `/forks/{id}` | Delete |
+| `DELETE` | `/forks/expired` | Purge expired |
+| `POST` | `/recommend` | Get branch recommendations |
+| `POST` | `/rank` | Rank forks by similarity |
+| `GET` | `/policies` | Distilled policies |
+| `GET` | `/win-rates` | Win rates per branch |
+| `GET` | `/audit` | Decision audit trail |
+| `GET` | `/export` | Export all as JSON |
+
+---
+
+## Docker
+
+```bash
+docker run -p 8000:8000 -v $(pwd)/data:/data \
+  ghcr.io/sliper82/forkledger:latest
+
+# or with compose:
+docker compose up
+```
+
+---
+
+## Dashboard
+
+```bash
+pip install forkledger[dashboard]
+forkledger dashboard --store decisions.db --backend sqlite
+# → http://localhost:8501
+```
+
+Visualize decision history, win rates, accumulated regret, and policies.
+
+---
+
+## CLI
+
+```bash
+forkledger add decisions.json                           # load from file
+forkledger recommend --state '{"signal":"breakout"}'   # get recommendation
+forkledger update-outcome trade-001 1.9                 # update outcome
+forkledger policies --min-support 3                     # distilled patterns
+forkledger win-rates                                    # branch win rates
+forkledger accumulated-regret                           # CFR-weighted regret
+forkledger audit --limit 20                             # decision trail
+forkledger stats                                        # store health
+forkledger serve --backend sqlite --port 8000           # REST API
+forkledger mcp --backend sqlite                         # MCP server
+```
+
+---
+
+## What's unique about ForkLedger
+
+| Concept | Description |
+|---------|-------------|
+| **Regret vector** | Computed automatically. `regret(branch) = best_value − branch_value`. Zero = best choice. |
+| **Fuzzy policy clustering** | Groups similar (not just identical) states. Real-world agent states are never perfectly equal. |
+| **Confidence decay** | Exponential time-weighting. Old evidence fades. Configurable half-life. |
+| **CFR-style accumulation** | Weighted regret accumulates across history per branch, similar to Counterfactual Regret Minimization. |
+| **Branch win rates** | How often each branch was the best available choice. |
+| **Outcome update** | Update realized values after observing results. Regret is recomputed automatically. |
+| **Zero dependencies** | Core library requires nothing. SQLite is stdlib. All extras are opt-in. |
+
+---
+
+## How it compares
+
+→ See [COMPARISON.md](COMPARISON.md) for a full side-by-side with Mem0, Hindsight, LangMem, and mcp-memory.
+
+**Short version:** ForkLedger does not compete with those systems — it complements them. They store facts. ForkLedger stores decisions.
+
+---
+
+## Architecture
+
+```
+ForkLedgerEngine
+├── storage/
+│   ├── JsonForkStore       — flat file, zero deps
+│   ├── SqliteForkStore     — indexed, atomic, production
+│   └── PostgresForkStore   — cloud-native, pgvector
+├── counterfactual.py       — regret + decay + CFR accumulation
+├── retrieval.py            — scoring + optional embeddings
+├── policy.py               — fuzzy + exact policy distillation
+├── mcp_server.py           — MCP server (8 tools)
+├── api.py                  — FastAPI REST (14 endpoints)
+├── cli.py                  — CLI (18 commands)
+└── dashboard/app.py        — Streamlit UI
+```
+
+**Retrieval scoring:**
+
+| Signal | Weight |
+|--------|--------|
+| State similarity | 45% |
+| Constraint match | 20% |
+| Recency | 15% |
+| Confidence | 10% |
+| Regret salience | 10% |
+
+---
+
+## Benchmark results
+
+```
+ForkLedger Benchmark — 300 records, 80 queries
+Load: 2.19s (137 rec/s)
+Latency: p50=5.6ms  p95=25.9ms
+Precision@1: 100.0%
+Policy accuracy: 4/4 = 100.0%
+```
+
+Run yourself:
+```bash
+python benchmarks/locomo_benchmark.py --records 500 --queries 100
+```
+---
+
+## Integrations
+
+### LangChain
+
+```bash
+pip install forkledger[langchain]
+```
+
+```python
+from forkledger.integrations.langchain import ForkLedgerMemory
+
+memory = ForkLedgerMemory(
+    store_path="decisions.db",
+    backend="sqlite",
+    agent_id="my-agent",
+    domain="research",   # pre-tuned scoring weights
+)
+
+# Record decisions manually
+memory.record_decision(
+    fork_id="dec-001",
+    situation={"task": "research", "signal": "mixed"},
+    trigger="Conflicting sources",
+    chosen="verify",
+    alternatives=["fast-publish", "wait"],
+    outcome=1.8,
+)
+
+# Or use as drop-in with ConversationChain
+from langchain.chains import ConversationChain
+chain = ConversationChain(llm=llm, memory=memory)
+```
+
+### AutoGen
+
+```bash
+pip install forkledger[autogen]
+```
+
+```python
+from autogen import AssistantAgent
+from forkledger.integrations.autogen import ForkLedgerHook
+
+hook = ForkLedgerHook(
+    store_path="decisions.db",
+    backend="sqlite",
+    agent_id="assistant",
+    domain="code",
+)
+
+# Attach to any AutoGen agent
+assistant = AssistantAgent("assistant", llm_config=llm_config)
+hook.attach(assistant)   # injects decision context into every message
+
+# Or use standalone
+hook.record(
+    situation={"task": "web_research", "sources": "multiple"},
+    trigger="Conflicting data",
+    chosen="verify_cross_reference",
+    alternatives=["use_first", "skip"],
+    outcome=2.1,
+)
+recs = hook.recommend({"task": "web_research", "sources": "multiple"})
+```
+
+
+---
+
+## Roadmap
+
+- [x] SQLite + JSON backends
+- [x] REST API (FastAPI)
+- [x] MCP server (Claude Desktop, Cursor, VS Code)
+- [x] Fuzzy policy clustering
+- [x] Confidence decay + CFR-style accumulation
+- [x] Branch win rates + audit trail
+- [x] PostgreSQL + pgvector backend
+- [x] Streamlit dashboard
+- [x] Benchmark suite
+- [x] LangChain official memory adapter (`ForkLedgerMemory`)
+- [x] AutoGen integration (`ForkLedgerHook`, `ForkLedgerGroupChatManager`)
+- [x] PyPI release — `pip install forkledger`
+
+---
+
+## Contributing
+
+```bash
+git clone https://github.com/sliper82/forkledger
+cd forkledger
+pip install -e ".[dev]"
+pytest
+python benchmarks/locomo_benchmark.py
+```
+
+Issues, PRs, and ideas welcome. See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+---
+
+## License
+
+[Apache 2.0](LICENSE)