Skip to content

Commit

Permalink
Add Changelog, remove changelog from Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
v-dvorak committed Oct 4, 2024
1 parent 01cc020 commit 3740c35
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 19 deletions.
40 changes: 40 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Change Log
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).

## [0.9.3] 2024-10-04

### Added

- evaluation script for YOLOv8 models
- "YOLOv8m vs Faster R-CNN" evaluation results to Releases
- models used in evaluation to Releases
- pretrained OLA model to releases

## [0.9.2] 2024-09

### Added

- `seed` option for dataset creation, enables reproducibility
- random shuffling to train/test split
- citation for each image used in MZKBlank

### Changed

- unpublished MZKBlank

### Fixed

- missing equality for `Label` class

## [0.9.1] 2024-08

### Added

- harmonized datasets to Releases

### Changed

- moved trained models from repository to Releases
19 changes: 0 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,6 @@ For best training results 1-10\% of images in the dataset should be background i

MZKBlank contains 1 006 semi-randomly chosen images that are related to sheet music but do not contain any sheet music. The numbers of representatives of one label are relative to the total number of pages.

## Tools

In addition to this dataset, multiple tools are provided

- [`MZK scraper`](https://github.com/v-dvorak/mzkscraper), automatic retrieval of documents from MZK based on search query

- [`PianoMaker`](app/PianoMaker/README.md) and `PianoAnnotator`, a small app that allows staff system and grand staff labels to be added into an already existing dataset

## Formal project specification

Version in Czech is [here](docs/project_specification.pdf).
Expand Down Expand Up @@ -104,14 +96,3 @@ Gotham, M. R. H.; and Jonas, P. The OpenScore Lieder Corpus. In Münnich, S.; an
Muscima++ takes empty staves as valid staves, we only consider staves with some music to be valid, this lead to multiple problems while working with M++ - empty staves are marked as valid. This has to be fixed mostly manually.

System are mainly created by looking at system staves at approximately the same height that are than connected to one (system) bounding box. Because M++ is handwritten, not all system measures end at the end of their respectable staves, this leads to a creation of systems, that may exclude a part of stave, that in reality is a part of the system.

## Changelog

- **September 2024**
- added random shuffling to train/test split
- added `seed` option
- unpublished MZKBlank

- **August 2024**
- complete dataset made public in Releases
- moved trained models from repository to Releases

0 comments on commit 3740c35

Please sign in to comment.