vocalpy.examples.ExampleData

class vocalpy.examples.ExampleData(**kwargs)

Bases: dict

A dict-like container for example data.

Returned by vocalpy.example() for any example that is more than a single file. The ExampleData class extends dict by enabling values to be accessed by key, example["data"], or by attribute with dot notation, example.data.

Methods

clear(/)	Remove all items from the dict.
copy(/)	Return a shallow copy of the dict.
fromkeys(iterable[, value])	Create a new dictionary with keys from iterable and values set to value.
get(key[, default])	Return the value for key if key is in the dictionary, else default.
items(/)	Return a set-like object providing a view on the dict's items.
keys(/)	Return a set-like object providing a view on the dict's keys.
pop(key[, default])	If the key is not found, return the default if given; otherwise, raise a KeyError.
popitem(/)	Remove and return a (key, value) pair as a 2-tuple.
setdefault(key[, default])	Insert key with a value of default if key is not in the dictionary.
update([E, ]**F)	If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
values(/)	Return an object providing a view on the dict's values.

Notes

Adapted from the scikit-learn Bunch class: scikit-learn/scikit-learn

Examples

>>> from vocalpy.examples import ExampleData
>>> bells = voc.example("bells.wav")
>>> samba = voc.example("samba.wav")
>>> zb_examples = ExampleData(bells=bells, samba=samba)
>>> zb_examples["bells"]
vocalpy.Sound(data=array([[-6.10...0000000e+00]]), samplerate=44100)
>>> zb_examples.samba
vocalpy.Sound(data=array([[0.003... 0.        ]]), samplerate=44100)
>>> zb_examples.flashcam = voc.example("flashcam.wav")
>>> zb_examples["flashcam"]
vocalpy.Sound(data=array([[0.000...5527344e-05]]), samplerate=44100)

__init__(**kwargs)

Methods

__init__(**kwargs)
clear(/)	Remove all items from the dict.
copy(/)	Return a shallow copy of the dict.
fromkeys(iterable[, value])	Create a new dictionary with keys from iterable and values set to value.
get(key[, default])	Return the value for key if key is in the dictionary, else default.
items(/)	Return a set-like object providing a view on the dict's items.
keys(/)	Return a set-like object providing a view on the dict's keys.
pop(key[, default])	If the key is not found, return the default if given; otherwise, raise a KeyError.
popitem(/)	Remove and return a (key, value) pair as a 2-tuple.
setdefault(key[, default])	Insert key with a value of default if key is not in the dictionary.
update([E, ]**F)	If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
values(/)	Return an object providing a view on the dict's values.

clear(/)

Remove all items from the dict.

copy(/)

Return a shallow copy of the dict.

classmethod fromkeys(iterable, value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items(/)

Return a set-like object providing a view on the dict’s items.

keys(/)

Return a set-like object providing a view on the dict’s keys.

pop(key, default=<unrepresentable>, /)

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem(/)

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None.  Update D from mapping/iterable E and F.

If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values(/)

Return an object providing a view on the dict’s values.