feat: add new docs home and searchbar

Author: kkkky123

docs_roll/docs/English/UserGuide/trackers_and_metrics.md

@@ -155,7 +155,7 @@ The ROLL framework automatically records the following types of metrics:
 - time/adv: Duration of the advantages calculation phase.
 
 ### Execution Phases
-In the following time and memory metrics, {metric_infix} will be replaced with specific execution phase identifiers, such as:
+In the following time and memory metrics, `{metric_infix}` will be replaced with specific execution phase identifiers, such as:
 - train_step: Training phase
 - generate: Text generation/inference phase
 - model_update: Model parameter update/synchronization phase
@@ -165,37 +165,37 @@ In the following time and memory metrics, {metric_infix} will be replaced with s
 - compute_rewards: Reward computation phase
 
 #### Time Metrics
-- time/{metric_infix}/total: Total execution time for the entire operation (from entering state_offload_manager to exiting).
-- time/{metric_infix}/execute: Execution time for actual business logic (i.e., the yield part, such as model training, generation, etc.).
-- time/{metric_infix}/onload: Time to load model state (strategy.load_states()) to GPU or memory.
-- time/{metric_infix}/offload: Time to offload model state (strategy.offload_states()) from GPU or memory.
+- time/`{metric_infix}`/total: Total execution time for the entire operation (from entering state_offload_manager to exiting).
+- time/`{metric_infix}`/execute: Execution time for actual business logic (i.e., the yield part, such as model training, generation, etc.).
+- time/`{metric_infix}`/onload: Time to load model state (strategy.load_states()) to GPU or memory.
+- time/`{metric_infix}`/offload: Time to offload model state (strategy.offload_states()) from GPU or memory.
 
 #### GPU Memory Metrics
 - Memory snapshot at the beginning (after model state offloading)
-    - memory/{metric_infix}/**start/offload**/allocated/{device_id}: Currently allocated GPU memory on a specific device_id.
-    - memory/{metric_infix}/**start/offload**/reserved/{device_id}: Currently reserved GPU memory on a specific device_id.
-    - memory/{metric_infix}/**start/offload**/max_allocated/{device_id}: Peak allocated GPU memory from the start of this operation to the current moment on a specific device_id.
-    - memory/{metric_infix}/**start/offload**/max_reserved/{device_id}: Peak reserved GPU memory from the start of this operation to the current moment on a specific device_id.
+    - memory/`{metric_infix}`/**start/offload**/allocated/`{device_id}`: Currently allocated GPU memory on a specific device_id.
+    - memory/`{metric_infix}`/**start/offload**/reserved/`{device_id}`: Currently reserved GPU memory on a specific device_id.
+    - memory/`{metric_infix}`/**start/offload**/max_allocated/`{device_id}`: Peak allocated GPU memory from the start of this operation to the current moment on a specific device_id.
+    - memory/`{metric_infix}`/**start/offload**/max_reserved/`{device_id}`: Peak reserved GPU memory from the start of this operation to the current moment on a specific device_id.
 - Memory snapshot after loading model state (before executing business logic)
-    - memory/{metric_infix}/**start/onload**/allocated/{device_id}: Currently allocated GPU memory on a specific device_id.
-    - memory/{metric_infix}/**start/onload**/reserved/{device_id}: Currently reserved GPU memory on a specific device_id.
-    - memory/{metric_infix}/**start/onload**/max_allocated/{device_id}: Peak allocated GPU memory from the start of this operation to the current moment on a specific device_id.
-    - memory/{metric_infix}/**start/onload**/max_reserved/{device_id}: Peak reserved GPU memory from the start of this operation to the current moment on a specific device_id.
+    - memory/`{metric_infix}`/**start/onload**/allocated/`{device_id}`: Currently allocated GPU memory on a specific device_id.
+    - memory/`{metric_infix}`/**start/onload**/reserved/`{device_id}`: Currently reserved GPU memory on a specific device_id.
+    - memory/`{metric_infix}`/**start/onload**/max_allocated/`{device_id}`: Peak allocated GPU memory from the start of this operation to the current moment on a specific device_id.
+    - memory/`{metric_infix}`/**start/onload**/max_reserved/`{device_id}`: Peak reserved GPU memory from the start of this operation to the current moment on a specific device_id.
 - Memory snapshot after executing business logic (before offloading model state)
