cogno-anima 0.1.0__tar.gz

cogno_anima-0.1.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 2026 Sudoers AI
+
+   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.

cogno_anima-0.1.0/PKG-INFO

@@ -0,0 +1,247 @@
+Metadata-Version: 2.4
+Name: cogno-anima
+Version: 0.1.0
+Summary: Infrastructure-agnostic cognitive pipeline core (NOUMENO/NER/ID/EGO/SUPEREGO + Drift)
+Author: Vinicius Vale
+Maintainer: Sudoers AI
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/sudoers-ai/cogno-anima
+Project-URL: Repository, https://github.com/sudoers-ai/cogno-anima
+Project-URL: Issues, https://github.com/sudoers-ai/cogno-anima/issues
+Keywords: llm,nlp,cognitive-architecture,agents,function-calling,pii,ollama
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+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
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Operating System :: OS Independent
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic>=2.0
+Requires-Dist: langdetect>=1.0.9
+Requires-Dist: cogno-synapse<0.2,>=0.1
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23.0; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Requires-Dist: hypothesis>=6.0; extra == "dev"
+Requires-Dist: ruff>=0.5; extra == "dev"
+Requires-Dist: mypy>=1.8; extra == "dev"
+Provides-Extra: llm
+Requires-Dist: cogno-synapse[llm]<0.2,>=0.1; extra == "llm"
+Dynamic: license-file
+
+# 🧠 cogno-anima
+
+**The infrastructure-agnostic cognitive pipeline at the heart of [Cogno](https://github.com/sudoers-ai).**
+
+`cogno-anima` is a modular, dependency-light library that turns raw user input
+into a routed, grounded, persona-voiced response — decoupled from any database,
+message bus, or proprietary infra. It is the brain; the host — your application —
+is the body that carries it.
+
+![SECRETARY demo — the full pipeline booking an appointment on a free local model](docs/assets/secretary-demo.gif)
+
+*The whole stack, live on a free 8B local model: NOUMENO rewrites Portuguese to
+canonical English, the ID routes, the EGO calls real scheduling tools (and
+self-corrects around a weekend), the judge approves, the voice replies in the
+persona. Run it yourself in ~15 minutes — see
+[Try it](#try-it--a-complete-agent-in-15-minutes) · quality numbers in
+[BENCHMARKS.md](BENCHMARKS.md).*
+
+```
+NOUMENO  →  NER  →  ID  →  EGO  →  SUPEREGO        (+ Drift, woven through)
+   │         │       │      │          │
+ rewrite   intent  route  execute    voice
+ to EN     + PII   + goal  (tools)   + judge
+```
+
+- **NOUMENO** — perception: slang/normalization, language resolution, rewrite to canonical English, epistemological drift.
+- **NER** — semantic analysis: intent, sentiment, entities, PII (detected deterministically, never trusted from the LLM), domains — all coerced to a closed vocabulary.
+- **ID** — strategic router & continuity (heuristic, no LLM): goal lifecycle, BDI intentions, attention, safety gate, drift.
+- **EGO** — executor: runs an agent loop and dispatches tools (native function calling *or* a `<TOOL_CALL>` text fallback). It gathers data; it does **not** write the reply.
+- **SUPEREGO** — locutor: scope guard + judge (goal↔execution) + **writes** the final response in the persona's voice, grounded in the EGO's data.
+- **Drift** — pure, no I/O: epistemological → ontological → situational → execution → synthesis → cumulative, emitting a `drift_action` signal.
+
+## Philosophy: the core signals, the host decides
+
+`cogno-anima` deliberately ships **no business rules and no infrastructure**. It is
+built on a few hard contracts:
+
+- **Infra-agnostic** — no DB, no MCP, no queue. Tool execution is delegated to a host-injected `ToolDispatcher` ("EGO = brain, dispatcher = hands"). Persistence, transactions, rollback/outbox and atomicity are **host** concerns.
+- **Never trust the LLM** — PII risk, routing, vocabularies and drift are computed deterministically; the LLM's self-assessment is ignored.
+- **Signals, not exceptions** — the core emits `drift_action`, `blocked`, `interrupted`, `needs_handoff`, `stop_reason`; the host turns those into actions (retry, escalate, hand off to a human).
+- **Stateless across turns** — all cross-turn state rides in `ctx.metadata` (e.g. `id_state`), a serializable dict the host persists — safe for multi-worker setups.
+- **Errors propagate** — backends raise on transport/auth failure instead of degrading silently; a `FallbackBackend` is how you opt into failover.
+
+What stays in the **host**: persona/MCP binding, RBAC, model ladders, the
+retry/correction *loop*, session splitting, the real human handoff, billing,
+semantic cache, and persistence. See **[docs/HOST_INTEGRATION.md](docs/HOST_INTEGRATION.md)**
+for how to wire the core into a host, `CLAUDE.md` for the full boundary map, and
+`cognobench/pipeline.py` (`ReferencePipeline`) for a reference orchestrator.
+
+## Try it — a complete agent in 15 minutes
+
+The fastest way to *feel* the pipeline is the SECRETARY demo in
+[`cogno-praxis`](https://github.com/sudoers-ai/cogno-praxis): the full
+cognitive loop over local Ollama, with a real scheduling vertical served as an
+MCP subprocess — free, offline, any language in:
+
+```bash
+ollama pull qwen3:8b && ollama pull nomic-embed-text     # the download IS most of the 15 min
+
+pip install "git+https://github.com/sudoers-ai/cogno-homeo" \
+            "git+https://github.com/sudoers-ai/cogno-synapse" \
+            "git+https://github.com/sudoers-ai/cogno-anima" \
+            "git+https://github.com/sudoers-ai/cogno-soma" \
+            "cogno-mcp[mcp] @ git+https://github.com/sudoers-ai/cogno-mcp"
+
+git clone https://github.com/sudoers-ai/cogno-praxis && cd cogno-praxis
+pip install -e .
+python examples/secretary_demo.py --trace     # --trace shows each cognitive stage live
+```
+
+(PyPI packages are coming; the git chain above is the interim install.)
+
+## Install
+
+```bash
+pip install -e .                      # core (pydantic, langdetect, httpx)
+pip install -e ".[dev]"               # + test/lint/type-check tooling
+
+# Optional cloud backends (SDKs are lazy-imported — install only what you use):
+pip install "cogno-anima[openai]"      # also: anthropic | groq | gemini | bedrock | llm (all)
+```
+
+Local inference uses [Ollama](https://ollama.com) (`mistral:latest` for the
+cognitive stages, `nomic-embed-text:latest` for embeddings) by default.
+
+## Quickstart (perception + routing)
+
+The first three stages need only an `LLMBackend` + an `Embedder` — no dispatcher,
+no DB:
+
+```python
+import asyncio
+from cogno_anima.types import PipelineContext
+from cogno_synapse import OllamaBackend, OllamaEmbedder, CachingEmbedder
+from cogno_anima.stages.noumeno import Noumeno
+from cogno_anima.stages.ner import IntentAnalyzer
+from cogno_anima.stages.id import IDStage
+
+async def main():
+    llm = OllamaBackend(model="mistral:latest", temperature=0.0, format="json")
+    embedder = CachingEmbedder(OllamaEmbedder(model="nomic-embed-text"))
+
+    ctx = PipelineContext(user_input="quanto tá o meu saldo?")
+    ctx = await Noumeno(embedder).process(ctx, llm)
+    ctx = await IntentAnalyzer().process(ctx, llm)
+    ctx = await IDStage().process(ctx, embedder)
+
+    print(ctx.noumeno.rewritten)        # "what is my balance?"
+    print(ctx.intent.intent_class)      # INFORMATION_REQUEST
+    print(ctx.id_result.triad_route)    # EGO  (tool gateway)
+    print(ctx.total_tokens)             # LLM + embedding cost
+
+asyncio.run(main())
+```
+
+To run the **full** pipeline (EGO tool dispatch + SUPEREGO voicing + the
+correction loop), you provide a `ToolDispatcher`, persona prompts, and the
+orchestration glue. A complete, runnable reference lives in
+`cognobench/pipeline.py: ReferencePipeline`.
+
+## LLM & embedder backends
+
+Stages depend only on three runtime-checkable `Protocol`s defined in the sibling
+[`cogno-synapse`](https://github.com/sudoers-ai/cogno-synapse) lib
+(`cogno_synapse.base`): `LLMBackend`, the optional `ToolCallingBackend` (native
+function calling), and `Embedder`. Anything matching the shape works. (`cogno-anima`
+re-exports them, so `from cogno_anima import LLMBackend` keeps working.)
+
+- **Local**: `OllamaBackend`, `OllamaEmbedder` (+ `CachingEmbedder` adds a bounded LRU + token accounting to any embedder).
+- **Cloud**: OpenAI, Anthropic, Groq, Gemini, Bedrock — each implements native function calling.
+- **OpenAI-compatible** (DeepSeek, Moonshot/Kimi, xAI/Grok, OpenRouter, Together, Fireworks): reuse `OpenAIBackend` via its `base_url`, selected by `create_backend("deepseek:deepseek-chat")`.
+- **Failover**: `FallbackBackend([...])` tries each in order; first success wins.
+
+```python
+from cogno_synapse import create_backend
+backend = create_backend("openai:gpt-4o-mini")   # or "deepseek:deepseek-chat", "qwen3:8b", …
+```
+
+## CognoBench
+
+A self-contained, dependency-light cognitive benchmark (`cognobench/`), kept
+decoupled from the library, scoring each stage end-to-end against a real model:
+
+```bash
+python3 cognobench.py                          # all dimensions vs local Ollama
+python3 cognobench.py --only ner --limit 3     # one dimension, few cases
+python3 cognobench.py --only conversations     # broad multi-turn e2e simulation
+python3 cognobench.py --stub --limit 3         # fast plumbing smoke (no model)
+```
+
+Dimensions: `noumeno · ner · id · ego · superego · drift · conversations`. Hard
+invariants are enforced; model-dependent "soft" checks are recalibratable with
+`--calibrate`. The benchmark is **not** shipped in the wheel.
+
+**Consolidated scoreboard — quality per cognitive function × model, and where
+small models break: [BENCHMARKS.md](BENCHMARKS.md).**
+
+## The Cogno ecosystem
+
+`cogno-anima` is one organ of **[Cogno](https://github.com/sudoers-ai)** — a family of
+small, composable, Apache-2.0 libraries that together form a complete
+conversational-agent platform. Each library owns a single concern and stays
+infra-agnostic; a **host** assembles them into a running agent:
+
+![The Cogno ecosystem](docs/assets/cogno-ecosystem.svg)
+
+The open-source libraries are the organs; the **host is the body** that joins
+them. Our reference host — `cogno-host`, with its `cogno-ui` dashboard — is the
+private product layer, but it holds no special powers: everything it does rides
+on the public seams documented in each library's `docs/HOST_INTEGRATION.md`, so
+you can assemble a body of your own.
+
+## Testing
+
+```bash
+python3 -m pytest                  # everything
+python3 -m pytest tests/unit       # fast, no network (stubs)
+python3 -m pytest tests/integration  # real Ollama; auto-skips if unavailable
+```
+
+Unit tests run on a coverage gate (`--cov-fail-under=85`) and use the
+`StubBackend`/`StubEmbedder` doubles in `tests/conftest.py`. Integration tests
+use real models at `temperature=0.0` for determinism.
+
+## Inspiration
+
+Cogno models a conversational agent on a coarse map of **human perception and the
+psyche** rather than on a flat prompt→response call. The stage names are the map:
+
+- **NOUMENO** — after Kant's *noumenon*: the raw thing-in-itself is normalized into
+  a *perceived* phenomenon (canonical English) before the mind reasons over it.
+- **ID · EGO · SUPEREGO** — Freud's structural model of the psyche: the **ID** as the
+  strategic drive/router, the **EGO** as the executor mediating with the outside world
+  (tools), the **SUPEREGO** as the internalized judge and voice of limits.
+- **Aristotelian** intent tags — the categories/causal analysis borrowed from Aristotle.
+- **Drift** — an epistemological check on how far perception has strayed from the input.
+
+It is an engineering metaphor, not a claim of psychological fidelity — but the analogy
+is load-bearing: it is *why* perception, drive, execution and conscience are separate,
+deterministically-gated stages instead of one prompt.
+
+## Credits
+
+Created by **Vinicius Vale** — [Sudoers](https://github.com/sudoers-ai).
+Contributions welcome under the Apache-2.0 license below.
+
+## License
+
+Licensed under the [Apache License 2.0](LICENSE).

cogno_anima-0.1.0/README.md

@@ -0,0 +1,209 @@
+# 🧠 cogno-anima
+
+**The infrastructure-agnostic cognitive pipeline at the heart of [Cogno](https://github.com/sudoers-ai).**
+
+`cogno-anima` is a modular, dependency-light library that turns raw user input
+into a routed, grounded, persona-voiced response — decoupled from any database,
+message bus, or proprietary infra. It is the brain; the host — your application —
+is the body that carries it.
+
+![SECRETARY demo — the full pipeline booking an appointment on a free local model](docs/assets/secretary-demo.gif)
+
+*The whole stack, live on a free 8B local model: NOUMENO rewrites Portuguese to
+canonical English, the ID routes, the EGO calls real scheduling tools (and
+self-corrects around a weekend), the judge approves, the voice replies in the
+persona. Run it yourself in ~15 minutes — see
+[Try it](#try-it--a-complete-agent-in-15-minutes) · quality numbers in
+[BENCHMARKS.md](BENCHMARKS.md).*
+
+```
+NOUMENO  →  NER  →  ID  →  EGO  →  SUPEREGO        (+ Drift, woven through)
+   │         │       │      │          │
+ rewrite   intent  route  execute    voice
+ to EN     + PII   + goal  (tools)   + judge
+```
+
+- **NOUMENO** — perception: slang/normalization, language resolution, rewrite to canonical English, epistemological drift.
+- **NER** — semantic analysis: intent, sentiment, entities, PII (detected deterministically, never trusted from the LLM), domains — all coerced to a closed vocabulary.
+- **ID** — strategic router & continuity (heuristic, no LLM): goal lifecycle, BDI intentions, attention, safety gate, drift.
+- **EGO** — executor: runs an agent loop and dispatches tools (native function calling *or* a `<TOOL_CALL>` text fallback). It gathers data; it does **not** write the reply.
+- **SUPEREGO** — locutor: scope guard + judge (goal↔execution) + **writes** the final response in the persona's voice, grounded in the EGO's data.
+- **Drift** — pure, no I/O: epistemological → ontological → situational → execution → synthesis → cumulative, emitting a `drift_action` signal.
+
+## Philosophy: the core signals, the host decides
+
+`cogno-anima` deliberately ships **no business rules and no infrastructure**. It is
+built on a few hard contracts:
+
+- **Infra-agnostic** — no DB, no MCP, no queue. Tool execution is delegated to a host-injected `ToolDispatcher` ("EGO = brain, dispatcher = hands"). Persistence, transactions, rollback/outbox and atomicity are **host** concerns.
+- **Never trust the LLM** — PII risk, routing, vocabularies and drift are computed deterministically; the LLM's self-assessment is ignored.
+- **Signals, not exceptions** — the core emits `drift_action`, `blocked`, `interrupted`, `needs_handoff`, `stop_reason`; the host turns those into actions (retry, escalate, hand off to a human).
+- **Stateless across turns** — all cross-turn state rides in `ctx.metadata` (e.g. `id_state`), a serializable dict the host persists — safe for multi-worker setups.
+- **Errors propagate** — backends raise on transport/auth failure instead of degrading silently; a `FallbackBackend` is how you opt into failover.
+
+What stays in the **host**: persona/MCP binding, RBAC, model ladders, the
+retry/correction *loop*, session splitting, the real human handoff, billing,
+semantic cache, and persistence. See **[docs/HOST_INTEGRATION.md](docs/HOST_INTEGRATION.md)**
+for how to wire the core into a host, `CLAUDE.md` for the full boundary map, and
+`cognobench/pipeline.py` (`ReferencePipeline`) for a reference orchestrator.
+
+## Try it — a complete agent in 15 minutes
+
+The fastest way to *feel* the pipeline is the SECRETARY demo in
+[`cogno-praxis`](https://github.com/sudoers-ai/cogno-praxis): the full
+cognitive loop over local Ollama, with a real scheduling vertical served as an
+MCP subprocess — free, offline, any language in:
+
+```bash
+ollama pull qwen3:8b && ollama pull nomic-embed-text     # the download IS most of the 15 min
+
+pip install "git+https://github.com/sudoers-ai/cogno-homeo" \
+            "git+https://github.com/sudoers-ai/cogno-synapse" \
+            "git+https://github.com/sudoers-ai/cogno-anima" \
+            "git+https://github.com/sudoers-ai/cogno-soma" \
+            "cogno-mcp[mcp] @ git+https://github.com/sudoers-ai/cogno-mcp"
+
+git clone https://github.com/sudoers-ai/cogno-praxis && cd cogno-praxis
+pip install -e .
+python examples/secretary_demo.py --trace     # --trace shows each cognitive stage live
+```
+
+(PyPI packages are coming; the git chain above is the interim install.)
+
+## Install
+
+```bash
+pip install -e .                      # core (pydantic, langdetect, httpx)
+pip install -e ".[dev]"               # + test/lint/type-check tooling
+
+# Optional cloud backends (SDKs are lazy-imported — install only what you use):
+pip install "cogno-anima[openai]"      # also: anthropic | groq | gemini | bedrock | llm (all)
+```
+
+Local inference uses [Ollama](https://ollama.com) (`mistral:latest` for the
+cognitive stages, `nomic-embed-text:latest` for embeddings) by default.
+
+## Quickstart (perception + routing)
+
+The first three stages need only an `LLMBackend` + an `Embedder` — no dispatcher,
+no DB:
+
+```python
+import asyncio
+from cogno_anima.types import PipelineContext
+from cogno_synapse import OllamaBackend, OllamaEmbedder, CachingEmbedder
+from cogno_anima.stages.noumeno import Noumeno
+from cogno_anima.stages.ner import IntentAnalyzer
+from cogno_anima.stages.id import IDStage
+
+async def main():
+    llm = OllamaBackend(model="mistral:latest", temperature=0.0, format="json")
+    embedder = CachingEmbedder(OllamaEmbedder(model="nomic-embed-text"))
+
+    ctx = PipelineContext(user_input="quanto tá o meu saldo?")
+    ctx = await Noumeno(embedder).process(ctx, llm)
+    ctx = await IntentAnalyzer().process(ctx, llm)
+    ctx = await IDStage().process(ctx, embedder)
+
+    print(ctx.noumeno.rewritten)        # "what is my balance?"
+    print(ctx.intent.intent_class)      # INFORMATION_REQUEST
+    print(ctx.id_result.triad_route)    # EGO  (tool gateway)
+    print(ctx.total_tokens)             # LLM + embedding cost
+
+asyncio.run(main())
+```
+
+To run the **full** pipeline (EGO tool dispatch + SUPEREGO voicing + the
+correction loop), you provide a `ToolDispatcher`, persona prompts, and the
+orchestration glue. A complete, runnable reference lives in
+`cognobench/pipeline.py: ReferencePipeline`.
+
+## LLM & embedder backends
+
+Stages depend only on three runtime-checkable `Protocol`s defined in the sibling
+[`cogno-synapse`](https://github.com/sudoers-ai/cogno-synapse) lib
+(`cogno_synapse.base`): `LLMBackend`, the optional `ToolCallingBackend` (native
+function calling), and `Embedder`. Anything matching the shape works. (`cogno-anima`
+re-exports them, so `from cogno_anima import LLMBackend` keeps working.)
+
+- **Local**: `OllamaBackend`, `OllamaEmbedder` (+ `CachingEmbedder` adds a bounded LRU + token accounting to any embedder).
+- **Cloud**: OpenAI, Anthropic, Groq, Gemini, Bedrock — each implements native function calling.
+- **OpenAI-compatible** (DeepSeek, Moonshot/Kimi, xAI/Grok, OpenRouter, Together, Fireworks): reuse `OpenAIBackend` via its `base_url`, selected by `create_backend("deepseek:deepseek-chat")`.
+- **Failover**: `FallbackBackend([...])` tries each in order; first success wins.
+
+```python
+from cogno_synapse import create_backend
+backend = create_backend("openai:gpt-4o-mini")   # or "deepseek:deepseek-chat", "qwen3:8b", …
+```
+
+## CognoBench
+
+A self-contained, dependency-light cognitive benchmark (`cognobench/`), kept
+decoupled from the library, scoring each stage end-to-end against a real model:
+
+```bash
+python3 cognobench.py                          # all dimensions vs local Ollama
+python3 cognobench.py --only ner --limit 3     # one dimension, few cases
+python3 cognobench.py --only conversations     # broad multi-turn e2e simulation
+python3 cognobench.py --stub --limit 3         # fast plumbing smoke (no model)
+```
+
+Dimensions: `noumeno · ner · id · ego · superego · drift · conversations`. Hard
+invariants are enforced; model-dependent "soft" checks are recalibratable with
+`--calibrate`. The benchmark is **not** shipped in the wheel.
+
+**Consolidated scoreboard — quality per cognitive function × model, and where
+small models break: [BENCHMARKS.md](BENCHMARKS.md).**
+
+## The Cogno ecosystem
+
+`cogno-anima` is one organ of **[Cogno](https://github.com/sudoers-ai)** — a family of
+small, composable, Apache-2.0 libraries that together form a complete
+conversational-agent platform. Each library owns a single concern and stays
+infra-agnostic; a **host** assembles them into a running agent:
+
+![The Cogno ecosystem](docs/assets/cogno-ecosystem.svg)
+
+The open-source libraries are the organs; the **host is the body** that joins
+them. Our reference host — `cogno-host`, with its `cogno-ui` dashboard — is the
+private product layer, but it holds no special powers: everything it does rides
+on the public seams documented in each library's `docs/HOST_INTEGRATION.md`, so
+you can assemble a body of your own.
+
+## Testing
+
+```bash
+python3 -m pytest                  # everything
+python3 -m pytest tests/unit       # fast, no network (stubs)
+python3 -m pytest tests/integration  # real Ollama; auto-skips if unavailable
+```
+
+Unit tests run on a coverage gate (`--cov-fail-under=85`) and use the
+`StubBackend`/`StubEmbedder` doubles in `tests/conftest.py`. Integration tests
+use real models at `temperature=0.0` for determinism.
+
+## Inspiration
+
+Cogno models a conversational agent on a coarse map of **human perception and the
+psyche** rather than on a flat prompt→response call. The stage names are the map:
+
+- **NOUMENO** — after Kant's *noumenon*: the raw thing-in-itself is normalized into
+  a *perceived* phenomenon (canonical English) before the mind reasons over it.
+- **ID · EGO · SUPEREGO** — Freud's structural model of the psyche: the **ID** as the
+  strategic drive/router, the **EGO** as the executor mediating with the outside world
+  (tools), the **SUPEREGO** as the internalized judge and voice of limits.
+- **Aristotelian** intent tags — the categories/causal analysis borrowed from Aristotle.
+- **Drift** — an epistemological check on how far perception has strayed from the input.
+
+It is an engineering metaphor, not a claim of psychological fidelity — but the analogy
+is load-bearing: it is *why* perception, drive, execution and conscience are separate,
+deterministically-gated stages instead of one prompt.
+
+## Credits
+
+Created by **Vinicius Vale** — [Sudoers](https://github.com/sudoers-ai).
+Contributions welcome under the Apache-2.0 license below.
+
+## License
+
+Licensed under the [Apache License 2.0](LICENSE).