Skip to main content

Cognition Engine formal packaging entry and CLI runtime shell.

Project description

Cognition Engine|认知引擎

cognition-engine 是一个基于 Google ADK 的轻量级认知产品闭环项目。

当前公开版本:

v0.3.2

v0.3.2 定位为:依赖与虚拟环境治理小版本。业务主链继承 v0.3.1,本版本重点新增 uv.lockuv sync 分场景规则与发布前干净环境验证。

本 README 只描述当前 main 分支的最新公开口径。历史版本通过 CHANGELOG.mddocs/releases/、GitHub Releases 和 Git tag 保留,不在 README 中展开。


1. v0.3.2 阶段边界

v0.3.2 继承 v0.3.1 的业务主链能力,并完成以下环境治理工作:

  1. ADK-backed workflow 主链稳定;
  2. 纯安装态 CE_DATA_DIR 运行入口;
  3. CE_INSIGHTS_DIR 细粒度 insight 覆盖入口;
  4. 真实 provider 可通过环境变量进入 workflow 主链;
  5. 默认 provider 继续保持 mock
  6. google-adk>=2.0.0b1,<2.1 依赖主路;
  7. adk-2.0.0b1 framework metadata 最低入口;
  8. adk-2.0.0a3 历史 smoke / fixtures / 回归数据资产保留;
  9. ce workflow 的 product brief + decision pack + model enhancement 组合结果;
  10. output / metadata 留痕。

v0.3.2 不宣称:

  1. provider 已公开;
  2. --model-provider CLI 参数已公开;
  3. 真实 provider 已成为默认;
  4. Eval 已完成;
  5. 完整 Observability 已完成;
  6. 正式配置中心已建立;
  7. Runner / 观测 / 上下文三条主线已系统梳理完成。

Runner / 观测 / 上下文三条主线统一移交后续版本继续梳理。


2. 安装

克隆公开仓:

git clone git@github.com:peacock-lab/cognition-engine.git
cd cognition-engine

创建并激活虚拟环境:

python -m venv .venv
source .venv/bin/activate

安装项目:

python -m pip install -U pip
python -m pip install -e .

确认 CLI 可用:

ce --help
python -m cognition_engine.cli --help

3. 最小运行方式

v0.3.2 推荐使用外置数据根目录运行:

CE_DATA_DIR="$PWD/data" ce workflow --insight insight-adk-runner-centrality --json

也可以显式覆盖 insight 数据目录:

CE_DATA_DIR="$PWD/data" \
CE_INSIGHTS_DIR="$PWD/data/insights" \
ce workflow --insight insight-adk-runner-centrality --json

当前主入口:

ce workflow --insight insight-adk-runner-centrality
ce workflow --insight insight-adk-runner-centrality --json

ce workflow 会按顺序生成:

product brief
→ decision pack
→ model enhancement
→ workflow-level result
→ metadata

4. Provider 使用边界

当前默认 provider 为:

mock

v0.3.1 起,普通安装已包含本地模型路径所需的 LiteLLM 依赖,并锁定为:

litellm==1.82.6

真实 provider 可通过环境变量显式启用:

CE_MODEL_PROVIDER=adk_litellm_ollama \
CE_DATA_DIR="$PWD/data" \
ce workflow --insight insight-adk-runner-centrality --json

当前公开边界:

  1. 真实 provider 可显式进入 workflow 主链;
  2. 普通安装已包含 LiteLLM 依赖;
  3. 本地模型路径仍需要用户本机启动 Ollama 并准备对应模型;
  4. 当前不公开 --model-provider CLI 参数;
  5. 当前不将真实 provider 设为默认;
  6. provider 公开能力留待后续版本判断。

5. Google ADK 依赖说明

cognition-engine 当前以 Google ADK 2.0.0b1+ 作为受控智能体框架依赖。

依赖已在 pyproject.toml 中声明:

google-adk>=2.0.0b1,<2.1

通常不需要单独手动安装 Google ADK。安装本项目时,Python 包安装流程会读取 pyproject.toml 并安装声明依赖。

本项目不是复制 Google ADK 源码,而是在 Google ADK 依赖之上构建面向认知产出的产品化闭环。


