|
1 | | -# 📚 Documentation |
| 1 | +# 📚 文档导航(中文) |
2 | 2 |
|
3 | | -## Documentation Has Moved! 🚀 |
| 3 | +仓库文档已统一为中文语境,在线文档站点为主入口: |
4 | 4 |
|
5 | | -The technical documentation has been migrated to our new **GitHub Pages site** for a better reading experience with improved navigation, search, and interactive examples. |
| 5 | +- 文档首页:<https://tylerelyt.github.io/test_bed/> |
6 | 6 |
|
7 | | -### 🌐 View Documentation Online |
| 7 | +## 快速入口 |
8 | 8 |
|
9 | | -**Main Documentation Site**: [https://tylerelyt.github.io/test_bed/](https://tylerelyt.github.io/test_bed/) |
| 9 | +### 核心模块 |
10 | 10 |
|
11 | | -### 📖 Quick Links |
| 11 | +- 🔍 **[搜索推荐系统](https://tylerelyt.github.io/test_bed/docs/search-recommendation/)**:倒排索引、CTR 模型、A/B 测试 |
| 12 | +- 🤖 **[LLMOps 训练管道](https://tylerelyt.github.io/test_bed/docs/llmops)**:CPT/SFT/DPO 与在线反馈 |
| 13 | +- 💬 **[RAG 与上下文工程](https://tylerelyt.github.io/test_bed/docs/rag)**:检索增强与上下文编排 |
| 14 | +- 🖼️ **[多模态系统](https://tylerelyt.github.io/test_bed/docs/multimodal/)**:图像检索与图像生成 |
| 15 | +- 🖱️ **[GUI 自动化代理](https://tylerelyt.github.io/test_bed/docs/gui-agent)**:桌面自动化与 VLM 推理 |
12 | 16 |
|
13 | | -#### Core Systems |
14 | | -- 🔍 **[Search & Recommendation](https://tylerelyt.github.io/test_bed/docs/search-recommendation/)** - Inverted index, CTR models, A/B testing |
15 | | -- 🤖 **[LLMOps Training Pipeline](https://tylerelyt.github.io/test_bed/docs/llmops)** - CPT/SFT/DPO workflows with online feedback |
16 | | -- 💬 **[RAG & Context Engineering](https://tylerelyt.github.io/test_bed/docs/rag)** - Hybrid retrieval with LLM integration |
17 | | -- 🖼️ **[Multimodal AI](https://tylerelyt.github.io/test_bed/docs/multimodal/)** - CLIP-based image search and generation |
18 | | -- 🖱️ **[GUI Automation Agent](https://tylerelyt.github.io/test_bed/docs/gui-agent)** - OSWorld-based desktop automation |
| 17 | +### 基础设施 |
19 | 18 |
|
20 | | -#### Infrastructure |
21 | | -- 🛠️ **[Model Serving](https://tylerelyt.github.io/test_bed/docs/model-serving)** - RESTful APIs and deployment patterns |
| 19 | +- 🛠️ **[模型服务](https://tylerelyt.github.io/test_bed/docs/model-serving)**:REST API 与部署模式 |
22 | 20 |
|
23 | | ---- |
| 21 | +## 仓库内历史文档说明 |
24 | 22 |
|
25 | | -## 📝 Legacy Documentation Files |
| 23 | +`docs/` 目录中的部分 Markdown 文件为历史版本,保留用于兼容与参考;如需最新内容,请以在线文档站点为准。 |
26 | 24 |
|
27 | | -The Markdown files in this directory are **legacy versions** and are kept for reference only. For the most up-to-date documentation with better formatting and navigation, please visit the GitHub Pages site above. |
| 25 | +### 文件映射 |
28 | 26 |
|
29 | | -### File Migration Map |
30 | | - |
31 | | -| Legacy File | New Location | |
| 27 | +| 历史文件 | 在线位置 | |
32 | 28 | |------------|--------------| |
33 | | -| `SEARCH_GUIDE.md` | [Search & Recommendation](https://tylerelyt.github.io/test_bed/docs/search-recommendation/) | |
34 | | -| `LLMOPS_GUIDE.md` | [LLMOps Training Pipeline](https://tylerelyt.github.io/test_bed/docs/llmops) | |
35 | | -| `RAG_GUIDE.md` | [RAG & Context Engineering](https://tylerelyt.github.io/test_bed/docs/rag) | |
36 | | -| `CONTEXT_ENGINEERING_GUIDE.md` | [RAG & Context Engineering](https://tylerelyt.github.io/test_bed/docs/rag) | |
37 | | -| `IMAGE_SEARCH_GUIDE.md` | [Multimodal AI](https://tylerelyt.github.io/test_bed/docs/multimodal/) | |
38 | | -| `GUI_AGENT_GUIDE.md` | [GUI Automation Agent](https://tylerelyt.github.io/test_bed/docs/gui-agent) | |
39 | | -| `MODEL_SERVING_GUIDE.md` | [Model Serving](https://tylerelyt.github.io/test_bed/docs/model-serving) | |
40 | | - |
41 | | ---- |
42 | | - |
43 | | -## 🎯 Why the Move? |
44 | | - |
45 | | -The new documentation site offers: |
46 | | -- ✨ **Better User Experience**: Clean, professional design with the just-the-docs theme |
47 | | -- 🔍 **Full-Text Search**: Quickly find what you need |
48 | | -- 📱 **Responsive Design**: Works great on mobile and desktop |
49 | | -- 🎨 **Syntax Highlighting**: Better code examples with proper formatting |
50 | | -- 📊 **Interactive Diagrams**: Mermaid diagrams for architecture visualization |
51 | | -- 🧭 **Easy Navigation**: Sidebar navigation with hierarchical organization |
52 | | - |
53 | | ---- |
54 | | - |
55 | | -*For questions or feedback about the documentation, please open an issue on GitHub.* |
| 29 | +| `SEARCH_GUIDE.md` | [搜索推荐系统](https://tylerelyt.github.io/test_bed/docs/search-recommendation/) | |
| 30 | +| `LLMOPS_GUIDE.md` | [LLMOps 训练管道](https://tylerelyt.github.io/test_bed/docs/llmops) | |
| 31 | +| `RAG_GUIDE.md` | [RAG 与上下文工程](https://tylerelyt.github.io/test_bed/docs/rag) | |
| 32 | +| `CONTEXT_ENGINEERING_GUIDE.md` | [RAG 与上下文工程](https://tylerelyt.github.io/test_bed/docs/rag) | |
| 33 | +| `IMAGE_SEARCH_GUIDE.md` | [多模态系统](https://tylerelyt.github.io/test_bed/docs/multimodal/) | |
| 34 | +| `GUI_AGENT_GUIDE.md` | [GUI 自动化代理](https://tylerelyt.github.io/test_bed/docs/gui-agent) | |
| 35 | +| `MODEL_SERVING_GUIDE.md` | [模型服务](https://tylerelyt.github.io/test_bed/docs/model-serving) | |
56 | 36 |
|
0 commit comments