-    - memory/{metric_infix}/**end/onload**/allocated/{device_id}: Currently allocated GPU memory on a specific device_id.
-    - memory/{metric_infix}/**end/onload**/reserved/{device_id}: Currently reserved GPU memory on a specific device_id.
-    - memory/{metric_infix}/**end/onload**/max_allocated/{device_id}: Peak allocated GPU memory from the start of this operation to the current moment on a specific device_id.
-    - memory/{metric_infix}/**end/onload**/max_reserved/{device_id}: Peak reserved GPU memory from the start of this operation to the current moment on a specific device_id.
-    - memory/{metric_infix}/**end/onload**/max_allocated_frac/{device_id}: Fraction of peak allocated GPU memory relative to total GPU memory on a specific device_id.
-    - memory/{metric_infix}/**end/onload**/max_reserved_frac/{device_id}: Fraction of peak reserved GPU memory relative to total GPU memory on a specific device_id.
+    - memory/`{metric_infix}`/**end/onload**/allocated/`{device_id}`: Currently allocated GPU memory on a specific device_id.
+    - memory/`{metric_infix}`/**end/onload**/reserved/`{device_id}`: Currently reserved GPU memory on a specific device_id.
+    - memory/`{metric_infix}`/**end/onload**/max_allocated/`{device_id}`: Peak allocated GPU memory from the start of this operation to the current moment on a specific device_id.
+    - memory/`{metric_infix}`/**end/onload**/max_reserved/`{device_id}`: Peak reserved GPU memory from the start of this operation to the current moment on a specific device_id.
+    - memory/`{metric_infix}`/**end/onload**/max_allocated_frac/`{device_id}`: Fraction of peak allocated GPU memory relative to total GPU memory on a specific device_id.
+    - memory/`{metric_infix}`/**end/onload**/max_reserved_frac/`{device_id}`: Fraction of peak reserved GPU memory relative to total GPU memory on a specific device_id.
 - Memory snapshot after offloading model state (at operation end)
-    - memory/{metric_infix}/**end/offload**/allocated/{device_id}: Currently allocated GPU memory on a specific device_id.
-    - memory/{metric_infix}/**end/offload**/reserved/{device_id}: Currently reserved GPU memory on a specific device_id.
-    - memory/{metric_infix}/**end/offload**/max_allocated/{device_id}: Peak allocated GPU memory from the start of this operation to the current moment on a specific device_id.
-    - memory/{metric_infix}/**end/offload**/max_reserved/{device_id}: Peak reserved GPU memory from the start of this operation to the current moment on a specific device_id.
+    - memory/`{metric_infix}`/**end/offload**/allocated/`{device_id}`: Currently allocated GPU memory on a specific device_id.
+    - memory/`{metric_infix}`/**end/offload**/reserved/`{device_id}`: Currently reserved GPU memory on a specific device_id.
+    - memory/`{metric_infix}`/**end/offload**/max_allocated/`{device_id}`: Peak allocated GPU memory from the start of this operation to the current moment on a specific device_id.
+    - memory/`{metric_infix}`/**end/offload**/max_reserved/`{device_id}`: Peak reserved GPU memory from the start of this operation to the current moment on a specific device_id.
 
 #### CPU Memory Metrics
-- memory/cpu/{metric_infix}/start/rss: Actual physical memory (Resident Set Size) occupied by the process at the start of the operation.
-- memory/cpu/{metric_infix}/start/vms: Virtual memory (Virtual Memory Size) occupied by the process at the start of the operation.
-- memory/cpu/{metric_infix}/end/rss: Actual physical memory occupied by the process at the end of the operation.
-- memory/cpu/{metric_infix}/end/vms: Virtual memory occupied by the process at the end of the operation.
+- memory/cpu/`{metric_infix}`/start/rss: Actual physical memory (Resident Set Size) occupied by the process at the start of the operation.
+- memory/cpu/`{metric_infix}`/start/vms: Virtual memory (Virtual Memory Size) occupied by the process at the start of the operation.
+- memory/cpu/`{metric_infix}`/end/rss: Actual physical memory occupied by the process at the end of the operation.
+- memory/cpu/`{metric_infix}`/end/vms: Virtual memory occupied by the process at the end of the operation.

