Swanlab

一个补丁版本。

改进
- 多媒体图表支持通过方向键切换查看
修复问题
- 修复部分Bug

What's Changed
* Fixbug/show patch by SAKURA-CAT in https://github.com/SwanHubX/SwanLab/pull/383
* Feat/object3d chart by Nexisato in https://github.com/SwanHubX/SwanLab/pull/382
* Feature/keyboard by Feudalman in https://github.com/SwanHubX/SwanLab/pull/389


**Full Changelog**: https://github.com/SwanHubX/SwanLab/compare/v0.2.1...v0.2.2


What's Changed
* fix: chart type by Feudalman in https://github.com/SwanHubX/SwanLab/pull/321
* Fixbug/tag sort by Feudalman in https://github.com/SwanHubX/SwanLab/pull/327
* Readme v0.2.0 by xiaolin199912 in https://github.com/SwanHubX/SwanLab/pull/326
* Feat/image-add-parameters-boxes-masks by xiaolin199912 in https://github.com/SwanHubX/SwanLab/pull/329
* Feat/new line chart by SAKURA-CAT in https://github.com/SwanHubX/SwanLab/pull/334
* Feat/video chart by KashiwaByte in https://github.com/SwanHubX/SwanLab/pull/338
* record max step and min step by SAKURA-CAT in https://github.com/SwanHubX/SwanLab/pull/341
* feat/add swanlab.Run by xiaolin199912 in https://github.com/SwanHubX/SwanLab/pull/347
* Feat/tooltip by SAKURA-CAT in https://github.com/SwanHubX/SwanLab/pull/340
* feat/class-video by xiaolin199912 in https://github.com/SwanHubX/SwanLab/pull/343
* Update/line chart styles by SAKURA-CAT in https://github.com/SwanHubX/SwanLab/pull/351
* legend component by SAKURA-CAT in https://github.com/SwanHubX/SwanLab/pull/354
* Feature/text chart by Feudalman in https://github.com/SwanHubX/SwanLab/pull/337
* fix zoom logic by SAKURA-CAT in https://github.com/SwanHubX/SwanLab/pull/362
* Refactor/log page by Feudalman in https://github.com/SwanHubX/SwanLab/pull/361
* fix: delete charts with experiment destroying by Feudalman in https://github.com/SwanHubX/SwanLab/pull/367
* Fixbug/finish time by SAKURA-CAT in https://github.com/SwanHubX/SwanLab/pull/365
* fix: undefined table value by Feudalman in https://github.com/SwanHubX/SwanLab/pull/372
* UI/tooltip by xiaolin199912 in https://github.com/SwanHubX/SwanLab/pull/374
* Feat/readme-v0.2.1 by xiaolin199912 in https://github.com/SwanHubX/SwanLab/pull/375


**Full Changelog**: https://github.com/SwanHubX/SwanLab/compare/v0.2.0...v0.2.1

往下翻有中文版～

New Features
- Multi-Experiment Charts: Support for comparing log data from multiple experiments within a project in a single chart.
<img width="800" alt="image" src="https://github.com/SwanHubX/SwanLab/assets/58305964/17ee8a05-ed26-4b85-8825-b00614fcd4bd">

- Image Charts: Support for log image types (supports files, numpy arrays, PIL.Image, matplotlib).
<img width="800" alt="image" src="https://github.com/SwanHubX/SwanLab/assets/58305964/3cbd95ea-d4fa-448f-8e78-73f3fa4187b2">

- Audio Charts: Support for log audio types (supports files, numpy arrays).
<img width="800" alt="image" src="https://github.com/SwanHubX/SwanLab/assets/58305964/b892a466-6d95-47c3-a279-ece3d1111a6d">

- Support for automatically viewing information of other Charts at the same position when viewing information of one Chart.
<img width="800" alt="image" src="https://github.com/SwanHubX/SwanLab/assets/58305964/e5362d30-8855-4b2f-9ac8-18009ce920db">

Improvements
- Added suffix parameter to swanlab.init to support customizing experiment suffixes.
- Changed the loggings parameter in swanlab.log to logger, which will support controlling the automatically printed content in the form of a dictionary.
- Changed the default experiment name format to: '%b%d-%h-%m-%s' (example: 'Feb03_14-45-37').
- Changed the logdir item in Environment to the log file path of the specific experiment.
- Added hardware data monitoring class.
- Improved numerous UI details.

Bug Fixes
- Fixed some line chart display errors caused by the step parameter in swanlab.log.
- Fixed issues with logs loading unsuccessfully in some cases.

<br>

新增功能
- 多实验对比图表：支持项目下多个实验的日志数据在一张图表中对比
<img width="800" alt="image" src="https://github.com/SwanHubX/SwanLab/assets/58305964/17ee8a05-ed26-4b85-8825-b00614fcd4bd">