6. 当前公开能力

当前公开能力包括:

  1. ce CLI 入口;
  2. python -m cognition_engine.cli 包入口;
  3. ce workflow 主工作流入口;
  4. CE_DATA_DIR 外置数据根目录;
  5. CE_INSIGHTS_DIR insight 数据目录覆盖入口;
  6. 默认 mock provider;
  7. 环境变量显式启用真实 provider;
  8. product brief / decision pack / model enhancement 组合结果;
  9. Markdown 输出;
  10. metadata 留痕;
  11. 最小公开数据资产与样例。

7. 当前不包含

当前版本不包含:

  1. provider 公开接口;
  2. --model-provider CLI 参数公开;
  3. Eval 完整能力;
  4. 完整 Observability;
  5. 正式配置中心;
  6. GUI / Web / channel 支持;
  7. 完整多智能体编排;
  8. 完整成熟平台能力;
  9. Runner / 观测 / 上下文三主线系统化治理接口。

8. 数据资产边界

当前正式依赖主路为:

google-adk>=2.0.0b1,<2.1

当前数据资产边界:

  1. data/frameworks/adk-2.0.0b1/metadata.json 是 b1 framework metadata 最低入口;
  2. data/frameworks/adk-2.0.0a3/metadata.json 作为历史数据资产保留;
  3. data/insights/adk-2.0.0a3/ 中的历史样本用于 smoke / fixtures / 回归验证;
  4. 不将 a3 样本伪改为 b1 样本;
  5. b1 insight 样本体系不属于本版本完成边界。

9. 项目结构

当前公开发布面聚焦最小可用产品路径:

cognition-engine/
├── cognition_engine/
├── data/
│   ├── frameworks/
│   └── insights/
├── docs/
│   └── releases/
├── examples/
├── outputs/
├── tests/
├── pyproject.toml
├── README.md
├── QUICKSTART.md
├── CHANGELOG.md
└── LICENSE

内部任务链、治理过程文件、私仓取证记录、本地缓存、构建产物和未清洗运行产物不属于公开发布面。


10. 输出契约

关于公开输出结构,可查看:

outputs/OUTPUT_CONTRACTS.md

当前核心结果契约包括:

ce-brief-result/v1
ce-decision-pack-result/v1
ce-insight-to-decision-workflow-result/v1

11. 测试

安装测试依赖:

python -m pip install -e ".[test]"

运行当前公开单元测试:

python -m pytest tests/unit -q

12. 版本历史

当前 README 描述 main 分支最新公开口径。

历史版本说明通过以下位置保留:

  1. CHANGELOG.md
  2. docs/releases/
  3. GitHub Releases;
  4. 对应 Git tag。

当前版本发布说明见:

docs/releases/v0.3.2-release-note.md

License

Apache License 2.0

Project details


Download files

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

Source Distribution

cognition_engine-0.3.2.tar.gz (38.4 kB view details)

Uploaded Source

Built Distribution

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

cognition_engine-0.3.2-py3-none-any.whl (45.9 kB view details)

Uploaded Python 3

File details

Details for the file cognition_engine-0.3.2.tar.gz.

File metadata

  • Download URL: cognition_engine-0.3.2.tar.gz
  • Upload date:
  • Size: 38.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for cognition_engine-0.3.2.tar.gz
Algorithm Hash digest
SHA256 b708d970f1d8f224459dae3e900ff36b0f4cb342947ea4b361e673209500f62e
MD5 7949842fa04706c8a2901e2a3ae775d7
BLAKE2b-256 8299b4ac17078baefd715865ff192a98139224a5379a61e6d55804667e77de6b

See more details on using hashes here.

File details

Details for the file cognition_engine-0.3.2-py3-none-any.whl.

File metadata

File hashes

Hashes for cognition_engine-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d19894f815acb15ad19ee17de1a11c2c15bba5e7c464ac6994c8b5b53946cb4d
MD5 66d14d4b4e666a31e9e8f93cfe2dc4c5
BLAKE2b-256 b92bdd7140f6b0cc15b4231283a1afb8df3b03ec6b0cb5dbe0c988066e098e09

See more details on using hashes here.

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