update docs

libAudioFlux · Dec 16, 2023 · ef8447a · ef8447a
1 parent 96aa94b
commit ef8447a
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 4 deletions.
diff --git a/conda/meta.yaml b/conda/meta.yaml
@@ -1,4 +1,4 @@
-{% set version = "0.1.6" %}
+{% set version = "0.1.7" %}
 
 package:
   name: audioflux

diff --git a/docs/feature/cepstrogram.rst b/docs/feature/cepstrogram.rst
@@ -0,0 +1,5 @@
+Cepstrogram
+===========
+
+.. autoclass:: audioflux.Cepstrogram
+   :members:
diff --git a/docs/feature/feature.rst b/docs/feature/feature.rst
@@ -9,6 +9,7 @@ The feature module contains the following algorithms:
     spectral
     xxcc
     deconv
+    cepstrogram
     temporal
     featureExtractor
 

diff --git a/docs/mir/pitch.rst b/docs/mir/pitch.rst
@@ -1,5 +1,23 @@
 Pitch
 =====
 
-.. autoclass:: audioflux.Pitch
+.. autoclass:: audioflux.PitchCEP
+   :members:
+
+.. autoclass:: audioflux.PitchHPS
+   :members:
+
+.. autoclass:: audioflux.PitchLHS
+   :members:
+
+.. autoclass:: audioflux.PitchNCF
+   :members:
+
+.. autoclass:: audioflux.PitchPEF
+   :members:
+
+.. autoclass:: audioflux.PitchSTFT
+   :members:
+
+.. autoclass:: audioflux.PitchYIN
    :members:
diff --git a/python/audioflux/mir/pitch_stft.py b/python/audioflux/mir/pitch_stft.py
@@ -49,7 +49,7 @@ class PitchSTFT(Base):
     Extract pitch
 
     >>> pitch_obj = af.PitchSTFT(samplate=sr)
-    >>> fre_arr = pitch_obj.pitch(audio_arr)
+    >>> fre_arr, db_arr = pitch_obj.pitch(audio_arr)
 
     Show pitch plot
 

diff --git a/python/audioflux/mir/pitch_yin.py b/python/audioflux/mir/pitch_yin.py
@@ -46,7 +46,7 @@ class PitchYIN(Base):
     Extract pitch
 
     >>> pitch_obj = af.PitchYIN(samplate=sr)
-    >>> fre_arr = pitch_obj.pitch(audio_arr)
+    >>> fre_arr, v1_arr, v2_arr = pitch_obj.pitch(audio_arr)
 
     Show pitch plot