Skip to content

Commit 287344b

Browse files
committed
feat(docs): add zh docs
1 parent 6d9fa26 commit 287344b

4 files changed

Lines changed: 102 additions & 44 deletions

File tree

docs/.vitepress/config.mts

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { defineConfig } from 'vitepress'
2-
import { en } from './en'
2+
// import { en } from './en'
33
import { zh } from './zh'
44

55
// https://vitepress.dev/reference/site-config
@@ -16,7 +16,7 @@ export default defineConfig({
1616
],
1717

1818
lastUpdated: {
19-
text: "Updated at",
19+
text: "最后更新于",
2020
formatOptions: {
2121
dateStyle: 'full',
2222
timeStyle: 'medium',
@@ -44,23 +44,23 @@ export default defineConfig({
4444
}
4545
}
4646
},
47-
en: {
48-
translations: {
49-
button: {
50-
buttonText: 'Search',
51-
buttonAriaLabel: 'Search',
52-
},
53-
modal: {
54-
noResultsText: 'No results found',
55-
resetButtonTitle: 'Clear search criteria',
56-
footer: {
57-
selectText: 'to select',
58-
navigateText: 'to navigate',
59-
closeText: 'to close',
60-
}
61-
}
62-
}
63-
}
47+
// en: {
48+
// translations: {
49+
// button: {
50+
// buttonText: 'Search',
51+
// buttonAriaLabel: 'Search',
52+
// },
53+
// modal: {
54+
// noResultsText: 'No results found',
55+
// resetButtonTitle: 'Clear search criteria',
56+
// footer: {
57+
// selectText: 'to select',
58+
// navigateText: 'to navigate',
59+
// closeText: 'to close',
60+
// }
61+
// }
62+
// }
63+
// }
6464
}
6565
}
6666
},
@@ -74,7 +74,7 @@ export default defineConfig({
7474

7575
// 国际化配置
7676
locales: {
77-
root: { label: 'English', ...en },
78-
zh: { label: '简体中文', ...zh },
77+
root: { label: '简体中文', ...zh },
78+
// en: { label: 'English', ...en },
7979
},
8080
})

