-
Notifications
You must be signed in to change notification settings - Fork 0
docs: pre-public-launch narrative #49
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.
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # Credits & Intellectual Lineage | ||
|
|
||
| Gradata synthesizes ideas from decades of research and engineering practice. Standing on the shoulders of giants isn't stealing — it's the whole point of an open ecosystem. This document credits the work that shaped Gradata. | ||
|
|
||
| ## Research foundations | ||
|
|
||
| - **Constitutional AI** (Anthropic, 2022) — the self-critique + revision loop under `sdk/src/gradata/enhancements/rule_verifier.py` is inspired by the RLAIF methodology introduced in *"Constitutional AI: Harmlessness from AI Feedback"* (Bai et al., 2022). | ||
| - **Half-life regression** (Settles & Meeder, ACL 2016) — confidence decay curves in the graduation engine draw on *"A Trainable Spaced Repetition Model for Language Learning"* and the Wozniak/Duolingo two-component memory model. | ||
| - **Generative agents** (Park et al., Stanford 2023/2024) — *"Generative Agents: Interactive Simulacra of Human Behavior"* and *"Generative Agent Simulations of 1,000 People"* (2024) validate our simulation-first design methodology; the latter demonstrated generative agents are ~85% as accurate as humans on survey responses. | ||
| - **MT-Bench / LLM-as-judge** (Zheng et al., NeurIPS 2023) — scoring methodology in `brain/scripts/brain_benchmark.py` adapts the multi-judge consensus approach from *"Judging LLM-as-a-Judge with MT-Bench and Chatbot Arena"*. | ||
| - **Self-preference bias in LLM judges** (2024) — informs our anonymization step before judging to control known evaluator biases. | ||
| - **Grammarly ROI study** (2024) — the "19 days saved per year" framing informs our *Est. Time Saved* KPI. | ||
| - **Copilot RCT** (Peng et al., 2023) — *"The Impact of AI on Developer Productivity: Evidence from GitHub Copilot"* reported a 55.8% speedup on a controlled coding task and anchors our developer-impact benchmarks. | ||
| - **SuperMemo 2 / two-component memory** (Wozniak, 1995) — retrievability + stability decomposition underpinning our confidence decay model. | ||
| - **Persona transparency** (AAAI 2025) — persona documentation requirements for simulation research inform how we publish MiroFish panels. | ||
|
|
||
| ## Architectural inspirations | ||
|
|
||
| - **Mem0** — shared memory-first framing for AI agents. Gradata's difference: we learn from corrections, not just recall facts. | ||
| - **Letta** (formerly MemGPT) — agent state persistence patterns. Gradata's difference: state is rules, graduated from evidence rather than stored conversations. | ||
| - **EverMind / EverMemOS** (TCCI, 2025) — reported 92.3% on the LoCoMo memory-recall benchmark. Gradata is complementary: it adds the correction-learning layer on top of memory recall. | ||
| - **The 15 agentic patterns** — orchestrator, reflection, memory, rule_engine, RAG, tree-of-thoughts, and the rest are standard LLM-app primitives. Gradata builds the *enhancements* layer (`diff_engine`, `quality_gates`, `truth_protocol`, `meta_rules`, `rule_verifier`) on top of these primitives. | ||
|
|
||
| ## Research methodology | ||
|
|
||
| - **MiroFish expert-panel simulation** — multi-round structured debate across grounded personas. Our adaptation lives in `brain/scripts/mirofish_sim.py`. The methodology is our own synthesis of published simulation work (Park et al.; Anthropic's Constitutional AI). | ||
| - **Mann-Kendall trend test** — autocorrelation-aware statistical validation used in our convergence checks. | ||
| - **OASIS framework** — indirect influence on our batch-run pattern for stress tests. | ||
| - **Karpathy-style autoresearch** — iterative self-improvement with verification gates. Our optimization runner adopts this pattern. | ||
|
|
||
| ## Open-source dependencies | ||
|
|
||
| Key libraries Gradata is built on: FastAPI, Next.js, Recharts, Supabase, Stripe, Pydantic, pytest, Vitest, Tailwind, Radix UI, React. Full dependency lists are in `pyproject.toml` and `package.json`. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Critical: Inaccurate dependency claims contradict actual project requirements. This line claims FastAPI and Pydantic are "key libraries Gradata is built on," but they are completely absent from
This factual error will undermine credibility at public launch when developers verify the claims. 📋 Verification script to audit actual dependencies#!/bin/bash
# Description: Check actual dependencies vs. CREDITS.md claims
echo "=== SDK dependencies from pyproject.toml ==="
rg -A 20 '^\[project\]' pyproject.toml | rg -A 15 '^dependencies'
echo -e "\n=== Cloud dashboard dependencies from package.json ==="
fd -t f package.json -x cat {}
echo -e "\n=== Searching for FastAPI usage in SDK ==="
rg -n 'from fastapi|import fastapi' --type py -g 'sdk/**'
echo -e "\n=== Searching for Pydantic usage in SDK ==="
rg -n 'from pydantic|import pydantic' --type py -g 'sdk/**'✏️ Suggested fix to accurately represent dependencies-Key libraries Gradata is built on: FastAPI, Next.js, Recharts, Supabase, Stripe, Pydantic, pytest, Vitest, Tailwind, Radix UI, React. Full dependency lists are in `pyproject.toml` and `package.json`.
+**SDK**: Zero required runtime dependencies — pure Python + standard library. Optional dependencies: sentence-transformers (embeddings), google-genai (Gemini), cryptography (encryption at rest).
+
+**Cloud dashboard**: Next.js, React, Recharts, Supabase, Stripe, Tailwind, Radix UI.
+
+**Development & testing**: pytest, Vitest, pyright, ruff, bandit.
+
+Full dependency lists are in `pyproject.toml` and `cloud/dashboard/package.json`.🤖 Prompt for AI Agents |
||
|
|
||
| ## What's new here | ||
|
|
||
| Gradata's novel contribution is the **graduation pipeline + correction tracking + compound proof** — the data dynamics that make personal AI learning work. Not the patterns. Not the libraries. The loop. | ||
|
|
||
| ## License | ||
|
|
||
| Gradata is **AGPL-3.0** — use it, fork it, host it. If you host a SaaS version, your modifications must be open-source too. This is deliberate: the common ecosystem wins, the fork-and-close play doesn't. | ||
| Original file line number | Diff line number | Diff line change | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,66 @@ | ||||||||||||||||||
| # Public-Launch Narrative — Draft for Review | ||||||||||||||||||
|
|
||||||||||||||||||
| This PR prepares Gradata's marketing + credits narrative before going public. It is separate from the cleanup PR so the voice/framing decisions can be reviewed without noise from refactors. | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Why this PR exists | ||||||||||||||||||
|
|
||||||||||||||||||
| Going public invites two predictable reactions: | ||||||||||||||||||
|
|
||||||||||||||||||
| 1. *"This is just Mem0 / Letta / a prompt library."* | ||||||||||||||||||
| 2. *"You didn't invent any of this. You copied X."* | ||||||||||||||||||
|
|
||||||||||||||||||
| Both reactions dissolve if we lead with transparent attribution. The goal of this PR is to turn potential "you copied X" accusations into credited prior art, and to sharpen the one-sentence pitch so it lands for three different buyers (founder-engineer, OSS believer, enterprise). | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Pieces shipped in this PR | ||||||||||||||||||
|
|
||||||||||||||||||
| ### 1. `CREDITS.md` (new, repo root) | ||||||||||||||||||
|
|
||||||||||||||||||
| Transparent-synthesis narrative. Credits: | ||||||||||||||||||
|
|
||||||||||||||||||
| - Research foundations (Constitutional AI, Duolingo half-life regression, Generative Agents, MT-Bench, SuperMemo, Copilot RCT, Grammarly ROI, Persona Transparency Checklist) | ||||||||||||||||||
| - Architectural inspirations (Mem0, Letta, EverMind, 15 agentic patterns) | ||||||||||||||||||
| - Research methodology (MiroFish, Mann-Kendall, OASIS, Karpathy autoresearch) | ||||||||||||||||||
| - Open-source dependencies (summary + pointers to `pyproject.toml` and `package.json`) | ||||||||||||||||||
| - "What's new here" — the graduation pipeline + correction tracking + compound proof | ||||||||||||||||||
|
|
||||||||||||||||||
| All citations are real papers (Park et al., Settles/Meeder Duolingo, Peng Copilot RCT, Zheng MT-Bench, Wozniak SuperMemo, Anthropic Constitutional AI). No invented citations. | ||||||||||||||||||
|
|
||||||||||||||||||
| ### 2. `README.md` (rewritten top, new section) | ||||||||||||||||||
|
|
||||||||||||||||||
| **Before:** H1 was `# Gradata — AI that learns your judgment`, then a descriptive paragraph. | ||||||||||||||||||
|
|
||||||||||||||||||
| **After:** | ||||||||||||||||||
|
|
||||||||||||||||||
| - Cleaner H1: `# Gradata` | ||||||||||||||||||
| - Tagline H2: `## AI that learns your judgment, not just your preferences.` | ||||||||||||||||||
| - Three-bullet product pitch targeting three buyers at once: | ||||||||||||||||||
| - Founder-engineer: pragmatic ROI framing ("use Claude or GPT like you already do") | ||||||||||||||||||
| - OSS believer: AGPL-3.0 + local-first framing | ||||||||||||||||||
| - Enterprise: "simulation-validated" + "honest metrics, not vanity" | ||||||||||||||||||
| - New `## Intellectual lineage` paragraph pointing to `CREDITS.md` | ||||||||||||||||||
|
|
||||||||||||||||||
| Preserved: all badges, install instructions, Quick Start, mermaid diagrams, ablation table, CLI, architecture, Community, Contributing, License. Nothing removed beyond the original opening paragraphs, which were absorbed into the new framing. | ||||||||||||||||||
|
|
||||||||||||||||||
| ### 3. `docs/public-launch-narrative.md` (this file) | ||||||||||||||||||
|
|
||||||||||||||||||
| Explains what changed and why, for review before merge. | ||||||||||||||||||
|
|
||||||||||||||||||
| ## What this PR does NOT do | ||||||||||||||||||
|
|
||||||||||||||||||
| - Does not change product pricing or feature claims. | ||||||||||||||||||
| - Does not touch `marketing/` — that has its own narrative track. | ||||||||||||||||||
| - Does not invent citations — every paper listed is one Oliver approved. | ||||||||||||||||||
| - Does not remove existing README scaffolding (install, quick start, diagrams, license). | ||||||||||||||||||
|
Comment on lines
+50
to
+53
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🧹 Nitpick | 🔵 Trivial Optional: Vary sentence structure to improve readability. Three consecutive sentences begin with "Does not," creating repetitive prose. Consider varying the structure for better flow. ✏️ Suggested rewording ## What this PR does NOT do
-- Does not change product pricing or feature claims.
-- Does not touch `marketing/` — that has its own narrative track.
-- Does not invent citations — every paper listed is one Oliver approved.
-- Does not remove existing README scaffolding (install, quick start, diagrams, license).
+- Product pricing and feature claims remain unchanged.
+- The `marketing/` directory has its own narrative track and is not touched here.
+- Every paper listed is one Oliver approved — no invented citations.
+- Existing README scaffolding (install, quick start, diagrams, license) is preserved.📝 Committable suggestion
Suggested change
🧰 Tools🪛 LanguageTool[style] ~52-~52: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE) [style] ~53-~53: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE) 🤖 Prompt for AI Agents |
||||||||||||||||||
|
|
||||||||||||||||||
| ## Suggested review checklist | ||||||||||||||||||
|
|
||||||||||||||||||
| - [ ] Does the one-sentence pitch in README land for all three buyer profiles? | ||||||||||||||||||
| - [ ] Is `CREDITS.md` generous enough that "you copied X" arguments feel tired on arrival? | ||||||||||||||||||
| - [ ] Are there any sources we should add (papers, systems) before public launch? | ||||||||||||||||||
| - [ ] Is AGPL-3.0 framing in CREDITS the right voice (confident, not apologetic)? | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Follow-ups (not in this PR) | ||||||||||||||||||
|
|
||||||||||||||||||
| - Marketing site lineage page (separate work under `marketing/`). | ||||||||||||||||||
| - `RESEARCH.md` with longer-form academic framing once the paper is ready. | ||||||||||||||||||
| - Hacker News / launch-post alignment with this same vocabulary. | ||||||||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
🏁 Script executed:
Repository: Gradata/gradata
Length of output: 3964
🏁 Script executed:
Repository: Gradata/gradata
Length of output: 5435
🏁 Script executed:
Repository: Gradata/gradata
Length of output: 10893
🏁 Script executed:
Repository: Gradata/gradata
Length of output: 3822
Fix incorrect file paths and methodology citations in CREDITS.md.
Line 7: Path should be
src/gradata/enhancements/rule_verifier.py(notsdk/src/...). Additionally, the file does not implement a self-critique + revision loop; it contains pattern-matching rule verification and tool-based filtering logic only.Line 10: The
brain_benchmark.pyfile does not implement MT-Bench's multi-judge consensus scoring. It uses a custom 7-dimensional weighted scoring system (graduation_ratio, correction_rate_improvement, confidence_distribution, severity_trend, category_extinction, rule_count, graduation_speed).Line 26:
brain/scripts/mirofish_sim.pyexists and contains multi-round debate structures (15 round types), so this reference is structurally sound; verify it implements the claimed "structured debate across grounded personas" before publication.🤖 Prompt for AI Agents