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 storage list --role memory
python3 -m uv run cellin storage init --config "$WORKSPACE/cellin.json" --dry-run
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.

Use cellin storage list to inspect the built-in provider registry and any third-party providers registered through the cellin.storage entry-point group. Run cellin storage init --config <workspace>/cellin.json before first use when you want an explicit, idempotent setup step for durable backends.

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]
python3 -m pip install cellin[storage-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.

For graph-native backends, install the optional dependencies you need:

python3 -m pip install cellin[neo4j]
python3 -m pip install cellin[memgraph]
python3 -m pip install cellin[arangodb]
python3 -m pip install cellin[graph-backends]

Use neo4j, memgraph, or arangodb for the graph role while keeping memory storage separate if you prefer:

{
  "memory": { "backend": "sqlite", "database_path": "cellin.sqlite" },
  "graph": { "backend": "neo4j", "database_path": "bolt://user:pass@host:7687" }
}

Graph-native stores persist edge relationships plus graph-local memory payload snapshots. When GraphStore.get_memory() is asked for a node that only exists as a placeholder created during edge upserts, it returns None and retrieval falls back to the configured memory store as the source of truth. That keeps mixed deployments working without caller changes while making the graph-local snapshot behavior explicit.

For vector-backed retrieval stores, install the optional dependencies you need:

python3 -m pip install cellin[pgvector]
python3 -m pip install cellin[pinecone]
python3 -m pip install cellin[qdrant]
python3 -m pip install cellin[weaviate]
python3 -m pip install cellin[milvus]
python3 -m pip install cellin[redis-vector]
python3 -m pip install cellin[vector-backends]

Use cellin storage init --config "$WORKSPACE/cellin.json" after switching a workspace onto a durable backend family so local files, schemas, or remote collection bootstrap happen explicitly before ingest or retrieval.

Primary surfaces

  • CLI: cellin init, storage list, storage 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.dev2408128151201.tar.gz (215.9 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.dev2408128151201-py3-none-any.whl (81.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cellin-0.3.0.dev2408128151201.tar.gz
  • Upload date:
  • Size: 215.9 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.dev2408128151201.tar.gz
Algorithm Hash digest
SHA256 08d4b4e781a98873c0dd365386de535b8e39a9b11294911d2fe7289ee07dfed5
MD5 d8585359f4bed73f8e0adc3bc0713c4f
BLAKE2b-256 ed1e9082355a33ef024ce33ba82680300b960b084dee0742a00a6096a8399991

See more details on using hashes here.

Provenance

The following attestation bundles were made for cellin-0.3.0.dev2408128151201.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.dev2408128151201-py3-none-any.whl.

File metadata

File hashes

Hashes for cellin-0.3.0.dev2408128151201-py3-none-any.whl
Algorithm Hash digest
SHA256 98ffd0fdb6d219c2f40bcc024e4108a979409d4e478381d9aef13fbf00ec667f
MD5 e29f38b8d9ca981429cba36d3e4eeaed
BLAKE2b-256 72242a8a257c9ef6141edc4aa69d3e1b43bb7a614cd1a549b55ecc4cc67f84a6

See more details on using hashes here.

Provenance

The following attestation bundles were made for cellin-0.3.0.dev2408128151201-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