入门指南¶
欢迎使用 SAGE！本指南将帮助您快速上手 SAGE 框架。
🚀 快速开始¶
如果您是第一次使用 SAGE，我们建议按以下顺序学习：
1. 安装 SAGE¶
首先需要安装 SAGE 及其依赖。我们提供了多种安装方式：
- 从源码安装（推荐开发者）- 使用
quickstart.sh一键安装，自动配置环境和依赖 - 通过 PyPI 安装 - 适合快速部署和生产环境使用
👉 查看详细安装指南
2. 快速入门教程¶
安装完成后，通过快速入门教程学习 SAGE 的基本概念和使用方法：
- 创建第一个 SAGE Pipeline
- 理解数据流处理模型
- 运行 Hello World 示例
👉 开始快速入门教程
📚 深入学习¶
完成快速开始后，您可以继续学习：
基础教程¶
掌握 SAGE 的核心概念和基本用法：
核心概念¶
深入理解 SAGE 的架构和设计：
高级教程¶
探索 SAGE 的高级特性：
🎯 学习路径建议¶
1. ✅ [安装 SAGE](installation.md)
2. ✅ [快速入门](quickstart.md)
3. ✅ [流式处理 101](../tutorials/basic/streaming-101.md)
4. ✅ [基础算子](../tutorials/basic/operators/hello_filter_world.md)
1. ✅ [架构总览](../concepts/architecture/overview.md)
2. ✅ [包结构](../concepts/architecture/package-structure.md)
3. ✅ [自定义算子](../tutorials/advanced/custom-operators.md)
4. ✅ [性能优化](../tutorials/advanced/performance-tuning.md)
1. ✅ [分布式部署](../tutorials/advanced/distributed-pipeline.md)
2. ✅ [容错机制](../tutorials/advanced/fault-tolerance.md)
3. ✅ [设计决策文档](../concepts/architecture/design-decisions/sage-libs-restructuring.md)
4. ✅ [贡献指南](../developers/commands.md)
💡 常见使用场景¶
构建 RAG 应用¶
from sage.kernel.api import LocalEnvironment
from sage.libs.io import FileSource, TerminalSink
from sage.middleware.operators.rag import ChromaRetriever, OpenAIGenerator
env = LocalEnvironment("rag_app")
(env.from_source(FileSource, {"file_path": "questions.txt"})
.map(ChromaRetriever, {"collection": "docs", "top_k": 5})
.map(OpenAIGenerator, {"model": "gpt-3.5-turbo"})
.sink(TerminalSink))
env.submit()
流式数据处理¶
from sage.kernel.api import LocalEnvironment
from sage.common.core.functions import MapFunction
class ProcessData(MapFunction):
def map(self, record):
# 自定义处理逻辑
return record
env = LocalEnvironment("stream_app")
env.from_stream(source).map(ProcessData).sink(sink)
env.submit()
构建 AI Agent¶
from sage.libs.agentic.agents.bots import AnswerBot, QuestionBot
# 创建对话 Agent
answer_bot = AnswerBot(model="gpt-4")
question_bot = QuestionBot()
# 构建对话流
env.from_bot(question_bot).connect(answer_bot).sink(output)
🆘 需要帮助？¶
- 📖 查看用户指南了解详细功能
- 💬 访问 GitHub Discussions 提问
- 🐛 在 GitHub Issues 报告问题
- 👥 加入社区与其他开发者交流
📝 下一步¶
准备好了吗？让我们开始吧！