diff --git a/CHANGELOG.md b/CHANGELOG.md index 25b2d7e..bb55f0d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -88,4 +88,9 @@ added alias file so imports can either be `torch_log_wmse` or `torch_log_wmse_au #### Added ability to bypass frequency weightning + bug fixes Added `bypass_filter` argument that will bypass frequency weighting if `True`. -Fixed bug that returns NaN when one of the entries in the batch is a digital silence triplet - Thanks to Iver Jordal for the [issue](https://github.com/crlandsc/torch-log-wmse/issues/2) & [PR](https://github.com/crlandsc/torch-log-wmse/pull/3)! \ No newline at end of file +Fixed bug that returns NaN when one of the entries in the batch is a digital silence triplet - Thanks to Iver Jordal for the [issue](https://github.com/crlandsc/torch-log-wmse/issues/2) & [PR](https://github.com/crlandsc/torch-log-wmse/pull/3)! + +## 0.2.9 (2024-07-31) + +#### Updated README +Updated README to reflect 0.2.8 `bypass_filter` update. diff --git a/README.md b/README.md index b7a23e5..82cfcf0 100644 --- a/README.md +++ b/README.md @@ -27,8 +27,14 @@ audio_channels = 2 # stereo batch = 4 # batch size # Instantiate logWMSE -# Set `return_as_loss=False` to resturn as a positive metric -log_wmse = LogWMSE(audio_length=audio_length, sample_rate=sample_rate, return_as_loss=True) +# Set `return_as_loss=False` to resturn as a positive metric (Default: True) +# Set `bypass_filter=True` to bypass frequency weighting (Default: False) +log_wmse = LogWMSE( + audio_length=audio_length, + sample_rate=sample_rate, + return_as_loss=True, # optional + bypass_filter=False, # optional +) # Generate random inputs (scale between -1 and 1) audio_lengths_samples = int(audio_length * sample_rate) diff --git a/setup.cfg b/setup.cfg index 44ebe49..f54b5e8 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [metadata] name = torch-log-wmse -version = 0.2.8 +version = 0.2.9 author = Christopher Landschoot author_email = crlandschoot@gmail.com license = Apache License 2.0 diff --git a/torch_log_wmse/__init__.py b/torch_log_wmse/__init__.py index 4deb384..762ba1c 100644 --- a/torch_log_wmse/__init__.py +++ b/torch_log_wmse/__init__.py @@ -1,3 +1,3 @@ from .metric import LogWMSE -__version__ = "0.2.8" +__version__ = "0.2.9"