docs/.vitepress/en.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ import { defineConfig } from 'vitepress'
44
export const en = defineConfig({
55
lang: 'en-US',
66
title: "SpectrumLab",
7-
description: "An Excellent Toolkit for Spectral Benchmark.",
8-
7+
description: "A pioneering unified platform designed to systematize and accelerate deep learning research in spectroscopy",
98
themeConfig: {
109
nav: [
1110
{ text: 'Home', link: '/en/' },
@@ -33,7 +32,7 @@ export const en = defineConfig({
3332
},
3433
footer: {
3534
message: 'Released under the MIT License',
36-
copyright: 'Copyright © 2024 SpectrumLab'
35+
copyright: 'Copyright © 2025 SpectrumLab'
3736
},
3837

3938
// 英文版本的组件文本

docs/.vitepress/zh.ts

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,35 +4,37 @@ import { defineConfig } from 'vitepress'
44
export const zh = defineConfig({
55
lang: 'zh-CN',
66
title: "SpectrumLab",
7-
description: "化学谱学大模型基准测试工具",
7+
description: "一个为系统评估和加速谱学深度学习的平台",
88
themeConfig: {
99
nav: [
10-
{ text: '首页', link: '/zh/' },
11-
{ text: '教程', link: '/zh/tutorial' },
12-
{ text: 'API', link: '/zh/api' },
13-
{ text: '基准测试', link: '/zh/benchmark' },
10+
{ text: '首页', link: '/' },
11+
{ text: '教程', link: '/tutorial' },
12+
{ text: 'API', link: '/api' },
13+
{ text: '基准测试', link: '/benchmark' },
14+
{ text: '排行榜', link: '/leaderboard' },
1415
],
1516
sidebar: {
16-
'/zh/': [
17+
'/': [
1718
{
1819
text: '开始使用',
1920
items: [
20-
{ text: '介绍', link: '/zh/' },
21-
{ text: '教程', link: '/zh/tutorial' },
21+
{ text: '介绍', link: '/' },
22+
{ text: '教程', link: '/tutorial' },
2223
]
2324
},
2425
{
2526
text: '文档',
2627
items: [
27-
{ text: 'API 参考', link: '/zh/api' },
28-
{ text: '基准测试', link: '/zh/benchmark' },
28+
{ text: 'API 参考', link: '/api' },
29+
{ text: '基准测试', link: '/benchmark' },
30+
{ text: '排行榜', link: '/leaderboard' },
2931
]
3032
}
3133
]
3234
},
3335
footer: {
3436
message: '基于 MIT 许可发布',
35-
copyright: 'Copyright © 2024 SpectrumLab'
37+
copyright: 'Copyright © 2025 SpectrumLab'
3638
},
3739
docFooter: {
3840
prev: '上一页',

docs/index.md

Lines changed: 66 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,80 @@ layout: home
33

44
hero:
55
name: "SpectrumLab"
6-
text: "化学谱学大模型基准测试工具"
7-
tagline: "专业的光谱学深度学习评估工具包"
6+
text: ""
7+
tagline: "一个为系统评估和加速谱学深度学习的平台"
88
actions:
99
- theme: brand
1010
text: 快速开始
11-
link: /zh/tutorial
11+
link: /tutorial
1212
- theme: alt
1313
text: 查看源码
1414
link: https://github.com/little1d/SpectrumLab
1515

1616
features:
17-
- title: 多模态评估
17+
- title: 🔬 多模态评估
1818
details: 支持图像+文本的多模态光谱数据评估,兼容多种深度学习模型
19-
- title: 模型集成
20-
details: 集成 GPT-4o、DeepSeek、InternVL 等先进模型的 API 接口
21-
- title: 基准测试
19+
- title: 🤖 模型集成
20+
details: 集成 GPT-4o、Claude、DeepSeek、Qwen-VL 等先进模型的 API 接口
21+
- title: 📊 基准测试
2222
details: 提供标准化的评估流程和指标,支持多种光谱学任务类型
23-
- title: 命令行工具
23+
- title: 🏆 排行榜
24+
details: 实时更新的模型性能排行榜,支持多维度对比分析
25+
- title: 🚀 命令行工具
2426
details: 简洁的命令行界面,支持批量评估和结果管理
25-
---
27+
- title: 🔧 易于扩展
28+
details: 模块化设计,支持自定义评估器和模型的快速集成
29+
---
30+
31+
## 什么是 SpectrumLab?
32+
33+
SpectrumLab 是一个专为光谱学深度学习设计的综合性多模态基准测试平台。它旨在推动光谱学领域的人工智能研究和应用,为研究人员和开发者提供标准化的评估工具和流程。
34+
35+
### 🎯 核心特性
36+
37+
- **四层评估体系**:Signal、Perception、Semantic、Generation 四个层级
38+
- **丰富任务类型**:分类、预测、识别、生成等多种任务
39+
- **多模态支持**:图像、文本等多种输入格式
40+
- **标准化评估**:统一的评估指标和流程
41+
42+
### 🏗️ 支持的模型
43+
44+
- **OpenAI**: GPT-4V, GPT-4o, GPT-4.1
45+
- **Anthropic**: Claude 3.5 Sonnet, Claude 3.5 Haiku
46+
- **DeepSeek**: DeepSeek-VL
47+
- **Qwen**: Qwen-VL, Qwen2.5-VL
48+
- **InternLM**: InternVL
49+
- **字节跳动**: Doubao-VL
50+
- **Meta**: Llama 3.2 Vision
51+
- **xAI**: Grok-Vision
52+
53+
### 📈 评估任务
54+
55+
- **Signal Level**: 光谱类型分类、特征提取、质量评估
56+
- **Perception Level**: 官能团识别、峰位归属、性质预测
57+
- **Semantic Level**: 分子结构理解、化学反应分析
58+
- **Generation Level**: 光谱解释生成、实验建议
59+
60+
## 快速开始
61+
62+
```bash
63+
# 克隆项目
64+
git clone https://github.com/your-org/SpectrumLab.git
65+
cd SpectrumLab
66+
67+
# 安装环境
68+
conda create -n spectrumlab python=3.10
69+
conda activate spectrumlab
70+
pip install uv
71+
uv pip install -e .
72+
73+
# 运行评估
74+
python run_evaluation.py
75+
```
76+
77+
## 开始使用
78+
79+
- [教程](/tutorial) - 学习如何使用 SpectrumLab
80+
- [API 参考](/api) - 详细的 API 文档
81+
- [基准测试](/benchmark) - 查看基准结果和指标
82+
- [排行榜](/leaderboard) - 模型性能排行榜

0 commit comments

Comments
 (0)