Skip to content

Commit

Permalink
Miscellaneous documentation updates (librosa#1602)
Browse files Browse the repository at this point in the history
* updated changelog

* updated contributing docs, fixes librosa#1601

* updated repet-sim notebook, fixes librosa#1492

* fixed a broken setup.cfg change from librosa#1492
  • Loading branch information
bmcfee committed Nov 11, 2022
1 parent bdce9cf commit 5dce3f3
Show file tree
Hide file tree
Showing 5 changed files with 112 additions and 1 deletion.
9 changes: 9 additions & 0 deletions AUTHORS.md
Expand Up @@ -87,6 +87,15 @@ Contributors
* Xiao-Ming <https://github.com/Xiao-Ming>
* Will Monroe <https://github.com/futurulus>
* Lorenz Nickel <https://github.com/LorenzNickel>
* Mattia Di Gangi <https://github.com/mattiadg>
* Kian Eliasi <https://github.com/kianelbo>
* Anton Kostin <https://github.com/masguit42>
* Emily Halvachs <https://github.com/Embot2000>
* Juantia Gomez <https://github.com/juanis2112>
* Helmi Jinoz <https://github.com/helminzo>
* Zvi Baratz <https://github.com/ZviBaratz>
* Alexandre Chabot-Leclerc <https://github.com/achabotl>
* Steve Kowalik <https://github.com/s-t-e-v-e-n-k>

Some feature extraction code was based on <https://github.com/ronw/frontend> by Ron Weiss.

Expand Down
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Expand Up @@ -101,6 +101,10 @@ If existing images need to be updated or new ones should be added:
3. Inspect the new baseline images under tmp/
4. If (3) looks good, copy into `tests/baseline_images/test_display/` and add to the PR.

Finally, once your pull request has been created and reviewed, please update the file `docs/changelog.rst`
to briefly summarize your contribution in the section for the next release.
If you are a first-time contributor, please add yourself to `AUTHORS.md` as well.

Filing bugs
-----------
We use Github issues to track all bugs and feature requests; feel free to
Expand Down
91 changes: 91 additions & 0 deletions docs/changelog.rst
Expand Up @@ -2,6 +2,97 @@
Changelog
*********

v0.10
=====

v0.10.0
-------
*In development*

New features

- `#1485`_ Added support for `"h"` (hours) and `"m"` (minutes) in `TimeFormatter`. *Vincent Lostanlen*
- `#1529`_ Accelerated utility functions for squared magnitude `util.abs2` and `util.phasor`. *Brian McFee*
- `#1514`_ `librosa.stft` support for pre-allocated output arrays. *Brian McFee*
- `#1533`_ Accelerated `util.localmax` and `util.localmin`. *Brian McFee*
- `#1552`_ **EXPERIMENTAL** Support for just-intonation based variable-Q transforms and functional just system (FJS) notation. *Brian McFee*
- `#1579`_ Imports are now done lazily, significantly reducing startup time. It is not longer necessary to explicitly `import librosa.display`. *Brian McFee*
-

Bug fixes

- `#1560`_ Corrected an error in bandwidth estimation for window functions that take on negative sample values. *Brian McFee*
- `#1571`_ Fixed rounding error in multirate filterbank calculation of sampling rates. *Brian McFee*
- `#1594`_ Fixed incorrect use of deprecated numpy numerical types. *Mattia Di Gangi*


API changes

- `#1561`_ `librosa.resample` now supports `axis=` for all sample rate conversion backends. *Brian McFee*
- `#1572`_ Notation conversion (e.g., `midi_to_note`) now vectorizes operations, and produces `numpy.ndarray` outputs rather than `list` when given iterable inputs. *Brian McFee*


Documentation

- `#1520`_ Improved CONTRIBUTING.md documentation. *Kian Eliasi*
- `#1531`_ Updated LICENSE.md documentation. *Anton Kostin*
- `#1536`_ Added keyword argument (`kwargs`) definitions to docstrings. *Emily Halvachs*
- `#1537`_ Improvements to CONTRIBUTING.md. *Juanita Gomez*
- `#1545`_ Correction to docstring for `note_to_midi`. *Helmin Jinoz*
- `#1563`_ Improved `specshow` documentation to explain `cmap=` parameter. *Kian Eliasi*
- `#1586`_ Fixed figure layout in documentation builds. *Brian McFee*
- `#1592`_ Fixed incorrect link to the documentation badge in README. *Zvi Baratz*


Deprecations

- `#1521`_ Removed backward compatibility support for positional arguments that are now keyword-only. *Brian McFee*
- `#1577`_ Removed official support for python 3.6. *Brian McFee*


Other changes

- `#1501`_ Infer square / equal plot dimensions for compatible x/y axes. *Kian Eliasi*
- `#1535`_ Standardized integer type checks throughout the library. *Alexandre Chabot-Leclerc*
- `#1539`_ Refactored `AdaptiveWaveplot` to allow callback disconnection. *Brian McFee*
- `#1548`_ Removed deprecated `'hanning'` window specification from tests. *Brian McFee*
- `#1551`_ Removed dependency on `contextlib2`. *Steve Kowalik*
- `#1565`_ Efficiency improvements to `autocorrelate`. *Brian McFee*
- `#1566`_ Changed the default sample rate conversion method from `kaiser_best` (resampy) to `soxr_hq` (soxr). *Brian McFee*
- `#1581`_ Updated tests for numpy 1.23 compatibility. *Brian McFee*

.. _#1485: https://github.com/librosa/librosa/issues/1485
.. _#1529: https://github.com/librosa/librosa/issues/1529
.. _#1514: https://github.com/librosa/librosa/issues/1514
.. _#1533: https://github.com/librosa/librosa/issues/1533
.. _#1552: https://github.com/librosa/librosa/issues/1552
.. _#1579: https://github.com/librosa/librosa/issues/1579
.. _#1560: https://github.com/librosa/librosa/issues/1560
.. _#1571: https://github.com/librosa/librosa/issues/1571
.. _#1594: https://github.com/librosa/librosa/issues/1594
.. _#1561: https://github.com/librosa/librosa/issues/1561
.. _#1572: https://github.com/librosa/librosa/issues/1572
.. _#1520: https://github.com/librosa/librosa/issues/1520
.. _#1531: https://github.com/librosa/librosa/issues/1531
.. _#1536: https://github.com/librosa/librosa/issues/1536
.. _#1537: https://github.com/librosa/librosa/issues/1537
.. _#1545: https://github.com/librosa/librosa/issues/1545
.. _#1563: https://github.com/librosa/librosa/issues/1563
.. _#1586: https://github.com/librosa/librosa/issues/1586
.. _#1592: https://github.com/librosa/librosa/issues/1592
.. _#1521: https://github.com/librosa/librosa/issues/1521
.. _#1577: https://github.com/librosa/librosa/issues/1577
.. _#1501: https://github.com/librosa/librosa/issues/1501
.. _#1535: https://github.com/librosa/librosa/issues/1535
.. _#1539: https://github.com/librosa/librosa/issues/1539
.. _#1548: https://github.com/librosa/librosa/issues/1548
.. _#1551: https://github.com/librosa/librosa/issues/1551
.. _#1565: https://github.com/librosa/librosa/issues/1565
.. _#1566: https://github.com/librosa/librosa/issues/1566
.. _#1581: https://github.com/librosa/librosa/issues/1581



v0.9
====

Expand Down
7 changes: 7 additions & 0 deletions docs/examples/plot_vocal_separation.py
Expand Up @@ -7,6 +7,13 @@
This notebook demonstrates a simple technique for separating vocals (and
other sporadic foreground signals) from accompanying instrumentation.
.. warning::
This example is primarily of historical interest, and we do not recommend
this as a competitive method for vocal source separation.
For a more recent treatment of vocal and music source separation, please
refer to `Open Source Tools & Data for Music Source Separation <https://source-separation.github.io/tutorial/landing.html>`_
(Manilow, Seetharaman, and Salamon 2020).
This is based on the "REPET-SIM" method of `Rafii and Pardo, 2012
<http://www.cs.northwestern.edu/~zra446/doc/Rafii-Pardo%20-%20Music-Voice%20Separation%20using%20the%20Similarity%20Matrix%20-%20ISMIR%202012.pdf>`_, but includes a couple of modifications and extensions:
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Expand Up @@ -62,7 +62,7 @@ python_requires = >=3.7
[options.package_data]
librosa =
util/example_data/*
core/intervals.pickle
core/intervals.msgpack

[options.extras_require]
docs =
Expand Down

0 comments on commit 5dce3f3

Please sign in to comment.