updating version info, docstrings

bmcfee · Apr 26, 2017 · 9f79bca · 9f79bca
1 parent f29b0d5
commit 9f79bca
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -40,11 +40,15 @@ be easily consumed by statistical algorithms.  Some desired features:
 >>> p_chord = pumpp.task.SimpleChordTransformer(sr=sr, hop_length=hop_length)
 
 >>> # Collect the operators in a pump
->>> P = pumpp.Pump(p_cqt, p_beat, p_chord)
+>>> pump = pumpp.Pump(p_cqt, p_beat, p_chord)
 
 >>> # Apply the extractors to generate training data
->>> data = P.transform(audio_f, jams_f)
+>>> data = pump(audio_f=audio_f, jam=jams_fjams_f)
 
 >>> # Or test data
->>> test_data = P.transform('/my/test/audio.ogg')
+>>> test_data = pump(audio_f='/my/test/audio.ogg')
+
+>>> # Or in-memory
+>>> y, sr = librosa.load(audio_f)
+>>> test_data = pump(y=y, sr=sr)
 ```
diff --git a/pumpp/sampler.py b/pumpp/sampler.py
@@ -97,7 +97,7 @@ def sample(self, data, interval):
         Parameters
         ----------
         data : dict
-            A data dict as produced by pumpp.transform
+            A data dict as produced by pumpp.Pump.transform
 
         interval : slice
             The time interval to sample

diff --git a/pumpp/version.py b/pumpp/version.py
@@ -2,5 +2,5 @@
 # -*- coding: utf-8 -*-
 """Version info"""
 
-short_version = '0.1'
-version = '0.1.5'
+short_version = '0.2'
+version = '0.2.0'