- 图像图表：支持log图像类型（支持文件、numpy array、PIL.Image、matplotlib）
<img width="800" alt="image" src="https://github.com/SwanHubX/SwanLab/assets/58305964/3cbd95ea-d4fa-448f-8e78-73f3fa4187b2">

- 音频图表：支持log音频类型（支持文件、numpt array）
<img width="800" alt="image" src="https://github.com/SwanHubX/SwanLab/assets/58305964/b892a466-6d95-47c3-a279-ece3d1111a6d">

- 支持查看1个Chart的信息时，自动查看其他Chart在相同位置的信息
<img width="800" alt="image" src="https://github.com/SwanHubX/SwanLab/assets/58305964/e5362d30-8855-4b2f-9ac8-18009ce920db">


改进
- `swanlab.init`增加suffix参数支持自定义实验后缀
- `swanlab.log`将loggings参数改为logger参数，将支持以字典的形式控制自动打印的内容
- 将默认实验名称格式改为：'%b%d-%h-%m-%s'(example:'Feb03_14-45-37')
- 将Environment中的logdir项变更为具体实验的日志文件路径
- 增加硬件数据监看类
- 改进大量UI细节

修复问题
- 修复部分由swanlab.log->step参数引起的折线图显示错误
- 修复部分情况下logs加载失败的问题

贡献者
SAKURA-CAT Feudalman Nexisato KashiwaByte little1d xiaolin199912

New Features
- Added API`loggings` to swanlab.init and swanlab.log, which automatically prints metrics to the terminal when loggings are enabled by xiaolin199912 Feudalman in 277
- New Config/Summary table component with support for parameter search by Feudalman SAKURA-CAT in 271

Improvement
- improve web page fonts by xiaolin199912 in 278
- improve web page header by little1d in 260
- Fixed an problem where NaN appears in swanlab.log by SAKURA-CAT Feudalman in 273

Bug Fixes
- Fixed an issue where running "swanlab watch" in Python 3.8 would result in an error by Feudalman in 271
- Fixed a problem where incompatible data types in swanlab.log would cause GridView and Summary components to crash by SAKURA-CAT Feudalman in 273

新增功能
- swanlab.init与swanlab.log增加APIloggings，开启loggings时将自动打印指标到终端 by xiaolin199912 Feudalman in 277
- 新的Config/Summary表格组件，支持参数搜索 by Feudalman SAKURA-CAT in 271

优化
- 优化网页字体 by xiaolin199912 in 278
- 优化网页Header by little1d in 260
- 优化swanlab.log出现NaN的情况 by SAKURA-CAT Feudalman in 273

修复
- 修复在python3.8版本时运行swanlab watch会报错的问题 by Feudalman in 271
- 修复当swanlab.log出现非兼容类型数据时会导致GridView和Summary组件崩溃的问题 by SAKURA-CAT Feudalman in 273

