# SwanLab-Dashboard
SwanLab - 训练可视化服务
该仓库用于维护SwanLab训练可视化服务的相关代码和文档，包含前后端。
## 目录结构
其中 `swanboard` 用于维护后端代码，`vue` 用于维护前端代码，`test` 用于维护测试代码。
```
├── swanboard
│ ├── controller
│ ├── db
│ ├── middleware
│ ├── module
│ ├── router
│ ├── run
│ ├── settings.py
│ ├── template
│ └── utils
├── test
├── tutils
└── vue
```
## 工作流程
- 后端开发者在 `swanboard` 目录下进行开发，完成后端功能。
- 前端开发者在 `vue` 目录下进行开发，完成前端功能后，需要进行打包 `npm run build.release`，打包目标路径为 `swanboard/template`。
- 前后端开发完成后，需要进行测试，测试代码存放在 `test` 目录下。
- 整体功能通过，即可在 main 上发布新版本，同时发布新 tag，触发自动打包并更新 pypi 包版本。
## SwanLab 与 SwanBoard
SwanBoard 仅负责针对训练数据提供可视化服务，而不参与训练过程。其作为依赖导入到 SwanLab 中，由 `swanlab watch` 命令启动服务。
Raw data
{
"_id": null,
"home_page": null,
"name": "swanboard",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "machine learning, reproducibility, visualization",
"author": null,
"author_email": "Cunyue <team@swanhub.co>, Feudalman <team@swanhub.co>",
"download_url": "https://files.pythonhosted.org/packages/a4/88/43a18d2e3b65f28b6310034546a8cdeab84ce2e700b9622719f53e5ad684/swanboard-0.1.6.tar.gz",
"platform": null,
"description": "# SwanLab-Dashboard\n\nSwanLab - \u8bad\u7ec3\u53ef\u89c6\u5316\u670d\u52a1\n\n\u8be5\u4ed3\u5e93\u7528\u4e8e\u7ef4\u62a4SwanLab\u8bad\u7ec3\u53ef\u89c6\u5316\u670d\u52a1\u7684\u76f8\u5173\u4ee3\u7801\u548c\u6587\u6863\uff0c\u5305\u542b\u524d\u540e\u7aef\u3002\n\n## \u76ee\u5f55\u7ed3\u6784\n\n\u5176\u4e2d `swanboard` \u7528\u4e8e\u7ef4\u62a4\u540e\u7aef\u4ee3\u7801\uff0c`vue` \u7528\u4e8e\u7ef4\u62a4\u524d\u7aef\u4ee3\u7801\uff0c`test` \u7528\u4e8e\u7ef4\u62a4\u6d4b\u8bd5\u4ee3\u7801\u3002\n\n```\n\u251c\u2500\u2500 swanboard\n\u2502 \u251c\u2500\u2500 controller\n\u2502 \u251c\u2500\u2500 db\n\u2502 \u251c\u2500\u2500 middleware\n\u2502 \u251c\u2500\u2500 module\n\u2502 \u251c\u2500\u2500 router\n\u2502 \u251c\u2500\u2500 run\n\u2502 \u251c\u2500\u2500 settings.py\n\u2502 \u251c\u2500\u2500 template\n\u2502 \u2514\u2500\u2500 utils\n\u251c\u2500\u2500 test\n\u251c\u2500\u2500 tutils\n\u2514\u2500\u2500 vue\n```\n\n## \u5de5\u4f5c\u6d41\u7a0b\n\n- \u540e\u7aef\u5f00\u53d1\u8005\u5728 `swanboard` \u76ee\u5f55\u4e0b\u8fdb\u884c\u5f00\u53d1\uff0c\u5b8c\u6210\u540e\u7aef\u529f\u80fd\u3002\n- \u524d\u7aef\u5f00\u53d1\u8005\u5728 `vue` \u76ee\u5f55\u4e0b\u8fdb\u884c\u5f00\u53d1\uff0c\u5b8c\u6210\u524d\u7aef\u529f\u80fd\u540e\uff0c\u9700\u8981\u8fdb\u884c\u6253\u5305 `npm run build.release`\uff0c\u6253\u5305\u76ee\u6807\u8def\u5f84\u4e3a `swanboard/template`\u3002\n- \u524d\u540e\u7aef\u5f00\u53d1\u5b8c\u6210\u540e\uff0c\u9700\u8981\u8fdb\u884c\u6d4b\u8bd5\uff0c\u6d4b\u8bd5\u4ee3\u7801\u5b58\u653e\u5728 `test` \u76ee\u5f55\u4e0b\u3002\n- \u6574\u4f53\u529f\u80fd\u901a\u8fc7\uff0c\u5373\u53ef\u5728 main \u4e0a\u53d1\u5e03\u65b0\u7248\u672c\uff0c\u540c\u65f6\u53d1\u5e03\u65b0 tag\uff0c\u89e6\u53d1\u81ea\u52a8\u6253\u5305\u5e76\u66f4\u65b0 pypi \u5305\u7248\u672c\u3002\n\n## SwanLab \u4e0e SwanBoard\n\nSwanBoard \u4ec5\u8d1f\u8d23\u9488\u5bf9\u8bad\u7ec3\u6570\u636e\u63d0\u4f9b\u53ef\u89c6\u5316\u670d\u52a1\uff0c\u800c\u4e0d\u53c2\u4e0e\u8bad\u7ec3\u8fc7\u7a0b\u3002\u5176\u4f5c\u4e3a\u4f9d\u8d56\u5bfc\u5165\u5230 SwanLab \u4e2d\uff0c\u7531 `swanlab watch` \u547d\u4ee4\u542f\u52a8\u670d\u52a1\u3002\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Dashboard for SwanLab.",
"version": "0.1.6",
"project_urls": {
"Bug Reports": "https://github.com/SwanHubX/SwanLab-Dashboard/issues",
"Homepage": "https://swanhub.co",
"Source": "https://github.com/SwanHubX/SwanLab-Dashboard"
},
"split_keywords": [
"machine learning",
" reproducibility",
" visualization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fa30bab0a06484cfb4b250555e341f636b8ad7383b2c23f916f5b850d340fb5b",
"md5": "ca03253f1527867a975dbab0c582a42c",
"sha256": "802a7cbe019af441b2c802396ae7207964d021178d57e9cd13c2215a01d45f63"
},
"downloads": -1,
"filename": "swanboard-0.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ca03253f1527867a975dbab0c582a42c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 751094,
"upload_time": "2024-11-24T09:14:14",
"upload_time_iso_8601": "2024-11-24T09:14:14.578062Z",
"url": "https://files.pythonhosted.org/packages/fa/30/bab0a06484cfb4b250555e341f636b8ad7383b2c23f916f5b850d340fb5b/swanboard-0.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a48843a18d2e3b65f28b6310034546a8cdeab84ce2e700b9622719f53e5ad684",
"md5": "084403befd210471d9837fffbc052bf3",
"sha256": "f1a3c3911e40932327c8b9c84b1af67cac69f9ad9d880abed0bf0c42e7b30db8"
},
"downloads": -1,
"filename": "swanboard-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "084403befd210471d9837fffbc052bf3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1166845,
"upload_time": "2024-11-24T09:14:15",
"upload_time_iso_8601": "2024-11-24T09:14:15.984388Z",
"url": "https://files.pythonhosted.org/packages/a4/88/43a18d2e3b65f28b6310034546a8cdeab84ce2e700b9622719f53e5ad684/swanboard-0.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-24 09:14:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SwanHubX",
"github_project": "SwanLab-Dashboard",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "swankit",
"specs": []
},
{
"name": "fastapi",
"specs": [
[
">=",
"0.110.1"
]
]
},
{
"name": "uvicorn",
"specs": [
[
">=",
"0.14.0"
]
]
},
{
"name": "peewee",
"specs": []
},
{
"name": "ujson",
"specs": []
},
{
"name": "psutil",
"specs": []
},
{
"name": "setuptools",
"specs": []
}
],
"lcname": "swanboard"
}
JSON
