Skip to content

Commit

Permalink
docs: changelog new year (#82)
Browse files Browse the repository at this point in the history
* docs: index

* docs: changelog
  • Loading branch information
Zeyi-Lin authored Jan 2, 2025
1 parent 65d1f63 commit 270facb
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 428 deletions.
211 changes: 8 additions & 203 deletions en/guide_cloud/general/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,14 @@ Upgrade to latest version: `pip install -U swanlab`
Github: https://github.com/SwanHubX/SwanLab
:::

## New Year's Day Update

**🚀 New Features**
- Upgraded chart smoothing; the state will remain preserved after webpage refresh
- Updated chart resizing; now you can change the size by dragging the bottom right corner of the chart

**⚙️ Bug Fixes**
- Fixed a bug where the project settings did not display the delete option when there were no experiments

## v0.4.2 - 2024.12.24

Expand Down Expand Up @@ -249,206 +256,4 @@ by Cunyue
**⚡️Improvements**
- Optimized line chart rendering for large datasets
- Improved performance in Jupyter
- Fixed numerous issues from previous versions

## v0.2.4 - 2024.3.17

**⚡️Improvements**
- Improved image chart display
- `swanlab.Image` now supports PyTorch tensor input

**🔧Bug Fixes**
- Fixed multimedia chart caption parameter issues
- Fixed issues caused by interrupting `swanlab.init` initialization
- Fixed SwanLab initialization errors in Jupyter notebook

## v0.2.3 - 2024.3.12

**🚀New Features**
- Added line chart smoothing with 3 algorithms
- Added chart pinning
- Added chart hiding

**⚡️Improvements**
- Remembers chart group collapse states
- Multimedia charts default to showing last step

## v0.2.2 - 2024.3.4

**⚡️Improvements**
- Multimedia charts support arrow key navigation

**🔧Bug Fixes**
- Fixed various bugs

## v0.2.1 - 2024.3.1

**🚀New Features**
- Text charts: Support for log text type
- Multi-experiment charts support image and audio charts

**⚡️Improvements**
- Improved line chart component performance

## v0.2.0 - 2024.2.8

**New Features**
- Multi-experiment comparison charts: Compare log data from multiple experiments in one chart
- Image charts: Support for logging images (files, numpy arrays, PIL.Image, matplotlib)
- Audio charts: Support for logging audio (files, numpy arrays)
- Auto-view other charts at same position when viewing one chart

**Improvements**
- Added suffix parameter to swanlab.init for custom experiment suffixes
- Changed loggings parameter to logger in swanlab.log, supporting dictionary control of auto-printing
- Changed default experiment name format to: '%b%d-%h-%m-%s' (example:'Feb03_14-45-37')
- Changed Environment logdir to specific experiment log file path
- Added hardware data monitoring class
- Improved many UI details

**Bug Fixes**
- Fixed line chart display errors caused by swanlab.log step parameter
- Fixed logs loading failures in some cases

## v0.1.6 - 2024.1.25

**New Features**
- Added APIloggings to swanlab.init and swanlab.log, auto-prints metrics to terminal when enabled
- New Config/Summary table component with parameter search

**Improvements**
- Optimized web fonts
- Optimized web header
- Optimized handling of NaN in swanlab.log

**Fixes**
- Fixed swanlab watch errors in Python 3.8
- Fixed GridView and Summary component crashes with incompatible data types in swanlab.log

## v0.1.5 - 2024.1.23

**New Features**
- 🚨Replaced basic config info read/write with SQLite database and Peewee library (#114)
- Major improvement for future development but incompatible with old versions (swanlab<=v0.1.4). Use [conversion script](https://github.com/SwanHubX/SwanLab/blob/main/script/transfer_logfile_0.1.4.py) for old log files
- Experiment list supports quick CSV export
- Experiment list supports "Summary Only" view
- Experiment list supports search
- Environment items have "Quick Copy" interaction
- Auto environment recording adds logdir, Run path
- New API swanlab.config

**Improvements**
- Improved various UI elements
- Added Y-axis lines to line charts
- Improved error messages for non-existent log files in swanlab watch

**Fixes**
- Fixed errors with hydra library parameter input
- Fixed errors with spaces in swanlab.log dictionary keys
- Fixed errors when running without git initialization

## v0.1.4 - 2024.1.13

**New Features**
- New UI & UX
- Responsive design: Optimized for phones, tablets, and various resolutions
- Additional auto environment recording:
- Command
- Git Branch
- Git Commit
- Memory
- Requirements - Auto records current pip environment
- Logs and Requirements support search, copy, and download

**New APIs**
- swanlab.init adds logdir API: Set log file save location
- swanlab watch adds --logdir API: Specify log file location to read
- swanlab.init->config supports Argparse-style calls

**Improvements**
- Optimized Charts x-axis display logic
- Optimized Charts auto-refresh logic for better performance
- Improved Charts and Summary recording of very small/large numbers
- Added unit tests

**Bug Fixes**
- Fixed Requirements recording issues
- Fixed Charts display issues with rounded floating points

## v0.1.3 - 2024.1.7

**New Features**
- Projects and experiments can be deleted via web interface
- Projects and experiments support name and description editing via web
- Added experiment time suffix
- Default project name is training script folder name

**Improvements**
- Enhanced Table component interaction and performance
- Improved pypi display information
- Added message popup component and placeholders
- Improved message popup component styles
- Added git branch name and latest commit hash functions
- Renamed OverView to Project Dashboard

**Bug Fixes**
- Fixed terminal log format issues
- Fixed naming conflicts
- Fixed experiment board port occupation errors
- Improved error page navigation
- Fixed warning issues when running experiment board

## v0.1.2 - 2024.1.1

- Increased Charts data update frequency, added request status mapping
- Fixed project and experiment OverView status not updating after training
- Fixed errors with slashes in swanlab.log data parameter keys
- Fixed display issues with non-standard value types in swanlab.log data
- Optimized Chart value ranges based on recorded data max/min
- Improved experiment table component
- Added command and requirements recording functions
- Added git hooks for code formatting and commit testing
- Fixed duplicate column issues in experiment table with slashed keys

## v0.1.1 - 2023.12.26

**Feature Updates**
- Added Experiment Metrics Comparison Table to compare configurations and results
- Added more experiment parameter recording (Python interpreter directory, system hardware, Git repository path, Swanlab version)

**Improvements**
- New table component for better interaction
- Adjusted time display format

**API Updates**
- Added step parameter to swanlab.log

## v0.1.0 - 2023.12.22

**Feature Updates**
- Added Log functionality to experiment board, auto-records terminal output (including errors)

**Improvements**
- Changed default language to English
- Changed sidebar text from "Community Version" to "Version Number"
- Optimized chart data display format

## v0.0.2 - 2023.12.16

**Feature Updates**
- Added experiment status: Stop
- Added Configuration and Summary information display
- Added automatic terminal log collection, stored in swanlog/experiment_folder/console/yy-mm-dd.log
- Added error pages to experiment board
- Added new API for swanlab watch: host, details in Experiment Board

**Major Updates**
- Adjusted log file structure (incompatible with previous versions). From v0.0.2, default log folder is swanlog

**Improvements**
- Improved chart styles: bold titles, chart zoom support, x-axis display
- Improved terminal output during training
- Improved chart color selection mechanism
- Improved default chart group names and styles
- Improved default project names
- Improved experiment sorting: newest first by default
- Fixed numerous issues from previous versions
5 changes: 1 addition & 4 deletions en/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,7 @@ hero:
link: /en/guide_cloud/general/what-is-swanlab.md
- theme: brand
text: Website
link: https://dev101.swanlab.cn
# - theme: alt
# text: Quick Start
# link: /en/guide_cloud/general/quick-start.md
link: https://swanlab.cn
- theme: alt
text: Docs GitHub
link: https://github.com/SwanHubX/SwanLab-Docs
Expand Down
Loading

0 comments on commit 270facb

Please sign in to comment.