Skip to content

Commit

Permalink
Corrected naming for filter_ir.pkl and bumped version
Browse files Browse the repository at this point in the history
  • Loading branch information
crlandsc committed Jun 18, 2024
1 parent a31c31d commit b8633be
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 10 deletions.
7 changes: 6 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,9 @@ from torch_log_wmse import LogWMSE
## 0.2.1 (2024-06-18)

#### Updated badges
Updated badge references in the `README`.
Updated badge references in the `README`.

## 0.2.2 (2024-06-18)

#### Changed GitHub repo name & references
Updated GitHub repo name to appropriate `torch-log-wmse`. `torch-log-wmse-audio-quality` can still be installed, but everything will reference the new name (`torch-log-wmse`) moving forward.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
![torch-log-wmse-logo](https://raw.githubusercontent.com/crlandsc/torch-log-wmse-audio-quality/main/images/logo.png)
![torch-log-wmse-logo](https://raw.githubusercontent.com/crlandsc/torch-log-wmse/main/images/logo.png)

[![LICENSE](https://img.shields.io/github/license/crlandsc/torch-log-wmse-audio-quality)](https://github.com/crlandsc/torch-log-wmse-audio-quality/blob/main/LICENSE) [![GitHub Repo stars](https://img.shields.io/github/stars/crlandsc/torch-log-wmse-audio-quality)](https://github.com/crlandsc/torch-log-wmse-audio-quality/stargazers) [![GitHub forks](https://img.shields.io/github/forks/crlandsc/torch-log-wmse-audio-quality)](https://github.com/crlandsc/torch-log-wmse-audio-quality/forks)
[![LICENSE](https://img.shields.io/github/license/crlandsc/torch-log-wmse)](https://github.com/crlandsc/torch-log-wmse/blob/main/LICENSE) [![GitHub Repo stars](https://img.shields.io/github/stars/crlandsc/torch-log-wmse)](https://github.com/crlandsc/torch-log-wmse/stargazers) [![GitHub forks](https://img.shields.io/github/forks/crlandsc/torch-log-wmse)](https://github.com/crlandsc/torch-log-wmse/forks)

This repository contains the torch implementation of an audio quality metric, [logWMSE](https://github.com/nomonosound/log-wmse-audio-quality), originally proposed by [Iver Jordal](https://github.com/iver56) of [Nomono](https://nomono.co/). In addition to the original metric, this implementation can also be used as a loss function for training audio separation and denoising models.

Expand Down Expand Up @@ -65,7 +65,7 @@ The goal of this metric is to account for several factors not present in current
##### Frequency Weighting
To measure the frequencies of a signal closer to that of human hearing, the following frequency weighting is applied. This helps the model effectively pay less attention to errors at frequencies that humans are not sensitive to (e.g. 50 Hz) and give more weight to those that we are acutely tuned to (e.g. 3kHz).

![Frequency Weighting](https://raw.githubusercontent.com/crlandsc/torch-log-wmse-audio-quality/main/images/frequency_weighting.png)
![Frequency Weighting](https://raw.githubusercontent.com/crlandsc/torch-log-wmse/main/images/frequency_weighting.png)

This metric has been constructed with high-fidelity audio in mind (sample rates ≥ 44.1kHz). It theoretically could work for lower sample rates, like 16kHz, but the metric performs an internal resampling to 44.1kHz for consistency across any input sample rates.

Expand Down
10 changes: 5 additions & 5 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
[metadata]
name = torch-log-wmse-audio-quality
version = 0.2.1
name = torch-log-wmse
version = 0.2.2
author = Christopher Landschoot
author_email = [email protected]
license = Apache License 2.0
description = logWMSE is an audio quality metric & loss function with support for digital silence target. Useful for training and evaluating audio source separation systems.
long_description = file: README.md
long_description_content_type = text/markdown
url = https://github.com/crlandsc/torch-log-wmse-audio-quality
url = https://github.com/crlandsc/torch-log-wmse
project_urls =
Bug Tracker = https://github.com/crlandsc/torch-log-wmse-audio-quality/issues
Bug Tracker = https://github.com/crlandsc/torch-log-wmse/issues
classifiers =
Programming Language :: Python :: 3
License :: OSI Approved :: Apache Software License
Expand All @@ -25,7 +25,7 @@ install_requires =
numpy>=1.23.5

[options.package_data]
torch_log_wmse_audio_quality = filter_ir.pkl
torch_log_wmse = filter_ir.pkl

[options.packages.find]
where = .
2 changes: 1 addition & 1 deletion torch_log_wmse/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
from .metric import LogWMSE

__version__ = "0.2.1"
__version__ = "0.2.2"

0 comments on commit b8633be

Please sign in to comment.