Skip to content

Commit

Permalink
Publish the Open JOSS reviewed version
Browse files Browse the repository at this point in the history
  • Loading branch information
BreezeWhite committed Dec 9, 2021
1 parent 08bc487 commit 0e376dd
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 3 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Changelog

## 0.5.0 - 2021-12-09

Official Open JOSS reviewed version.

## Bugs
- Fix bug of name conflict while loading chord model.


## 0.4.2 - 2021-11-16

Accumulated release. Various improvements and bug fix. See details below.
Expand Down
2 changes: 1 addition & 1 deletion omnizart/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@
os.environ['TF_CPP_MIN_LOG_LEVEL'] = '3'
os.environ['VAMP_PATH'] = os.path.join(MODULE_PATH, "resource", "vamp")

__version__ = "0.4.2"
__version__ = "0.5.0"
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "omnizart"
version = "0.4.2"
version = "0.5.0"
description = "Omniscient Mozart, being able to transcribe everything in the music."
readme = "README.md"
authors = ["BreezeWhite <[email protected]>", "yjlolo <[email protected]>"]
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@

setup_kwargs = {
'name': 'omnizart',
'version': '0.4.2',
'version': '0.5.0',
'description': 'Omniscient Mozart, being able to transcribe everything in the music.',
'long_description': '# OMNIZART\n\n[![build](https://github.com/Music-and-Culture-Technology-Lab/omnizart/workflows/general-check/badge.svg)](https://github.com/Music-and-Culture-Technology-Lab/omnizart/actions?query=workflow%3Ageneral-check)\n[![docs](https://github.com/Music-and-Culture-Technology-Lab/omnizart/workflows/docs/badge.svg?branch=build_doc)](https://music-and-culture-technology-lab.github.io/omnizart-doc/)\n[![PyPI version](https://badge.fury.io/py/omnizart.svg)](https://badge.fury.io/py/omnizart)\n![PyPI - License](https://img.shields.io/pypi/l/omnizart)\n[![Downloads](https://static.pepy.tech/personalized-badge/omnizart?period=month&units=international_system&left_color=grey&right_color=brightgreen&left_text=downloads/month)](https://pepy.tech/project/omnizart)\n[![Docker Pulls](https://img.shields.io/docker/pulls/mctlab/omnizart)](https://hub.docker.com/r/mctlab/omnizart)\n\nOmnizart is a Python library that aims for democratizing automatic music transcription.\nGiven polyphonic music, it is able to transcribe pitched instruments, vocal melody, chords, drum events, and beat.\nThis is powered by the research outcomes from [Music and Culture Technology (MCT) Lab](https://sites.google.com/view/mctl/home).\n\n### Transcribe your favorite songs now in Colab! [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://bit.ly/OmnizartColab)\n\n# Quick start\n\nVisit the [complete document](https://music-and-culture-technology-lab.github.io/omnizart-doc/) for detailed guidance.\n\n## Pip\n``` bash\n# Install omnizart\npip install omnizart\n\n# Download the checkpoints\nomnizart download-checkpoints\n\n# Transcribe your songs\nomnizart drum transcribe <path/to/audio.wav>\nomnizart chord transcribe <path/to/audio.wav>\nomnizart music transcribe <path/to/audio.wav>\n```\n\n## Docker\n```\ndocker pull mctlab/omnizart:latest\ndocker run -it mctlab/omnizart:latest bash\n```\n\n# Supported applications\n| Application | Transcription | Training | Evaluation | Description |\n|------------------|--------------------|--------------------|------------|--------------------------------------------------|\n| music | :heavy_check_mark: | :heavy_check_mark: | | Transcribe musical notes of pitched instruments. |\n| drum | :heavy_check_mark: | :interrobang: | | Transcribe events of percussive instruments. |\n| vocal | :heavy_check_mark: | :heavy_check_mark: | | Transcribe note-level vocal melody. |\n| vocal-contour | :heavy_check_mark: | :heavy_check_mark: | | Transcribe frame-level vocal melody (F0). |\n| chord | :heavy_check_mark: | :heavy_check_mark: | | Transcribe chord progressions. |\n| beat | :heavy_check_mark: | :heavy_check_mark: | | Transcribe beat position. |\n\n**NOTES**\nThe current implementation for the drum model has unknown bugs, preventing loss convergence when training from scratch.\nFortunately, you can still enjoy drum transcription with the provided checkpoints.\n\n## Compatibility Issue\nCurrently, Omnizart is **incompatible for ARM-based MacOS** system due to the underlying dependencies.\nMore details can be found in the [issue #38](https://github.com/Music-and-Culture-Technology-Lab/omnizart/issues/38).\n',
'author': 'BreezeWhite',
Expand Down

0 comments on commit 0e376dd

Please sign in to comment.