Skip to main content

Build long-lived multimodal memory, dream over it, and retrieve context with transparent weighting.

Project description

cellin

PyPI Version Release Passing

Cellin builds long-lived multimodal memory, dreams over it to consolidate ideas, and retrieves context with transparent weighted ranking.

Install

From source today:

git clone https://github.com/ben-ranford/cellin.git
cd cellin
make bootstrap

Install from PyPI:

python3 -m pip install cellin

Quickstart

From the repository root:

WORKSPACE=.cellin-workspace
python3 -m uv run cellin init --workspace "$WORKSPACE"
python3 -m uv run cellin ingest --config "$WORKSPACE/cellin.json" --input examples/starter/seed_envelopes.json
python3 -m uv run cellin retrieve --config "$WORKSPACE/cellin.json" --query "memory graph retrieval" --top-k 2
python3 -m uv run cellin dream --config "$WORKSPACE/cellin.json" --strategy abstraction
python3 -m uv run cellin eval run --suite smoke --config "$WORKSPACE/cellin.json" --output "$WORKSPACE/smoke.json"
python3 -m uv run cellin trace inspect --config "$WORKSPACE/cellin.json" --limit 5

See examples/starter/README.md for the same flow in a shorter checklist form.

Workspace config now supports role-specific storage backends:

{
  "runtime_id": "cellin-cli",
  "trace_path": "traces.jsonl",
  "profile_name": "balanced",
  "storage": {
    "memory": { "backend": "in_memory" },
    "graph": { "backend": "in_memory" },
    "vector": { "backend": "in_memory_vector_index" },
    "representation": { "backend": "in_memory_vector_index" }
  }
}

cellin init now writes this in-memory-first preset by default.

Legacy workspaces that only define database_path continue to work and are migrated to this shape behind the scenes.

For an explicit SQLite preset, set:

{
  "memory": { "backend": "sqlite", "database_path": "cellin.sqlite" },
  "graph": { "backend": "sqlite", "database_path": "cellin.sqlite" }
}

For additional SQL-backed presets, install optional dependencies as needed:

python3 -m pip install cellin[duckdb]
python3 -m pip install cellin[postgresql]
python3 -m pip install cellin[mysql]
python3 -m pip install cellin[sql-backends]

Use duckdb to point both roles at a local DB file:

{
  "memory": { "backend": "duckdb", "database_path": "cellin.duckdb" },
  "graph": { "backend": "duckdb", "database_path": "cellin.duckdb" }
}

Use postgresql and mysql with connection strings:

{
  "memory": { "backend": "postgresql", "database_path": "postgresql://user:pass@host:5432/db" },
  "graph": { "backend": "postgresql", "database_path": "postgresql://user:pass@host:5432/db" }
}

{
  "memory": { "backend": "mysql", "database_path": "mysql://user:pass@host:3306/db" },
  "graph": { "backend": "mysql", "database_path": "mysql://user:pass@host:3306/db" }
}

For document and cache-oriented presets, install optional dependencies as needed:

python3 -m pip install cellin[mongodb]
python3 -m pip install cellin[redis]
python3 -m pip install cellin[document-cache-backends]

Use mongodb when you want durable document storage for both memories and edges:

{
  "memory": { "backend": "mongodb", "database_path": "mongodb://user:pass@host:27017/cellin" },
  "graph": { "backend": "mongodb", "database_path": "mongodb://user:pass@host:27017/cellin" }
}

Use redis for low-latency cache-oriented deployments where operators control TTL or eviction:

{
  "memory": { "backend": "redis", "database_path": "redis://host:6379/0" },
  "graph": { "backend": "redis", "database_path": "redis://host:6379/0" }
}

MongoDB stores whole memory and edge documents and preserves archived entries as tombstones in the document payloads. Redis stores JSON payloads per key and also preserves archived entries as tombstones, filtering them from neighbor and edge listing reads rather than hard-deleting them.

Primary surfaces

  • CLI: cellin init, ingest, retrieve, dream, plugin list, eval run, trace inspect
  • Ingestion: cellin.ingest.ArtifactEnvelope and cellin.ingest.CanonicalIngestor
  • Retrieval: cellin.retrieval.WeightedRetriever, cellin.retrieval.RetrievalCandidateGenerator, and cellin.ranking.WeightedRanker
  • Dreaming: cellin.dreaming.DreamRunner plus the built-in deduplication, abstraction, and contradiction-repair strategies
  • Evals: cellin.evals.run_evaluation_suite and cellin.evals.run_smoke_eval
  • Extensibility: cellin.runtime.PluginRegistry and the contracts exported from cellin.core

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cellin-0.3.0.dev2399734251501.tar.gz (156.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cellin-0.3.0.dev2399734251501-py3-none-any.whl (63.1 kB view details)

Uploaded Python 3

File details

Details for the file cellin-0.3.0.dev2399734251501.tar.gz.

File metadata

  • Download URL: cellin-0.3.0.dev2399734251501.tar.gz
  • Upload date:
  • Size: 156.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for cellin-0.3.0.dev2399734251501.tar.gz
Algorithm Hash digest
SHA256 20daa195deaefda6ef4fce7a935a5d58d06bc1dd5134c2763eb6785ff42d26b0
MD5 f1518d6664691067ebb3f37e519281ca
BLAKE2b-256 ac62916ac8df73984f799d9bc35c131ad35d3ac7481b2893ad201ceeb2ffe6f3

See more details on using hashes here.

Provenance

The following attestation bundles were made for cellin-0.3.0.dev2399734251501.tar.gz:

Publisher: rolling-release.yml on ben-ranford/cellin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cellin-0.3.0.dev2399734251501-py3-none-any.whl.

File metadata

File hashes

Hashes for cellin-0.3.0.dev2399734251501-py3-none-any.whl
Algorithm Hash digest
SHA256 73105a73b832c3c12de46583100762e7780b5378cf8fa2008064b887686c3981
MD5 a88ca439a7e0f6a789bf23760c1b69db
BLAKE2b-256 0c2ba6416d97362b957878ef37fa27a0b090deefbefd351c8766526642b96969

See more details on using hashes here.

Provenance

The following attestation bundles were made for cellin-0.3.0.dev2399734251501-py3-none-any.whl:

Publisher: rolling-release.yml on ben-ranford/cellin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page