Mercurial > hg > vampy-host
changeset 132:f798cda1007f
Another minor doc update
| author | Chris Cannam |
|---|---|
| date | Wed, 24 Jun 2015 16:30:22 +0100 |
| parents | 774abff99d98 |
| children | 58a2272d0046 |
| files | README.rst setup.py vamp/__init__.py |
| diffstat | 3 files changed, 16 insertions(+), 11 deletions(-) [+] |
line wrap: on
line diff
--- a/README.rst Wed Jun 24 16:16:22 2015 +0100 +++ b/README.rst Wed Jun 24 16:30:22 2015 +0100 @@ -30,7 +30,6 @@ (https://code.soundsoftware.ac.uk/projects/nnls-chroma/) for analysis:: - $ python >>> import vamp >>> import librosa >>> data, rate = librosa.load("example.wav") @@ -63,7 +62,8 @@ This module contains three sorts of function: - 1. Basic info and lookup functions: +1. Basic info and lookup functions +"""""""""""""""""""""""""""""""""" * ``vamp.list_plugins`` * ``vamp.get_outputs_of`` @@ -73,7 +73,8 @@ about each plugin. (For more detailed information, load a plugin and inspect it using the low-level interface described below.) - 2. Process functions: +2. Process functions +"""""""""""""""""""" * ``vamp.process_audio`` * ``vamp.process_frames`` @@ -91,8 +92,9 @@ plugin's preferred step and block sizes. The ``_frames`` versions instead accept an enumerable sequence of audio frame arrays. - 3. The process-and-collect function: - +3. The process-and-collect function +""""""""""""""""""""""""""""""""""" + * ``vamp.collect`` This accepts a single array of audio samples as input, and returns
--- a/setup.py Wed Jun 24 16:16:22 2015 +0100 +++ b/setup.py Wed Jun 24 16:30:22 2015 +0100 @@ -34,8 +34,8 @@ packages = find_packages(exclude = [ '*test*' ]), ext_modules = [ vampyhost ], requires = [ 'numpy' ], - author = [ 'Chris Cannam' ], - author_email = [ 'cannam@all-day-breakfast.com' ], + author = 'Chris Cannam, George Fazekas', + author_email = 'cannam@all-day-breakfast.com', classifiers = [ 'Development Status :: 4 - Beta', 'Intended Audience :: Science/Research',
--- a/vamp/__init__.py Wed Jun 24 16:16:22 2015 +0100 +++ b/vamp/__init__.py Wed Jun 24 16:30:22 2015 +0100 @@ -92,7 +92,8 @@ This module contains three sorts of function: - 1. Basic info and lookup functions: +1. Basic info and lookup functions +"""""""""""""""""""""""""""""""""" * ``vamp.list_plugins`` * ``vamp.get_outputs_of`` @@ -102,7 +103,8 @@ about each plugin. (For more detailed information, load a plugin and inspect it using the low-level interface described below.) - 2. Process functions: +2. Process functions +"""""""""""""""""""" * ``vamp.process_audio`` * ``vamp.process_frames`` @@ -120,8 +122,9 @@ plugin's preferred step and block sizes. The ``_frames`` versions instead accept an enumerable sequence of audio frame arrays. - 3. The process-and-collect function: - +3. The process-and-collect function +""""""""""""""""""""""""""""""""""" + * ``vamp.collect`` This accepts a single array of audio samples as input, and returns