docs: self hosted (#106)

* changelog

* Update .gitignore

* update

* update dashboard

* en

* Update .gitignore

* swanlab.login()

* cli-login

* register-callback

* docker image

* changelog

* banner

* plugin init

* sync_mlflow

* changelog sync mlflow

* upgrade quick-start

* emailcallback

* lark callback

* fix

* add lark show

* custom plugin

* dashboard

* fix link

* update sync_mlfllow

* exptrack add send notification

* better index

* style

* style

* update docker deploy

Author: Zeyi-Lin

.gitignore

@@ -2,4 +2,7 @@
 node_modules
 /.vitepress/dist
 /.vitepress/cache
-.idea
+.idea
+1.py
+2.py
+logs/

.vitepress/en.ts

@@ -3,6 +3,7 @@ import { defineConfig, type DefaultTheme} from 'vitepress'
 var base_path_guide_cloud = '/en/guide_cloud'
 var base_path_examples = '/en/examples'
 var base_path_api = '/en/api'
+var base_path_plugin = '/en/plugin'
 
 // https://vitepress.dev/reference/site-config
 export const en = defineConfig({
@@ -27,7 +28,7 @@ export const en = defineConfig({
     // 导航栏配置
     nav: [
       { 
-        text: 'User Guide',
+        text: 'Guide',
         link: base_path_guide_cloud + '/general/what-is-swanlab',
       },
       {
@@ -45,8 +46,8 @@ export const en = defineConfig({
         link: base_path_api + '/api-index',
         activeMatch: '/en/api/',
         },
-      { text: 'Contact Us', link: '/en/guide_cloud/community/online-support'},
-      { text: 'v0.4.11',  items: [
+      { text: 'Plugin', link: base_path_plugin + '/plugin-index'},
+      { text: 'v0.5.0',  items: [
         { text: 'changelog', link: base_path_guide_cloud + '/general/changelog' },
         { text: 'Feedback', link: 'https://geektechstudio.feishu.cn/share/base/form/shrcn8koDFRcH2mMcBYMh9tiKfI'},
         { text: 'Contribute Docs', link: 'https://github.com/SwanHubX/SwanLab-Docs' },
@@ -87,6 +88,7 @@ export const en = defineConfig({
       '/en/guide_cloud/integration/':{base: '/en/guide_cloud/integration/', items: sidebarIntegration(),},
       '/en/examples/':{base: '/en/examples/', items: sidebarExamples(),},
       '/en/api/':{base: '/en/api/', items: sidebarAPI(),},
+      '/en/plugin/':{base: '/en/plugin/', items: sidebarPlugin(),},
     },
 
     // 页脚配置
@@ -121,22 +123,29 @@ function sidebarGuideCloud(): DefaultTheme.SidebarItem[] {
     items: [
       { text: 'What is experiment tracking?', link: 'experiment_track/what-is-experiment-track' },
       { text: 'Create an experiment', link: 'experiment_track/create-experiment' },
-      { text: 'Create by config file', link: 'experiment_track/create-experiment-by-configfile' },
       { text: 'Set config', link: 'experiment_track/set-experiment-config' },
       { text: 'Log metric', link: 'experiment_track/log-experiment-metric' },
       { text: 'Log media metric', link: 'experiment_track/log-media' },
       { text: 'System Hardware Monitoring', link: 'experiment_track/system-monitor' },
       { text: 'View result', link: 'experiment_track/view-result' },
       { text: 'Finish experiment', link: 'experiment_track/finish-experiment' },
+      { text: 'Email Notifications', link: 'experiment_track/send-notification' },
       { text: 'Jupyter Notebook', link: 'experiment_track/jupyter-notebook' },
       { text: 'Limitations and Performance', link: 'experiment_track/limit-and-performance' },
       { text: 'Experiment metadata', link: 'experiment_track/experiment-metadata' },
       { text: 'FAQ', link: 'experiment_track/FAQ' },
     ]
   },
   {
-    text: '💻 Self-hosted',
+    text: '🚀 Self-hosted',
     // collapsed: false,
+    items: [
+      { text: 'Docker deployment', link: 'self_host/docker-deploy' },
+    ]
+  },
+  {
+    text: '💻 Offline board',
+    collapsed: true,
     items: [
       { text: 'Offline board', link: 'self_host/offline-board' },
       { text: 'Remote access tutorial', link: 'self_host/remote-view' },
@@ -304,6 +313,8 @@ function sidebarAPI(): DefaultTheme.SidebarItem[] {
       { text: 'converter', link: 'py-converter' },
       { text: 'sync_wandb', link: 'py-sync-wandb' },
       { text: 'sync_tensorboard', link: 'py-sync-tensorboard' },
+      { text: 'sync_mlflow', link: 'py-sync-mlflow' },
+      { text: 'register_callback', link: 'py-register-callback' },
       { text: 'Other', link: 'py-other' },
     ]
   },
@@ -316,3 +327,29 @@ function sidebarAPI(): DefaultTheme.SidebarItem[] {
   }
 ]
 }
+
+function sidebarPlugin(): DefaultTheme.SidebarItem[] {
+  return [
+  {
+    text: '🔧 Make your custom plugin',
+    link: 'custom-plugin',
+  },
+  {
+    text: '✈️ Notification',
+    // collapsed: false,
+    items: [
+      { text: 'Email', link: 'notification-email' },
+      { text: 'Lark', link: 'notification-lark' },
+      { text: 'Dingtalk', link: 'notification-dingtalk' },
+      { text: 'Wechat', link: 'notification-wxwork' },
+    ]
+  },
+  {
+    text: '📝 Writer',
+    // collapsed: false,
+    items: [
+      { text: 'CSV Table', link: 'writer-csv' },
+    ]
+  },
+]
+}

.vitepress/zh.ts

@@ -3,6 +3,7 @@ import { defineConfig, type DefaultTheme} from 'vitepress'
 var base_path_guide_cloud = '/guide_cloud'
 var base_path_examples = '/examples'
 var base_path_api = '/api'
+var base_path_plugin = '/plugin'
 
 // https://vitepress.dev/reference/site-config
 export const zh = defineConfig({
@@ -31,7 +32,7 @@ export const zh = defineConfig({
     // 导航栏配置
     nav: [
       { 
-        text: '用户指南',
+        text: '指南',
         link: base_path_guide_cloud + '/general/what-is-swanlab',
         // activeMatch: '/guide_cloud/',
       },
@@ -50,7 +51,12 @@ export const zh = defineConfig({
         link: base_path_api + '/api-index',
         activeMatch: '/api/',
         },
-      { text: 'v0.4.11',  items: [
+      {
+        text: '插件',
+        link: base_path_plugin + '/plugin-index',
+        activeMatch: '/plugin/',
+      },
+      { text: 'v0.5.0',  items: [
         { text: '更新日志', link: base_path_guide_cloud + '/general/changelog' },
         { text: '建议反馈', link: 'https://geektechstudio.feishu.cn/share/base/form/shrcn8koDFRcH2mMcBYMh9tiKfI'},
         { text: '贡献文档', link: 'https://github.com/SwanHubX/SwanLab-Docs' },
@@ -106,6 +112,7 @@ export const zh = defineConfig({
       '/examples/':{base: '/examples/', items: sidebarExamples(),},
       '/guide_cloud/integration/':{base: '/guide_cloud/integration/', items: sidebarIntegration(),},
       '/api/':{base: '/api/', items: sidebarAPI(),},
+      '/plugin/':{base: '/plugin/', items: sidebarPlugin(),},
     },
 
     // 页脚配置
@@ -137,36 +144,43 @@ function sidebarGuideCloud(): DefaultTheme.SidebarItem[] {
     items: [
       { text: '什么是实验跟踪', link: 'experiment_track/what-is-experiment-track' },
       { text: '创建一个实验', link: 'experiment_track/create-experiment' },
-      { text: '用配置文件创建实验', link: 'experiment_track/create-experiment-by-configfile' },
       { text: '设置实验配置', link: 'experiment_track/set-experiment-config' },
       { text: '记录指标', link: 'experiment_track/log-experiment-metric' },
       { text: '记录多媒体数据', link: 'experiment_track/log-media' },
       { text: '系统硬件监控（支持昇腾）', link: 'experiment_track/system-monitor' },
       { text: '查看实验结果', link: 'experiment_track/view-result' },
       { text: '结束一个实验', link: 'experiment_track/finish-experiment' },
+      { text: '邮件/第三方通知', link: 'experiment_track/send-notification' },
       { text: '用Jupyter Notebook跟踪实验', link: 'experiment_track/jupyter-notebook' },
       { text: '限制与性能', link: 'experiment_track/limit-and-performance' },
       { text: '实验元数据', link: 'experiment_track/experiment-metadata' },
       { text: 'FAQ', link: 'experiment_track/FAQ' },
     ]
   },
   {
-    text: '💻 自托管',
+    text: '🚀 自托管',
     // collapsed: false,
     items: [
-      { text: '离线看板', link: 'self_host/offline-board' },
-      { text: '远程访问教程', link: 'self_host/remote-view' },
+      { text: 'Docker部署', link: 'self_host/docker-deploy' },
     ]
   },
+  {
+      text: '💻 离线看板',
+      collapsed: true,
+      items: [
+        { text: '使用离线看板', link: 'self_host/offline-board' },
+        { text: '远程访问离线看板', link: 'self_host/remote-view' },
+      ]
+  },
   {
     text: '👥 社区',
     // collapsed: false,
     items: [
       { text: '在线支持', link: 'community/online-support'},
       { text: 'Github徽章', link: 'community/github-badge'},
-      { text: '论文引用', link: 'community/paper-cite'},
-      { text: '贡献代码', link: 'community/contributing-code'},
-      { text: '贡献官方文档', link: 'community/contributing-docs'},
+      // { text: '论文引用', link: 'community/paper-cite'},
+      // { text: '贡献代码', link: 'community/contributing-code'},
+      // { text: '贡献官方文档', link: 'community/contributing-docs'},
       { text: '关于我们', link: 'community/emotion-machine'},
     ]
   },]
@@ -319,8 +333,15 @@ function sidebarAPI(): DefaultTheme.SidebarItem[] {
       { text: 'login', link: 'py-login' },
       { text: 'integration', link: 'py-integration' },
       { text: 'converter', link: 'py-converter' },
-      { text: 'sync_wandb', link: 'py-sync-wandb' },
-      { text: 'sync_tensorboard', link: 'py-sync-tensorboard' },
+      {
+        text: '同步其他工具',
+        items: [
+          { text: 'sync_wandb', link: 'py-sync-wandb' },
+          { text: 'sync_tensorboard', link: 'py-sync-tensorboard' },
+          { text: 'sync_mlflow', link: 'py-sync-mlflow' },
+        ]
+      },
+      { text: 'register_callback', link: 'py-register-callback' },
       { text: '其他', link: 'py-other' },
     ]
   },
@@ -332,4 +353,30 @@ function sidebarAPI(): DefaultTheme.SidebarItem[] {
     ]
   }
 ]
+}
+
+function sidebarPlugin(): DefaultTheme.SidebarItem[] {
+  return [
+  {
+    text: '🔧 制作自定义插件',
+    link: 'custom-plugin',
+  },
+  {
+    text: '✈️ 通知类',
+    // collapsed: false,
+    items: [
+      { text: '邮件', link: 'notification-email' },
+      { text: '飞书', link: 'notification-lark' },
+      { text: '钉钉', link: 'notification-dingtalk' },
+      { text: '企业微信', link: 'notification-wxwork' },
+    ]
+  },
+  {
+    text: '📝 记录类',
+    // collapsed: false,
+    items: [
+      { text: 'CSV表格', link: 'writer-csv' },
+    ]
+  },
+]
 }

en/api/cli-swanlab-login.md

@@ -1,24 +1,35 @@
 # swanlab login
 
-``` bash
+```bash
 swanlab login [OPTIONS]
 ```
 
 | Option | Description |
 | --- | --- |
-| `--relogin` | Re-login. |
+| `-r`, `--relogin` | Re-login. |
+| `-h`, `--host` | Specify the host where the SwanLab service is located. For example, `http://localhost:8000`. |
+| `-k`, `--api-key` | Specify the API Key. This allows automatic login if you prefer not to enter the API key via the command line. |
+| `-w`, `--web-host` | Specify the web host where the SwanLab frontend is located. |
 
 ## Introduction
 
 Log in to your SwanLab account to synchronize experiments to the cloud.
 
-After running the following command, if it's your first login, you will be prompted to fill in your [API_KEY](https://swanlab.cn/settings):
+After executing the following command, if it's your first time logging in, you will be prompted to enter your [API_KEY](https://swanlab.cn/settings):
 
 ```bash
 swanlab login
 ```
 
-After the first login, the credentials will be saved locally, and you won't need to log in again via `swanlab.login` or `swanlab login`.
+After logging in once, the credentials will be saved locally, overwriting any previously saved credentials, eliminating the need to log in again via `swanlab.login` or `swanlab login`.
+
+> If you do not want the credentials to be saved locally, use [swanlab.login()](./py-login.md) in a Python script to log in.
+
+If your computer is not suitable for entering the API Key via the command line (e.g., some Windows CMD), you can use:
+
+```bash
+swanlab login -k <api-key>
+```
 
 ## Re-login
 
@@ -28,10 +39,16 @@ If you need to log in with a different account, use the following command:
 swanlab login --relogin
 ```
 
-This will prompt you to enter a new API Key to re-login.
+This will prompt you to enter a new API Key to log in again.
 
 ## Logout
 
 ```bash
 swanlab logout
+```
+
+## Logging in to a Private Service
+
+```bash
+swanlab login --host <host>
 ```