Skip to content

Commit 9693129

Browse files
authored
docs: resume readme (#1143)
1 parent 7c4b00d commit 9693129

File tree

4 files changed

+39
-8
lines changed

4 files changed

+39
-8
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,9 @@
6060

6161
## 🌟 最近更新
6262

63-
- 2025.06.27:支持**小折线图局部放大**;支持配置**单个折线图平滑**;大幅改进了图像图表放大后的交互效果;
63+
- 2025.07.06:🚄支持**resume断点续训**;新插件**文件记录器**;集成[ray](https://github.com/ray-project/ray)框架,[文档](https://docs.swanlab.cn/guide_cloud/integration/integration-ray.html);集成[ROLL](https://github.com/volcengine/ROLL)框架,感谢[@PanAndy](https://github.com/PanAndy)[文档](https://docs.swanlab.cn/guide_cloud/integration/integration-roll.html)
64+
65+
- 2025.06.27:📊支持**小折线图局部放大**;支持配置**单个折线图平滑**;大幅改进了图像图表放大后的交互效果;
6466

6567
- 2025.06.20:🤗集成[accelerate](https://github.com/huggingface/accelerate)框架,[PR](https://github.com/huggingface/accelerate/pull/3605)[文档](https://docs.swanlab.cn/guide_cloud/integration/integration-huggingface-accelerate.html),增强分布式训练中的实验记录体验;
6668

@@ -76,10 +78,10 @@
7678

7779
- 2025.05.14:支持**实验Tag**;支持折线图**Log Scale**;支持**分组拖拽**;大幅度优化了大量指标上传的体验;增加`swanlab.OpenApi`开放接口;
7880

79-
- 2025.05.09:支持**折线图创建**;配置图表功能增加**数据源选择**功能,支持单张图表显示不同的指标;支持生成**训练项目GitHub徽章**
80-
8181
<details><summary>完整更新日志</summary>
8282

83+
- 2025.05.09:支持**折线图创建**;配置图表功能增加**数据源选择**功能,支持单张图表显示不同的指标;支持生成**训练项目GitHub徽章**
84+
8385
- 2025.04.23:支持折线图**编辑**,支持自由配置图表的X、Y轴数据范围和标题样式;图表搜索支持**正则表达式**;支持**昆仑芯XPU**的硬件检测与监控;
8486

8587
- 2025.04.11:支持折线图**局部区域选取**;支持全局选择仪表盘折线图的step范围;支持一键隐藏全部图表;
@@ -160,6 +162,8 @@ https://github.com/user-attachments/assets/7965fec4-c8b0-4956-803d-dbf177b44f54
160162

161163
- **后台自动记录**:日志logging、硬件环境、Git 仓库、Python 环境、Python 库列表、项目运行目录
162164

165+
- **断点续训记录**:支持在训练完成/中断后,补充新的指标数据到同个实验中
166+
163167
**2. ⚡️ 全面的框架集成**: PyTorch、🤗HuggingFace Transformers、PyTorch Lightning、🦙LLaMA Factory、MMDetection、Ultralytics、PaddleDetetion、LightGBM、XGBoost、Keras、Tensorboard、Weights&Biases、OpenAI、Swift、XTuner、Stable Baseline3、Hydra 在内的 **30+** 框架
164168

165169
![](readme_files/integrations.png)
@@ -180,6 +184,7 @@ https://github.com/user-attachments/assets/7965fec4-c8b0-4956-803d-dbf177b44f54
180184

181185
**9. 🔌 插件拓展**: 支持通过插件拓展SwanLab的使用场景,比如 [飞书通知](https://docs.swanlab.cn/plugin/notification-lark.html)[Slack通知](https://docs.swanlab.cn/plugin/notification-slack.html)[CSV记录器](https://docs.swanlab.cn/plugin/writer-csv.html)
182186

187+
183188
> \[!IMPORTANT]
184189
>
185190
> **收藏项目**,你将从 GitHub 上无延迟地接收所有发布通知~ ⭐️
@@ -366,12 +371,14 @@ swanlab login --host http://localhost:8000
366371
- [HuggingFace trl](https://docs.swanlab.cn/guide_cloud/integration/integration-huggingface-trl.html)
367372
- [EasyR1](https://docs.swanlab.cn/guide_cloud/integration/integration-easyr1.html)
368373
- [AReaL](https://docs.swanlab.cn/guide_cloud/integration/integration-areal.html)
374+
- [ROLL](https://docs.swanlab.cn/guide_cloud/integration/integration-roll.html)
369375

370376
**其他框架:**
371377
- [Tensorboard](https://docs.swanlab.cn/guide_cloud/integration/integration-tensorboard.html)
372378
- [Weights&Biases](https://docs.swanlab.cn/guide_cloud/integration/integration-wandb.html)
373379
- [MLFlow](https://docs.swanlab.cn/guide_cloud/integration/integration-mlflow.html)
374380
- [HuggingFace Accelerate](https://docs.swanlab.cn/guide_cloud/integration/integration-huggingface-accelerate.html)
381+
- [Ray](https://docs.swanlab.cn/guide_cloud/integration/integration-ray.html)
375382
- [Unsloth](https://docs.swanlab.cn/guide_cloud/integration/integration-unsloth.html)
376383
- [Hydra](https://docs.swanlab.cn/guide_cloud/integration/integration-hydra.html)
377384
- [Omegaconf](https://docs.swanlab.cn/guide_cloud/integration/integration-omegaconf.html)
@@ -394,6 +401,7 @@ swanlab login --host http://localhost:8000
394401
- [Discord通知](https://docs.swanlab.cn/plugin/notification-discord.html)
395402
- [Slack通知](https://docs.swanlab.cn/plugin/notification-slack.html)
396403
- [CSV记录器](https://docs.swanlab.cn/plugin/writer-csv.html)
404+
- [文件记录器](https://docs.swanlab.cn/plugin/writer-filelogdir.html)
397405

398406
开放接口:
399407
- [OpenAPI](https://docs.swanlab.cn/api/py-openapi.html)

README_EN.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ Supports both cloud/offline usage, integrates with 30+ mainstream frameworks, an
5454

5555
## 🌟 Recent Updates
5656

57+
- 2025.07.06: 🚄 Added support for resume training; new plugin [File Logger](https://docs.swanlab.cn/en/plugin/writer-filelogdir.html); integrated [ray](https://github.com/ray-project/ray) framework, [documentation](https://docs.swanlab.cn/guide_cloud/integration/integration-ray.html); integrated [ROLL](https://github.com/volcengine/ROLL) framework, thanks to [@PanAndy](https://github.com/PanAndy), [documentation](https://docs.swanlab.cn/guide_cloud/integration/integration-roll.html)
58+
5759
- 2025.06.27: Added support for **small line chart zooming**; added support for configuring **single line chart smoothing**; significantly improved the interaction effect of image charts after zooming.
5860

5961
- 2025.06.20: 🤗 Integrated the [accelerate](https://github.com/huggingface/accelerate) framework, [PR](https://github.com/huggingface/accelerate/pull/3605), [documentation](https://docs.swanlab.cn/guide_cloud/integration/integration-huggingface-accelerate.html), enhancing the experience of recording and analyzing experiments in distributed training.
@@ -70,10 +72,11 @@ Supports both cloud/offline usage, integrates with 30+ mainstream frameworks, an
7072

7173
- 2025.05.14: Added support for **experiment tags**; added support for **Log Scale** for line charts; added support for **group dragging**; significantly optimized the experience of uploading a large number of metrics.
7274

73-
- 2025.05.09: Added support for line chart creation; enhanced the chart configuration feature with data source selection, enabling a single chart to display different metrics; introduced the ability to generate GitHub badges for training projects.
7475

7576
<details><summary>Full Changelog</summary>
7677

78+
- 2025.05.09: Added support for line chart creation; enhanced the chart configuration feature with data source selection, enabling a single chart to display different metrics; introduced the ability to generate GitHub badges for training projects.
79+
7780
- 2025.04.23: Added support for editing line charts, allowing free configuration of X and Y axis data ranges and title styles; chart search now supports regular expressions; added hardware detection and monitoring for Kunlun Core XPU.
7881

7982
- 2025.04.11: Added support for **local selection** for line charts; supports the step range of the current graph.
@@ -148,8 +151,11 @@ Here is a list of its core features:
148151
![swanlab-table](readme_files/swanlab-table.png)
149152

150153
- Supports **hyperparameter recording** and table display.
154+
151155
- **Supported metadata types**: Scalar metrics, images, audio, text, 3D point clouds, biological chemical molecules, Echarts custom chart...
152156

157+
- **Resume Training Record**: Supports recording new metrics data to the same experiment after training is completed/interrupted.
158+
153159
![swanlab-table](readme_files/molecule.gif)
154160

155161
- **Supported chart types**: Line charts, media charts (images, audio, text, 3D point clouds, biological chemical molecules), Bar charts, Scatter charts, Box plots, Heat maps, Pie charts, Radar charts...
@@ -359,13 +365,15 @@ Below is a list of frameworks we have integrated. Feel free to submit an [Issue]
359365
- [veRL](https://docs.swanlab.cn/en/guide_cloud/integration/integration-verl.html)
360366
- [HuggingFace trl](https://docs.swanlab.cn/en/guide_cloud/integration/integration-huggingface-trl.html)
361367
- [EasyR1](https://docs.swanlab.cn/en/guide_cloud/integration/integration-easyr1.html)
362-
- [AReaL](https://docs.swanlab.cn/guide_cloud/integration/integration-areal.html)
368+
- [AReaL](https://docs.swanlab.cn/en/guide_cloud/integration/integration-areal.html)
369+
- [ROLL](https://docs.swanlab.cn/en/guide_cloud/integration/integration-roll.html)
363370

364371
**Other Frameworks:**
365372
- [Tensorboard](https://docs.swanlab.cn/en/guide_cloud/integration/integration-tensorboard.html)
366373
- [Weights&Biases](https://docs.swanlab.cn/en/guide_cloud/integration/integration-wandb.html)
367374
- [MLFlow](https://docs.swanlab.cn/en/guide_cloud/integration/integration-mlflow.html)
368375
- [HuggingFace Accelerate](https://docs.swanlab.cn/en/guide_cloud/integration/integration-huggingface-accelerate.html)
376+
- [Ray](https://docs.swanlab.cn/en/guide_cloud/integration/integration-ray.html)
369377
- [Unsloth](https://docs.swanlab.cn/en/guide_cloud/integration/integration-unsloth.html)
370378
- [Hydra](https://docs.swanlab.cn/en/guide_cloud/integration/integration-hydra.html)
371379
- [Omegaconf](https://docs.swanlab.cn/en/guide_cloud/integration/integration-omegaconf.html)
@@ -388,6 +396,7 @@ Enhance your experiment management experience by extending SwanLab's functionali
388396
- [Discord Notification](https://docs.swanlab.cn/en/plugin/notification-discord.html)
389397
- [Slack Notification](https://docs.swanlab.cn/en/plugin/notification-slack.html)
390398
- [CSV Logger](https://docs.swanlab.cn/en/plugin/writer-csv.html)
399+
- [File Logger](https://docs.swanlab.cn/en/plugin/writer-filelogdir.html)
391400

392401
<br>
393402

README_JP.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@
5454

5555
## 🌟 最近の更新
5656

57+
- 2025.07.06: 🚄 再開トレーニングをサポート;新プラグイン [ファイルロガー](https://docs.swanlab.cn/en/plugin/writer-filelogdir.html)[ray](https://github.com/ray-project/ray) フレームワークを統合、[ドキュメント](https://docs.swanlab.cn/guide_cloud/integration/integration-ray.html)[ROLL](https://github.com/volcengine/ROLL) フレームワークを統合、[@PanAndy](https://github.com/PanAndy) 氏に感謝、[ドキュメント](https://docs.swanlab.cn/guide_cloud/integration/integration-roll.html)
58+
5759
- 2025.06.27: **小折れ線グラフの局所拡大**をサポート;**単一折れ線グラフの平滑化**をサポート;大幅に画像グラフの拡大後のインタラクション効果を改善;
5860

5961
- 2025.06.20: 🤗 [accelerate](https://github.com/huggingface/accelerate) フレームワークを統合、[PR](https://github.com/huggingface/accelerate/pull/3605)[ドキュメント](https://docs.swanlab.cn/guide_cloud/integration/integration-huggingface-accelerate.html)、分散トレーニング中の実験記録と分析の体験を向上させます。
@@ -70,11 +72,11 @@
7072

7173
- 2025.05.14: **実験Tag**をサポート;折れ線グラフの**Log Scale**をサポート;**分组拖拽**をサポート;大量の指標をアップロードする際の体験を大幅に最適化
7274

73-
- 2025.05.09:折れ線グラフ作成をサポート;グラフ設定機能にデータソース選択機能を追加、1つのグラフで異なる指標を表示可能に;トレーニングプロジェクト用GitHubバッジ生成をサポート
74-
7575

7676
<details><summary>完全な更新履歴</summary>
7777

78+
- 2025.05.09:折れ線グラフ作成をサポート;グラフ設定機能にデータソース選択機能を追加、1つのグラフで異なる指標を表示可能に;トレーニングプロジェクト用GitHubバッジ生成をサポート
79+
7880
- 2025.04.23: 折れ線グラフの​​編集​​をサポート、グラフのX軸・Y軸のデータ範囲とタイトルスタイルを自由に設定可能に;グラフ検索で​​正規表現​​をサポート;​​Kunlun Core XPU​​のハードウェア検出とモニタリングをサポート。
7981

8082
- 2025.04.11: 折線グラフの**局所選択**をサポート;現在のグラフのstep範囲をサポート。
@@ -346,12 +348,15 @@ swanlab login --host http://localhost:8000
346348
- [veRL](https://docs.swanlab.cn/en/guide_cloud/integration/integration-verl.html)
347349
- [HuggingFace trl](https://docs.swanlab.cn/en/guide_cloud/integration/integration-huggingface-trl.html)
348350
- [EasyR1](https://docs.swanlab.cn/en/guide_cloud/integration/integration-easyr1.html)
351+
- [AReaL](https://docs.swanlab.cn/en/guide_cloud/integration/integration-areal.html)
352+
- [ROLL](https://docs.swanlab.cn/en/guide_cloud/integration/integration-roll.html)
349353

350354
**その他のフレームワーク:**
351355
- [Tensorboard](https://docs.swanlab.cn/en/guide_cloud/integration/integration-tensorboard.html)
352356
- [Weights&Biases](https://docs.swanlab.cn/en/guide_cloud/integration/integration-wandb.html)
353357
- [MLFlow](https://docs.swanlab.cn/en/guide_cloud/integration/integration-mlflow.html)
354358
- [HuggingFace Accelerate](https://docs.swanlab.cn/en/guide_cloud/integration/integration-huggingface-accelerate.html)
359+
- [Ray](https://docs.swanlab.cn/en/guide_cloud/integration/integration-ray.html)
355360
- [Unsloth](https://docs.swanlab.cn/en/guide_cloud/integration/integration-unsloth.html)
356361
- [Hydra](https://docs.swanlab.cn/en/guide_cloud/integration/integration-hydra.html)
357362
- [Omegaconf](https://docs.swanlab.cn/en/guide_cloud/integration/integration-omegaconf.html)
@@ -374,6 +379,7 @@ swanlab login --host http://localhost:8000
374379
- [Discord通知](https://docs.swanlab.cn/en/plugin/notification-discord.html)
375380
- [Slack通知](https://docs.swanlab.cn/en/plugin/notification-slack.html)
376381
- [CSVロガー](https://docs.swanlab.cn/en/plugin/writer-csv.html)
382+
- [ファイルロガー](https://docs.swanlab.cn/en/plugin/writer-filelogdir.html)
377383

378384
<br>
379385

README_RU.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@
5353

5454
## 🌟 Последние обновления
5555

56+
- 2025.07.06: 🚄 Поддержка возобновления обучения; новый плагин [Файловый логгер](https://docs.swanlab.cn/en/plugin/writer-filelogdir.html); интеграция [ray](https://github.com/ray-project/ray) фреймворка, [документация](https://docs.swanlab.cn/guide_cloud/integration/integration-ray.html); интеграция [ROLL](https://github.com/volcengine/ROLL) фреймворка, спасибо [@PanAndy](https://github.com/PanAndy), [документация](https://docs.swanlab.cn/guide_cloud/integration/integration-roll.html)
57+
5658
- 2025.06.27: Добавлена поддержка **малого масштабирования** для линейных графиков; добавлена поддержка **плавного масштабирования** для отдельных линейных графиков; значительно улучшена интерактивность изображений после масштабирования.
5759

5860
- 2025.06.20: 🤗 Интегрирована платформа [accelerate](https://github.com/huggingface/accelerate), [PR](https://github.com/huggingface/accelerate/pull/3605), [документация](https://docs.swanlab.cn/guide_cloud/integration/integration-huggingface-accelerate.html), улучшает опыт записи и анализа экспериментов в распределенном обучении.
@@ -71,10 +73,11 @@
7173

7274
- 2025.05.09: Добавлена поддержка создания линейных графиков; в функции настройки графиков добавлена возможность выбора источника данных, что позволяет отображать разные показатели на одном графике; реализована возможность создания GitHub-значков для учебных проектов.
7375

74-
- 2025.04.23: Добавлена поддержка ​​редактирования​​ линейных графиков, возможность свободной настройки диапазонов данных осей X и Y и стилей заголовков; поиск в графиках теперь поддерживает ​​регулярные выражения​​; добавлено обнаружение и мониторинг оборудования ​​Kunlun Core XPU​​.
7576

7677
<details><summary>Полный список изменений</summary>
7778

79+
- 2025.04.23: Добавлена поддержка ​​редактирования​​ линейных графиков, возможность свободной настройки диапазонов данных осей X и Y и стилей заголовков; поиск в графиках теперь поддерживает ​​регулярные выражения​​; добавлено обнаружение и мониторинг оборудования ​​Kunlun Core XPU​​.
80+
7881
- 2025.04.14: Добавлена поддержка **Kunlunxin XPU** для мониторинга оборудования, [#940](https://github.com/SwanHubX/SwanLab/pull/940).
7982

8083
- 2025.04.11: Добавлена поддержка **локального выбора** для графика; поддерживается глобальный шаг для текущего графика.
@@ -347,12 +350,16 @@ swanlab login --host http://localhost:8000
347350
- [veRL](https://docs.swanlab.cn/en/guide_cloud/integration/integration-verl.html)
348351
- [HuggingFace trl](https://docs.swanlab.cn/en/guide_cloud/integration/integration-huggingface-trl.html)
349352
- [EasyR1](https://docs.swanlab.cn/en/guide_cloud/integration/integration-easyr1.html)
353+
- [AReaL](https://docs.swanlab.cn/en/guide_cloud/integration/integration-areal.html)
354+
- [ROLL](https://docs.swanlab.cn/guide_cloud/integration/integration-roll.html)
355+
350356

351357
**Другие фреймворки:**
352358
- [Tensorboard](https://docs.swanlab.cn/en/guide_cloud/integration/integration-tensorboard.html)
353359
- [Weights&Biases](https://docs.swanlab.cn/en/guide_cloud/integration/integration-wandb.html)
354360
- [MLFlow](https://docs.swanlab.cn/en/guide_cloud/integration/integration-mlflow.html)
355361
- [HuggingFace Accelerate](https://docs.swanlab.cn/en/guide_cloud/integration/integration-huggingface-accelerate.html)
362+
- [Ray](https://docs.swanlab.cn/en/guide_cloud/integration/integration-ray.html)
356363
- [Unsloth](https://docs.swanlab.cn/en/guide_cloud/integration/integration-unsloth.html)
357364
- [Hydra](https://docs.swanlab.cn/en/guide_cloud/integration/integration-hydra.html)
358365
- [Omegaconf](https://docs.swanlab.cn/en/guide_cloud/integration/integration-omegaconf.html)
@@ -399,6 +406,7 @@ swanlab login --host http://localhost:8000
399406
- [Уведомления в Discord](https://docs.swanlab.cn/en/plugin/notification-discord.html)
400407
- [Уведомления в Slack](https://docs.swanlab.cn/en/plugin/notification-slack.html)
401408
- [CSV-логгер](https://docs.swanlab.cn/en/plugin/writer-csv.html)
409+
- [Файловый логгер](https://docs.swanlab.cn/en/plugin/writer-filelogdir.html)
402410

403411
<br>
404412

0 commit comments

Comments
 (0)