docs_roll/docs/简体中文/使用指南/trackers_and_metrics.md

@@ -156,7 +156,7 @@ ROLL 框架会自动记录以下类型的指标：
 - time/adv: 优势（Advantages）计算阶段的耗时。
 
 ### 各执行阶段
-在下面的时间指标和内存指标中，{metric_infix} 会被替换为具体的执行阶段标识，例如：
+在下面的时间指标和内存指标中，`{metric_infix}` 会被替换为具体的执行阶段标识，例如：
 - train_step: 训练阶段
 - generate: 文本生成/推理阶段
 - model_update: 模型参数更新/同步阶段
@@ -166,37 +166,37 @@ ROLL 框架会自动记录以下类型的指标：
 - compute_rewards: 计算奖励阶段
 
 #### 时间指标
-- time/{metric_infix}/total: 整个操作的总执行时间（从进入 state_offload_manger 到退出）。
-- time/{metric_infix}/execute: 实际业务逻辑（即 yield 部分，如模型训练、生成等）的执行时间。
-- time/{metric_infix}/onload: 模型状态加载（strategy.load_states()）到 GPU 或内存中的时间。
-- time/{metric_infix}/offload: 模型状态从 GPU 或内存中卸载（strategy.offload_states()）的时间。
+- time/`{metric_infix}`/total: 整个操作的总执行时间（从进入 state_offload_manger 到退出）。
+- time/`{metric_infix}`/execute: 实际业务逻辑（即 yield 部分，如模型训练、生成等）的执行时间。
+- time/`{metric_infix}`/onload: 模型状态加载（strategy.load_states()）到 GPU 或内存中的时间。
+- time/`{metric_infix}`/offload: 模型状态从 GPU 或内存中卸载（strategy.offload_states()）的时间。
 
 #### GPU内存指标
 - 开始时（模型状态卸载后）的内存快照
-    - memory/{metric_infix}/**start/offload**/allocated/{device_id}: 某个 device_id 上当前已分配的 GPU 内存量。
-    - memory/{metric_infix}/**start/offload**/reserved/{device_id}: 某个 device_id 上当前已预留的 GPU 内存量。
-    - memory/{metric_infix}/**start/offload**/max_allocated/{device_id}: 某个 device_id 上从本次操作开始到当前时刻，已分配的 GPU 内存的峰值。
-    - memory/{metric_infix}/**start/offload**/max_reserved/{device_id}: 某个 device_id 上从本次操作开始到当前时刻，已预留的 GPU 内存的峰值。
+    - memory/`{metric_infix}`/**start/offload**/allocated/`{device_id}`: 某个 device_id 上当前已分配的 GPU 内存量。
+    - memory/`{metric_infix}`/**start/offload**/reserved/`{device_id}`: 某个 device_id 上当前已预留的 GPU 内存量。
+    - memory/`{metric_infix}`/**start/offload**/max_allocated/`{device_id}`: 某个 device_id 上从本次操作开始到当前时刻，已分配的 GPU 内存的峰值。
+    - memory/`{metric_infix}`/**start/offload**/max_reserved/`{device_id}`: 某个 device_id 上从本次操作开始到当前时刻，已预留的 GPU 内存的峰值。
 - 加载模型状态后（业务逻辑执行前）的内存快照
-    - memory/{metric_infix}/**start/onload**/allocated/{device_id}: 某个 device_id 上当前已分配的 GPU 内存量。
-    - memory/{metric_infix}/**start/onload**/reserved/{device_id}: 某个 device_id 上当前已预留的 GPU 内存量。
-    - memory/{metric_infix}/**start/onload**/max_allocated/{device_id}: 某个 device_id 上从本次操作开始到当前时刻，已分配的 GPU 内存的峰值。
-    - memory/{metric_infix}/**start/onload**/max_reserved/{device_id}: 某个 device_id 上从本次操作开始到当前时刻，已预留的 GPU 内存的峰值。
+    - memory/`{metric_infix}`/**start/onload**/allocated/`{device_id}`: 某个 device_id 上当前已分配的 GPU 内存量。
+    - memory/`{metric_infix}`/**start/onload**/reserved/`{device_id}`: 某个 device_id 上当前已预留的 GPU 内存量。
+    - memory/`{metric_infix}`/**start/onload**/max_allocated/`{device_id}`: 某个 device_id 上从本次操作开始到当前时刻，已分配的 GPU 内存的峰值。
+    - memory/`{metric_infix}`/**start/onload**/max_reserved/`{device_id}`: 某个 device_id 上从本次操作开始到当前时刻，已预留的 GPU 内存的峰值。
 - 业务逻辑执行后（模型状态卸载前）的内存快照
