📦 AI-Compass 知识库部署与使用教程

AI-Compass 是一个全面、系统化组织的 AI 技术学习与实践生态系统。它并非传统的应用软件,而是一个结构化的知识库。它深度整合了从基础理论到前沿应用的完整知识体系,涵盖大语言模型、多模态AI、机器学习、深度学习、计算机视觉等核心技术领域,以及 RAG、Agent、GraphRAG 等前沿应用架构。项目本身作为一个开源知识库**,包含 Markdown 格式的文档、博客文章、代码示例和资源链接。因此,部署它的核心是将其克隆到本地,并让它能被你的 AI 编程助手(如 Claude Code、Codex、Cursor)作为本地知识库技能 (Skill)** 所使用。


🚀 快速部署 (推荐)

如果你是 AI 编程助手的用户(如 Claude Code、Codex、Cursor、Windsurf),这是最推荐的部署方式。AI 助手会帮你完成所有配置。

直接复制下面这段话发给你的 Coding Agent:

如果本机还没有 AI-Compass,请先 clone https://github.com/tingaicompass/AI-Compass.git,然后按照 https://raw.githubusercontent.com/tingaicompass/AI-Compass/main/Install.md 把它安装为我本机 Codex 和 Claude Code 都能使用的本地知识库 Skill。完成后告诉我安装路径、验证结果,以及是否需要重启客户端。

你的 AI 助手将自动完成以下操作:

  1. 克隆本仓库到本地。
  2. 执行根目录的安装脚本 (install.sh)。
  3. 验证并配置软链接,使其成为本地可用的知识库技能。
  4. 报告安装结果。

之后,你就可以直接在对话中询问 AI 技术、模型、项目以及每周更新的内容了。


💻 手动部署 (作为普通知识库)

如果你不使用 AI 编程助手,或希望手动将其集成到开发环境中,可以按以下步骤操作。

1. 克隆仓库

1
2
git clone https://github.com/tingaicompass/AI-Compass.git
cd AI-Compass

2. 探索知识库结构

AI-Compass 的核心价值在于其高度结构化的目录。你可以通过浏览以下关键目录和文件来快速定位信息:

  • weeklyHighlights/必看! 包含持续更新的 AI 前沿周报(目前已更新至第 55 期),是了解最新动态的最佳入口。
  • README.md:总入口,包含完整的模块介绍和导航。
  • INDEX.md / latest.md:快速索引和最近更新。
  • 0.AI导航工具集/ ~ 10.企业开源模块/:按主题分类的九大核心模块,每个模块下又有细分领域。例如:
    • 3.2 Agent/:汇集了 70+ 主流智能代理框架和生态。
    • 2.2 LLM推理框架+部署/:涵盖 vLLM、Ollama、LM Studio 等 21+ 推理引擎。
    • 4.AI 应用/:包含 AI 编程、音视频、图像创作等 50+ 应用实践。

3. 在 IDE 或编辑器中查看

你可以直接将这个文件夹作为项目在 VS Code 等编辑器中打开,利用文件树和搜索功能快速查找内容。对于代码模块(如 11.code/milvus/ 中的 RAG 示例),可以直接阅读源码。


🤖 作为 AI 助手的本地知识库 (Skill) 使用

这是 AI-Compass 最强大的用法。将其配置为 AI 编程助手的技能后,助手可以直接读取并理解整个知识库的内容。

通用 Skill 配置思路

  1. 在 AI 助手的配置目录中,找到添加自定义技能 (Custom Skill) 或知识库的选项。
  2. 将 AI-Compass 项目的根目录路径添加进去。
  3. 为这个技能命名,例如 ai-compass
  4. 助手的 AGENTS.mdSKILL.md 文件已提供了规则指引,它应能理解这是一个结构化的 AI 知识库。

使用示例 (通过自然语言提问)

配置完成后,你可以直接用自然语言向 AI 助手提问,例如:

  • “根据 AI-Compass 的最新周报,这周有哪些值得关注的 Agent 框架?”
  • “在 AI-Compass 中搜索关于 RAG 系统的工程实践资源。”
  • “帮我总结一下知识库中关于 LLM 推理框架有哪些,并推荐适合本地部署的。”
  • “参考 AI-Compass 的 Code 模块,解释一下这个 RAG 示例代码的工作流程。”

📚 知识库内容亮点速览

AI-Compass 的价值在于其庞大的结构化信息,以下是几个核心模块的概览:

模块 核心内容 适用人群
📅 每周精选 最新 AI 动态:每期精选约 8 条,覆盖模型发布、Agent 工具、多模态创作等。 所有希望紧跟 AI 前沿的开发者、产品经理、研究者。
✍️ 博客模块 Python 基础 + 107 道 LeetCode 高频题解;后续将更新 LLM 指南和面试题。 AI 初学者、求职者、刷题者。
💻 Code 模块 可运行的 AI 实战代码,如基于 Milvus 的完整 RAG 问答系统示例。 想动手实践 RAG、Agent 等技术的开发者。
🧠 基础知识 AI 导航工具、Prompt 工程、LLM 测评榜、主流语言与多模态模型合集。 需要模型选型、工具调研的决策者和研究者。
🔧 技术框架 Embedding 模型、训练/推理/评估框架、RLHF 技术栈全览。 从事模型训练、部署和优化的 AI 工程师。
🚀 应用实践 Agent、RAG、GraphRAG、MCP/A2A、DeepSearch、NLP2SQL 等前沿架构的框架与工具生态。 构建 AI 应用的架构师和全栈开发者。
💼 产品与工具 500+ AI 应用和产品,覆盖编程、设计、音视频、营销等方向。 寻找 AI 工具的产品经理、创意工作者和开发者。
🏢 企业开源 华为、腾讯、阿里、百度飞桨、Datawhale 等企业级开源资源和学习体系。 希望参考大厂实践的企业团队和技术负责人。

❓ 常见问题

  • Q: 我必须使用 Coding Agent 才能用这个知识库吗?
    • A: 不是。你可以直接将它克隆到本地,用任何文本编辑器或 IDE 浏览。将其配置为 AI 助手的技能是更高效的使用方式,但并非必须。
  • Q: 如何更新知识库?
    • A: 进入项目目录,执行 git pull 即可拉取最新的周报和内容更新。你的 Coding Agent 也可以通过它自己的 Skill 更新机制(如重新索引)来感知变化。
  • Q: 我可以为这个项目做贡献吗?
    • A: 当然。你可以通过 GitHub Issue 提交资源收录申请(请按模板格式),或通过 Pull Request 贡献新的内容、周报或代码示例。

更详细的资源收录流程、模块架构和贡献指南,请查阅项目根目录下的 CONTRIBUTING.mdAGENTS.md 文件。