Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
153 lines (145 loc) · 4.21 KB
/
Copy pathmkdocs.yml
File metadata and controls
153 lines (145 loc) · 4.21 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
site_name: RecStore Documentation
site_description: RecStore is a high-performance, distributed parameter server system designed for machine learning applications.
site_author: RecStore Team
site_url: https://RecStore.github.io/RecStore/
repo_url: https://github.com/RecStore/RecStore
repo_name: RecStore
edit_uri: edit/main/docs/
theme:
name: material
language: zh
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: indigo
accent: indigo
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- navigation.tabs
- navigation.tabs.sticky
- navigation.indexes
- navigation.footer
- navigation.sections
- navigation.top
- navigation.tracking
- search.suggest
- search.highlight
- content.code.copy
- content.code.annotate
- content.action.edit
font: false
plugins:
- search:
lang:
- zh
- en
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.inlinehilite
- pymdownx.snippets:
base_path: [!relative $config_dir]
check_paths: true
- pymdownx.details
- pymdownx.tabbed:
alternate_style: true
- tables
- admonition
- attr_list
- md_in_html
- toc:
permalink: true
validation:
links:
anchors: warn
unrecognized_links: warn
not_in_nav: |
/agent/perf.md
/calc/interfaces.md
/dev/performance.md
/dev/zero_config_run.md
watch:
- README.md
nav:
- 首页: index.md
- 使用:
- usage/index.md
- 快速开始:
- 1. 从源码构建: quickstart.md
- 2. 快速运行: quickrun.md
- 运行与集成:
- DLRM / TorchRec 集成: usage/integration.md
- 分布式训练: dev/distributed.md
- 配置指南: usage/configuration.md
- 常见问题: faq.md
- 开发:
- dev/index.md
- 系统架构:
- 总体架构: architecture/overview.md
- 计算层: calc/index.md
- Embedding 与 Optimizer: calc/embedding_optimizer.md
- BagPipe 缓存: architecture/bagpipe_cache.md
- 参数服务器:
- 总览: parameter_server/index.md
- gRPC 实现: parameter_server/grpc.md
- bRPC 实现: parameter_server/brpc.md
- RDMA 实现: parameter_server/rdma.md
- 存储层:
- 总览: storage/index.md
- KVEngineComposite: storage/composite_kvengine.md
- 扩展指南:
- 添加算子: dev/feature/add_operator.md
- 扩展存储组件: dev/feature/storage.md
- 性能埋点: dev/instrumentation.md
- 测试与正确性:
- 概览: dev/testing.md
- 辅助工具: dev/tests/tools.md
- Python 客户端: dev/tests/client_test.md
- EBC 精度对齐: dev/tests/ebc_precision.md
- DistEmbedding: dev/tests/dist_emb_test.md
- 覆盖率: dev/tests/coverage.md
- 文档维护: dev/documentation.md
- 性能:
- performance/index.md
- 测试范围与指标: performance/methodology.md
- 运行基准:
- 端到端训练: performance/e2e.md
- 参数服务器与传输: performance/ps.md
- KVEngine 存储: dev/ycsb.md
- 性能分析:
- Profiling 与瓶颈分析: performance/profiling.md
- 监控与 Grafana: performance/monitoring.md
- 性能报告:
- 总览: performance/reports.md
- 混合存储(DRAM+SSD): performance/tiered-e2e.md
- API:
- api/index.md
- Python:
- RecStoreClient: api/python.md
- Embedding 模块: api/embedding.md
- PyTorch Operators: api/operators.md
- C++:
- CommonOp / KVClientOp: api/cpp.md
- PS Client / Server: parameter_server/base.md
- BaseKV / KVEngine: storage/basekv.md
- 通信协议: parameter_server/proto.md
- 配置字段: config.md
- 命令行与环境变量: api/cli.md
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/RecStore/RecStore