RoundPipe/mkdocs.yml at main · thustorage/RoundPipe · GitHub

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
site_name: RoundPipe
site_url: https://thustorage.github.io/RoundPipe/
repo_url: https://github.com/thustorage/RoundPipe/
nav:
  - Home: index.md
  - User Guide:
      - RoundPipe Overview: UserGuide/overview.md
      - Quick Start:
        - Installation: UserGuide/QuickStart/installation.md
        - "Fine-Tune Qwen3-1.7B": UserGuide/QuickStart/qwen3_nekoqa.md
        - "Train a Custom Model": UserGuide/QuickStart/resnet_cifar100.md
      - Basic Usage:
        - Wrap Model: UserGuide/BasicUsage/wrap_model.md
        - Optimizer: UserGuide/BasicUsage/optimizer.md
        - Training Loop: UserGuide/BasicUsage/training_loop.md
        - Multi-GPU Training: UserGuide/BasicUsage/multi_gpu.md
        - GradScaler: UserGuide/BasicUsage/grad_scaler.md
      - Advanced Usage:
        - RoundPipeRunConfig: UserGuide/AdvancedUsage/run_config.md
        - Resolve OOM: UserGuide/AdvancedUsage/resolve_oom.md
        - Custom Microbatch Split: UserGuide/AdvancedUsage/custom_microbatch_split.md
        - Custom Data Type: UserGuide/AdvancedUsage/custom_data_type.md
        - Custom Execute Plan: UserGuide/AdvancedUsage/execute_plan.md
        - Recompute Data: UserGuide/AdvancedUsage/recompute_data.md
        - Logging: UserGuide/AdvancedUsage/logging.md
  - API:
      - Model: API/model.md
      - RunConfig: API/run_config.md
      - Context: API/context.md
      - Optimizer: API/optimizer.md
      - GradScaler: API/grad_scaler.md
      - Logging: API/logging.md
  - Model Zoo:
      - Model Presets: ModelZoo/model_presets.md
  - Developer:
      - Contact: Developer/contact.md
      - Contribute Model Zoo: Developer/contribute_model.md
      - Contribute CPU Optimizer: Developer/contribute_optimizer.md
      - Contribute RoundPipe: Developer/contribute_roundpipe.md
      - Internal APIs: Developer/internal_apis.md
theme:
  name: material
  logo: assets/logo.svg
  favicon: assets/logo.svg
  language: en
  features:
    - navigation.tabs
    - navigation.expand
  palette:
    - media: '(prefers-color-scheme: light)'
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
markdown_extensions:
  - extra
  - admonition
  - pymdownx.details
  - pymdownx.superfences
plugins:
  - search
  - autorefs:
      resolve_closest: true
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: false
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            docstring_section_style: list
  - i18n:
      languages:
        - locale: en
          name: English
          default: true
        - locale: zh
          name: 中文
          nav_translations:
            Home: 主页
            User Guide: 用户指南
            RoundPipe Overview: RoundPipe概览
            Quick Start: 快速开始
            Installation: 安装
            "Train a Custom Model": 训练自定义模型
            "Fine-Tune Qwen3-1.7B": 微调 Qwen3-1.7B
            Basic Usage: 基本用法
            Wrap Model: 包装模型
            Optimizer: 创建优化器
            GradScaler: 混合精度训练
            Training Loop: 训练循环
            Multi-GPU Training: 多GPU训练
            Advanced Usage: 高级用法
            RoundPipeRunConfig: 运行配置调参
            Resolve OOM: 解决OOM
            Custom Microbatch Split: 自定义Microbatch切分
            Custom Data Type: 注册自定义数据类型
            Custom Execute Plan: 自定义执行计划
            Recompute Data: 重计算数据保存
            Logging: 日志与性能分析
            Model: 模型
            RunConfig: 运行设置
            Context: 运行时上下文
            Optimizer: 优化器
            GradScaler: 梯度缩放器
            Model Zoo: 模型库
            Model Presets: 预设模型
            Developer: 开发者
            Contact: 联系我们
            Contribute Model Zoo: 贡献模型库
            Contribute CPU Optimizer: 贡献CPU优化器
            Contribute RoundPipe: 贡献RoundPipe
            Internal APIs: 内部 API
hooks:
  - docs/draw/gen_figures.py