-    - memory/{metric_infix}/**end/onload**/allocated/{device_id}: 某个 device_id 上当前已分配的 GPU 内存量。
-    - memory/{metric_infix}/**end/onload**/reserved/{device_id}: 某个 device_id 上当前已预留的 GPU 内存量。
-    - memory/{metric_infix}/**end/onload**/max_allocated/{device_id}: 某个 device_id 上从本次操作开始到当前时刻，已分配的 GPU 内存的峰值。
-    - memory/{metric_infix}/**end/onload**/max_reserved/{device_id}: 某个 device_id 上从本次操作开始到当前时刻，已预留的 GPU 内存的峰值。
-    - memory/{metric_infix}/**end/onload**/max_allocated_frac/{device_id}: 某个 device_id 上已分配 GPU 内存峰值占总 GPU 内存的比例 (分数)。
-    - memory/{metric_infix}/**end/onload**/max_reserved_frac/{device_id}: 某个 device_id 上已预留 GPU 内存峰值占总 GPU 内存的比例 (分数)。
+    - memory/`{metric_infix}`/**end/onload**/allocated/`{device_id}`: 某个 device_id 上当前已分配的 GPU 内存量。
+    - memory/`{metric_infix}`/**end/onload**/reserved/`{device_id}`: 某个 device_id 上当前已预留的 GPU 内存量。
+    - memory/`{metric_infix}`/**end/onload**/max_allocated/`{device_id}`: 某个 device_id 上从本次操作开始到当前时刻，已分配的 GPU 内存的峰值。
+    - memory/`{metric_infix}`/**end/onload**/max_reserved/`{device_id}`: 某个 device_id 上从本次操作开始到当前时刻，已预留的 GPU 内存的峰值。
+    - memory/`{metric_infix}`/**end/onload**/max_allocated_frac/`{device_id}`: 某个 device_id 上已分配 GPU 内存峰值占总 GPU 内存的比例 (分数)。
+    - memory/`{metric_infix}`/**end/onload**/max_reserved_frac/`{device_id}`: 某个 device_id 上已预留 GPU 内存峰值占总 GPU 内存的比例 (分数)。
 - 卸载模型状态后（操作结束）的内存快照
-    - memory/{metric_infix}/**end/offload**/allocated/{device_id}: 某个 device_id 上当前已分配的 GPU 内存量。
-    - memory/{metric_infix}/**end/offload**/reserved/{device_id}: 某个 device_id 上当前已预留的 GPU 内存量。
-    - memory/{metric_infix}/**end/offload**/max_allocated/{device_id}: 某个 device_id 上从本次操作开始到当前时刻，已分配的 GPU 内存的峰值。
-    - memory/{metric_infix}/**end/offload**/max_reserved/{device_id}: 某个 device_id 上从本次操作开始到当前时刻，已预留的 GPU 内存的峰值。
+    - memory/`{metric_infix}`/**end/offload**/allocated/`{device_id}`: 某个 device_id 上当前已分配的 GPU 内存量。
+    - memory/`{metric_infix}`/**end/offload**/reserved/`{device_id}`: 某个 device_id 上当前已预留的 GPU 内存量。
+    - memory/`{metric_infix}`/**end/offload**/max_allocated/`{device_id}`: 某个 device_id 上从本次操作开始到当前时刻，已分配的 GPU 内存的峰值。
+    - memory/`{metric_infix}`/**end/offload**/max_reserved/`{device_id}`: 某个 device_id 上从本次操作开始到当前时刻，已预留的 GPU 内存的峰值。
 
 #### CPU内存指标
