Feat/update readme (#74)

* optimize readme code * Add badge and contributor * Modify Feishu link. * Add Learn more * feat: Optimize Markdown format * feat: compatible with dark mode. * format link * Update extensions.json --------- Co-authored-by: cunyue-4060 <cunykang@gmail.com>
SwanHubX · Dec 23, 2023 · 6c99ea2 · 6c99ea2
1 parent 40aa8e2
commit 6c99ea2
Show file tree

Hide file tree

Showing 8 changed files with 74 additions and 64 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -16,7 +16,4 @@ dist/
 
 package.json
 
-*.md
-
-
 swanlab/
diff --git a/.prettierignore b/.prettierignore
@@ -59,7 +59,8 @@ components/style/color/*.less
 
 .huskyrc
 
-README.md
+!README.md
+!README_zh-hans.md
 
 doc/**
 
@@ -68,3 +69,4 @@ doc/**
 .github/**
 
 swanlab/
+
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -9,6 +9,7 @@
     "bradlc.vscode-tailwindcss",
     "dbaeumer.vscode-eslint",
     "esbenp.prettier-vscode",
+    "lokalise.i18n-ally",
     /**
      * python插件
      */
@@ -25,6 +26,9 @@
     // 代码协作，git协作
     "eamodio.gitlens",
     // 其他
-    "PKief.material-icon-theme"
+    "PKief.material-icon-theme",
+    "davidanson.vscode-markdownlint",
+    "usernamehw.errorlens",
+    "tamasfe.even-better-toml"
   ]
 }
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -90,5 +90,13 @@
     "**/__pycache__": true
   },
   /** python代码注释 */
-  "autoDocstring.docstringFormat": "numpy"
+  "autoDocstring.docstringFormat": "numpy",
+
+  /** markdown格式检查 */
+  "markdownlint.config": {
+    // 允许使用html标签
+    "MD033": false,
+    // 允许首行不是level1标题
+    "MD041": false
+  }
 }
diff --git a/README.md b/README.md
@@ -1,39 +1,34 @@
 <p align="center">
-  <img alt="SwanLab Library" src="readme_files/swanlab-logo.svg" width="352" height="59">
+  <img alt="SwanLab Library" src="readme_files/swanlab-logo-light.svg#gh-light-mode-only" width="352" height="59">
+  <img alt="SwanLab Library" src="readme_files/swanlab-logo-dark.svg#gh-dark-mode-only" width="352" height="59">
   <br/>
   <br/>
 </p>
+
 <p align="center">
-  <a href="https://pypi.python.org/pypi/swanlab"><img src="https://img.shields.io/pypi/v/swanlab" /></a>
-  <a href="https://pypi.org/project/swanlab/"><img alt="pypi Download" src="https://img.shields.io/pypi/dm/SwanLab"></a>
-  <a href="https://geektechstudio.feishu.cn/wiki/UInBw9eaziv17IkwfrOcHCZ1nbc"><img alt="Website" src="https://img.shields.io/badge/website-online-blue"></a>
-  <a href="https://github.com/SwanHubX/SwanLab/blob/main/LICENSE"><img src="https://img.shields.io/github/license/SwanHubX/SwanLab.svg"></a>
+  <a href="https://pypi.python.org/pypi/swanlab"><img src="https://img.shields.io/pypi/v/swanlab" alt="pypi" /></a>
+  <a href="https://pepy.tech/project/swanlab"><img alt="pypi Download" src="https://static.pepy.tech/badge/swanlab/month"></a>
+  <a href="https://geektechstudio.feishu.cn/wiki/space/7310593325374013444?ccm_open_type=lark_wiki_spaceLink&open_tab_from=wiki_home"><img alt="Website" src="https://img.shields.io/badge/website-online-blue"></a>
+  <a href="https://github.com/SwanHubX/SwanLab/blob/main/LICENSE"><img src="https://img.shields.io/github/license/SwanHubX/SwanLab.svg" alt="license"></a>
   <a href="https://github.com/SwanHubX/SwanLab/releases"><img alt="GitHub release" src="https://img.shields.io/github/release/SwanHubX/SwanLab.svg"></a>
 </p>
 
+<p align="center">
+    <b>English | <a href="https://github.com/SwanHubX/SwanLab/blob/main/README_zh-hans.md">简体中文</a></b>
+</p>
 