🚨 Breaking News
In the version, we replaced the previous basic configuration information read/write solution with SQLite database and Peewee library. This is a major change that is highly beneficial for the future of the project, but it is not compatible with old versions (swanlab`<=v0.1.4`) of log data files. Therefore, if you need to visualize log files generated by old versions, please use [transfer script](https://github.com/SwanHubX/SwanLab/blob/main/script/transfer_logfile_0.1.4.py).

在此版本，我们使用SQLite数据库和Peewee库替代了之前的基础配置信息读写方案。这是个极大有利于项目未来的改动，但缺陷是不兼容旧版本（swanlab`<=v0.1.4`）的日志数据文件，所以如需可视化旧版本产生的日志文件，使用[转换脚本](https://github.com/SwanHubX/SwanLab/blob/main/script/transfer_logfile_0.1.4.py)。

New Features
- Replaced the previous basic configuration information read/write solution with SQLite database and Peewee library (114) by SAKURA-CAT Feudalman in 203 202.
- Experiment list supports quick export of CSV files by Feudalman in 206
- Experiment list supports "Summary Only" view by Feudalman in 230
- Experiment list supports search by Feudalman in 230
- Environment item added "Quick Copy" interaction by Feudalman in 250
- Automatic environment recording adds logdir and Run path by Feudalman KashiwaByte in 205
- New API `swanlab.config` by xiaolin199912 SAKURA-CAT in 248

Optimization
- Optimized part of UI by SAKURA-CAT Feudalman in 209
- Added Y-axis line to line chartby SAKURA-CATin 214
- Optimized error message: The path to the log file read by swanlab watch does not exist by xiaolin199912 in 239
- Added Prisma support for swpfY in 255

Bug Fixes
 - Fixed an issue where an error would occur when passing parameters into the hydra library by xiaolin199912 in 237
 - Fixed an issue where swanlab.log would throw an error when encountering a key with spaces in a dictionary passed as input by SAKURA-CAT in 211
 - Fixed an issue where an error would occur when running a training script in a path without initializing git by xiaolin199912 in 217

新增功能
- 使用SQLite数据库和Peewee库替代了之前的基础配置信息读写方案(114) by SAKURA-CAT Feudalman in 203 202
- 实验列表支持快速导出CSV文件 Feudalman in 206
- 实验列表支持“仅看Summary” Feudalman in 230
- 实验列表支持搜索 Feudalman in 230
- 环境项增加“快捷复制”交互 Feudalman in 250
- 自动环境记录增加 logdir、Run path Feudalman KashiwaByte in 205
- 新的API`swanlab.config` xiaolin199912 SAKURA-CAT in 248

优化
- 优化部分UI SAKURA-CAT Feudalman in 209
- 折线图增加Y轴线 SAKURA-CAT in 214
- 优化报错信息：swanlab watch读取的日志文件路径不存在 xiaolin199912 in 239
- 增加Prisma支持 swpfY in 255

问题修复
- 修复在hydra库传入参数时会报错的问题 xiaolin199912 in 237
- 修复swanlab.log传入字典的key在出现空格时报错的问题 SAKURA-CAT in 211
- 修复运行训练脚本的路径下没有初始化git时会出现报错的问题 xiaolin199912 in 217

**Full Changelog**: https://github.com/SwanHubX/SwanLab/compare/v0.1.4...v0.1.5

New Features

- New UI & UX By SAKURA-CAT, Feudalman in 177
- Responsive page design: Optimized viewing experience for various resolution devices such as mobile phones and tablets. By SAKURA-CAT, Feudalman, 177
- Addition of automatic environment recording: Command, Git Branch, Git Commit, Memory. By xiaolin199912 in 169
- Addition of automatic environment recording for Requirements - Supports automatically recording the pip environment list of the current training environment. By xiaolin199912 in 169
- Logs and Requirements support search, copy and download by Feudalman in 179, 173
- `swanlab.init` adds API `logdir`: Supports setting the save location of log files. By SAKURA-CAT ,Feudalman in 142
- `swanlab watch` adds API `--logdir`, supports specifying the location of log files to be read.
- `swanlab.init`->`config` supports calling like Argparse by xiaolin199912,SAKURA-CAT in 178 examples:

python
import swanlab

run = swanlab.init(
config={'epoch': 20}
)

print(run.config.epoch)


Optimization
- Optimized logic for displaying x-axis on Charts by SAKURA-CAT.
- Optimized auto-refresh logic for Charts to improve performance by SAKURA-CAT.
- Optimized record format for extremely small and large numbers on Charts and Summary by SAKURA-CAT,Feudalman in 196.
- Added unit tests by Ink in 171.

Bug Fixes
- Fixed an issue with recording Requirements: by xiaolin199912in 184
- Fixed display issue when rounding floating point numbers on Charts: by Feudalman in 105.

新增功能
- 全新的UI & UX By SAKURA-CAT、Feudalman in 177
- 页面响应式：优化手机、平板等各种分辨率设备查看实验看板的体验 By SAKURA-CAT、Feudalman，177
- 自动环境记录增加：Command 、Git Branch、Git Commit、内存 By xiaolin199912 in 169
- 自动环境记录增加Requirements-支持自动记录当前训练环境的pip环境列表 By xiaolin199912 in 169
- Logs、Requirements支持搜索、复制与下载 by Feudalman in 179、173
- `swanlab.init`增加API`logdir`：支持设定日志文件的保存位置 by SAKURA-CAT 、Feudalman in 142
- `swanlab watch`增加API`--logdir`，支持指定要读取的日志文件位置，
- `swanlab.init`->`config`支持形如Argparse的方式调用 by xiaolin199912、SAKURA-CAT in 178, examples:

python
import swanlab

run = swanlab.init(
config={'epoch': 20}
)

print(run.config.epoch)


优化
- 优化Charts横坐标的显示逻辑 by SAKURA-CAT
- 优化Charts的自动刷新逻辑，提高性能 by SAKURA-CAT
- 优化Charts、Summary对极小数、极大数的记录方式 by SAKURA-CAT、Feudalman in 196
- 增加单元测试 by swpfY in 171

问题修复
- 修复记录Requirements时的问题：by xiaolin199912 in 184
- 修复Charts记录取整的浮点数时的显示问题：by Feudalman in 105

Full changes: https://github.com/SwanHubX/SwanLab/compare/v0.1.3...v0.1.4