-- memory/cpu/{metric_infix}/start/rss: 进程在操作开始时占用的实际物理内存 (Resident Set Size)。
-- memory/cpu/{metric_infix}/start/vms: 进程在操作开始时占用的虚拟内存 (Virtual Memory Size)。
-- memory/cpu/{metric_infix}/end/rss: 进程在操作结束时占用的实际物理内存。
-- memory/cpu/{metric_infix}/end/vms: 进程在操作结束时占用的虚拟内存。
+- memory/cpu/`{metric_infix}`/start/rss: 进程在操作开始时占用的实际物理内存 (Resident Set Size)。
+- memory/cpu/`{metric_infix}`/start/vms: 进程在操作开始时占用的虚拟内存 (Virtual Memory Size)。
+- memory/cpu/`{metric_infix}`/end/rss: 进程在操作结束时占用的实际物理内存。
+- memory/cpu/`{metric_infix}`/end/vms: 进程在操作结束时占用的虚拟内存。

docs_roll/docusaurus.config.js

@@ -1,8 +1,9 @@
 // @ts-check
 // Note: type annotations allow type checking and IDEs autocompletion
 
-const lightCodeTheme = require('prism-react-renderer/themes/github');
-const darkCodeTheme = require('prism-react-renderer/themes/dracula');
+const { themes } = require('prism-react-renderer');
+const lightTheme = themes.github;
+const darkTheme = themes.dracula;
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {
@@ -59,6 +60,21 @@ const config = {
     ],
   ],
 
+  themes: [
+    [
+      // @ts-ignore
+      require.resolve("@easyops-cn/docusaurus-search-local"),
+      /** @type {import("@easyops-cn/docusaurus-search-local").PluginOptions} */
+      // @ts-ignore
+      ({
+        hashed: true,
+        indexBlog: false,
+        // For Docs usingChinese, it is recomended to set:
+        language: ["en"],
+      }),
+    ],
+  ],
+
   themeConfig:
     /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
     ({
@@ -71,17 +87,24 @@ const config = {
           src: 'img/logo.png',
         },
         items: [
+          { to: '/ROLL', label: 'Home', position: 'right' },
+          { to: '/ROLL/#core', label: 'Core Algorithms', position: 'right' },
+          { to: '/ROLL/#research', label: 'Research Community', position: 'right' },
           {
             type: 'docSidebar',
             sidebarId: 'tutorialSidebar',
-            position: 'left',
-            label: '文档',
+            position: 'right',
+            label: 'API Docs',
           },
           {
             href: 'https://github.com/alibaba/ROLL',
             label: 'GitHub',
             position: 'right',
           },
+          {
+            type: 'search',
+            position: 'right', // 确保位置在右侧
+          },
         ],
       },
       footer: {
@@ -122,8 +145,11 @@ const config = {
         copyright: `Copyright © ${new Date().getFullYear()} Alibaba.`,
       },
       prism: {
-        theme: lightCodeTheme,
-        darkTheme: darkCodeTheme,
+        theme: lightTheme,
+        darkTheme: darkTheme,
+      },
+      colorMode: {
+        defaultMode: 'dark',
       },
     }),
 };

docs_roll/package.json

@@ -15,18 +15,19 @@
   },
   "dependencies": {
     "@ant-design/icons": "^6.0.0",
-    "@docusaurus/core": "2.4.1",
-    "@docusaurus/preset-classic": "2.4.1",
-    "@mdx-js/react": "^1.6.22",
+    "@docusaurus/core": "^3.0.0",
+    "@docusaurus/preset-classic": "^3.0.0",
+    "@easyops-cn/docusaurus-search-local": "^0.52.1",
+    "@mdx-js/react": "^3.0.0",
     "antd": "^5.26.7",
     "axios": "^1.11.0",
     "clsx": "^1.2.1",
-    "prism-react-renderer": "^1.3.5",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2"
+    "prism-react-renderer": "^2.1.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.4.1",
+    "@docusaurus/module-type-aliases": "3.0.0",
     "@jridgewell/gen-mapping": "0.3.8",
     "@jridgewell/source-map": "0.3.6",
     "@jridgewell/sourcemap-codec": "1.5.0",
@@ -45,6 +46,6 @@
     ]
   },
   "engines": {
-    "node": ">=16.14"
+    "node": ">=18.0"
   }
-}
+}