+SwanLab is the next-generation machine learning experiment management and visualization tool released by the
+[SwanHub](https://swanhub.co), designed to facilitate effective collaboration in machine learning training.
 
+SwanLab provides streamlined APIs that make it easy to track machine learning metrics and record configurations.
+Additionally, SwanLab provides a visual dashboard for the most intuitive way to **monitor**, **analyze**, and
+**compare** your training.
 
-
-<h4 align="center">
-  <p>
-    <b>English</b> |<a href="https://github.com/SwanHubX/SwanLab/blob/main/README_zh-hans.md">简体中文</a>
-  </p>
-</h4>
-
-
-
-
-SwanLab is the next-generation machine learning experiment management and visualization tool released by the [SwanHub](https://swanhub.co), designed to facilitate effective collaboration in machine learning training.
-
-SwanLab provides streamlined APIs that make it easy to track machine learning metrics and record configurations. Additionally, SwanLab provides a visual dashboard for the most intuitive way to **monitor**, **analyze**, and **compare** your training.
-
-For specific guidance on SwanLab's features, please refer to the [User Guide](https://geektechstudio.feishu.cn/wiki/UInBw9eaziv17IkwfrOcHCZ1nbc).
+For specific guidance on SwanLab's features, please refer to the
+[User Guide](https://geektechstudio.feishu.cn/wiki/space/7310593325374013444?ccm_open_type=lark_wiki_spaceLink&open_tab_from=wiki_home).
 
 Currently, SwanLab is undergoing rapid iterations and will continue to add new features.
 
-
-
 ## Installation
 
 This repository is tested on Python 3.8+.
@@ -44,11 +39,10 @@ SwanLab can be installed using pip as follows:
 pip install swanlab
 ```
 
-
-
 ## Quick tour
 
-Let's simulate a simple machine learning training process, using `swanlab.init` to initialize the experiment and record configuration information, and using `swanlab.log` to track key metrics (in this example, it's `loss` and `acc`):
+Let's simulate a simple machine learning training process, using `swanlab.init` to initialize the experiment and record
+configuration information, and using `swanlab.log` to track key metrics (in this example, it's `loss` and `acc`):
 
 ```python
 import swanlab
@@ -80,7 +74,8 @@ for epoch in range(2, epochs):
 
 During the program running, a `swanlog` folder will be generated in the directory to record your training data.
 
-If you want to visualize your experiment, open the terminal and enter the root directory (no need to enter the `swanlog` folder), and run the following command:
+If you want to visualize your experiment, open the terminal and enter the root directory (no need to enter the `swanlog`
+folder), and run the following command:
 
 ```bash
 swanlab watch
@@ -98,15 +93,16 @@ Access`http://127.0.0.1:5092` at this time to enter the experiment dashboard and
 
 <img alt="swanlab-dashboard-1" src="readme_files/swanlab-dashborad-1.png" width="800">
 
+## Learn more
 
+| Section                                                                                                                                    | Details                               |
+| ------------------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------ |
+| [Documentation](https://geektechstudio.feishu.cn/wiki/space/7310593325374013444?ccm_open_type=lark_wiki_spaceLink&open_tab_from=wiki_home) | Full APl documentation and tutorials. |
 
-# License
+## License
 
 [Apache 2.0 License](https://github.com/SwanHubX/SwanLab/blob/main/LICENSE)
 
+## Contributors
 
-
-# Contributors
-
-[![swanlab contributors](https://contrib.rocks/image?repo=SwanHubX/SwanLab&max=2000)](https://github.com/SwanHubX/SwanLab/graphs/contributors)
-
+[![swanlab contributors](https://contrib.rocks/image?repo=swanhubx/swanlab&max=2000)](https://github.com/SwanHubX/SwanLab/graphs/contributors)
diff --git a/README_zh-hans.md b/README_zh-hans.md
@@ -1,36 +1,33 @@
 <p align="center">
-  <img alt="SwanLab Library" src="readme_files/swanlab-logo.svg" width="352" height="59">
+  <img alt="SwanLab Library" src="readme_files/swanlab-logo-light.svg#gh-light-mode-only" width="352" height="59">
+  <img alt="SwanLab Library" src="readme_files/swanlab-logo-dark.svg#gh-dark-mode-only" width="352" height="59">
   <br/>
   <br/>
 </p>
+
 <p align="center">
-  <a href="https://pypi.python.org/pypi/swanlab"><img src="https://img.shields.io/pypi/v/swanlab" /></a>
-  <a href="https://pypi.org/project/swanlab/"><img alt="pypi Download" src="https://img.shields.io/pypi/dm/SwanLab"></a>
-  <a href="https://geektechstudio.feishu.cn/wiki/UInBw9eaziv17IkwfrOcHCZ1nbc"><img alt="Website" src="https://img.shields.io/badge/website-online-blue"></a>
-  <a href="https://github.com/SwanHubX/SwanLab/blob/main/LICENSE"><img src="https://img.shields.io/github/license/SwanHubX/SwanLab.svg"></a>
+  <a href="https://pypi.python.org/pypi/swanlab"><img src="https://img.shields.io/pypi/v/swanlab" alt= /></a>
+  <a href="https://pepy.tech/project/swanlab"><img alt="pypi Download" src="https://static.pepy.tech/badge/swanlab/month"></a>
+  <a href="https://geektechstudio.feishu.cn/wiki/space/7310593325374013444?ccm_open_type=lark_wiki_spaceLink&open_tab_from=wiki_home"><img alt="Website" src="https://img.shields.io/badge/website-online-blue"></a>
+  <a href="https://github.com/SwanHubX/SwanLab/blob/main/LICENSE"><img src="https://img.shields.io/github/license/SwanHubX/SwanLab.svg" alt="license"></a>
   <a href="https://github.com/SwanHubX/SwanLab/releases"><img alt="GitHub release" src="https://img.shields.io/github/release/SwanHubX/SwanLab.svg"></a>
 </p>
 
+<p align="center">
+  <b><a href="https://github.com/SwanHubX/SwanLab/blob/main/README.md">English</a> | 简体中文</b>
+</p>
 
-
-
-<h4 align="center">
-  <p>
-    <a href="https://github.com/SwanHubX/SwanLab/blob/main/README.md">English</a> |<b>简体中文</b>
-  </p>
-</h4>
-
-SwanLab 是[SwanHub](https://swanhub.co)开源社区发布的新一代机器学习实验管理与可视化工具，旨在让机器学习训练有效地协作起来。
+SwanLab 是[SwanHub](https://swanhub.co)开源社区发布的新一代机器学习实验管理与可视化工具，旨在让机器学习训练有效地协作起
+来。
 
 SwanLab 提供简洁的 API，轻松实现机器学习指标跟踪与配置记录。同时，SwanLab 还提供了一个可视化看板，以最直观的方式**监看、
 分析和对比**你的训练。
 
-有关 SwanLab 功能的具体指南，请参阅[用户指南](https://geektechstudio.feishu.cn/wiki/UInBw9eaziv17IkwfrOcHCZ1nbc)。
+有关 SwanLab 功能的具体指南，请参
+阅[用户指南](https://geektechstudio.feishu.cn/wiki/space/7310593325374013444?ccm_open_type=lark_wiki_spaceLink&open_tab_from=wiki_home)。
 
 目前，SwanLab 正在快速迭代，并将持续添加新功能。
 
-
-
 ## 安装
 
 此存储库在 Python 3.8+上进行了测试。
@@ -41,11 +38,10 @@ SwanLab 可以使用 pip 安装，如下所示:
 pip install swanlab
 ```
 
-
-
 ## 快速开始
 
-让我们模拟一个简单的机器学习训练过程，使用`swanlab.init`来初始化实验并记录配置信息，并使用`swanlab.log`跟踪关键指标（在这个例子中是 `loss` 和 `acc`）：
+让我们模拟一个简单的机器学习训练过程，使用`swanlab.init`来初始化实验并记录配置信息，并使用`swanlab.log`跟踪关键指标（在
+这个例子中是 `loss` 和 `acc`）：
 
 ```python
 import swanlab
@@ -95,15 +91,16 @@ swanlab watch
 
 <img alt="swanlab-dashboard-1" src="readme_files/swanlab-dashborad-1.png" width="800">
 
+## 了解更多
 
+| Section                                                                                                                           | Details                 |
+| --------------------------------------------------------------------------------------------------------------------------------- | :---------------------- |
+| [文档](https://geektechstudio.feishu.cn/wiki/space/7310593325374013444?ccm_open_type=lark_wiki_spaceLink&open_tab_from=wiki_home) | 完整的 APl 文档与教程。 |
 
-# License
+## License
 
 [Apache 2.0 License](https://github.com/SwanHubX/SwanLab/blob/main/LICENSE)
 
+## 贡献者
 
-
-# 贡献者
-
-[![swanlab contributors](https://contrib.rocks/image?repo=SwanHubX/SwanLab&max=2000)](https://github.com/SwanHubX/SwanLab/graphs/contributors)
-
+[![swanlab contributors](https://contrib.rocks/image?repo=swanhubx/swanlab&max=2000)](https://github.com/SwanHubX/SwanLab/graphs/contributors)
diff --git a/readme_files/swanlab-logo-dark.svg b/readme_files/swanlab-logo-dark.svg
diff --git a/readme_files/swanlab-logo.svg → readme_files/swanlab-logo-light.svg b/readme_files/swanlab-logo.svg → readme_files/swanlab-logo-light.svg