Confusing meaning of the attribute arguments
Several ketos functions use the term attributes. However, this term is being used in two different ways, and leads to confusion.
The first way it is being used (and more commonly), is as "extra columns" that may be optionally passed to a hdf5 database.
This can be seen in functions such as create_database with include_attrs
and attrs
parameter and internal functions such as get_instance_attrs
which retrieves these extra columns from the object.
The second and less common way is as hdf5 table attributes described in write_repres_attrs
Writes the audio representation attributes into the HDF5 database, where they become stored as table attributes.
More reading on this can be found on pytables docs.
This becomes very confusing quickly because i am never sure if attrs means hdf5 table attributes or simply extra columns.
I would propose we separate these 2 terms to be more accurate. My solution would be to have attrs be hdf5 table attributes, and rename the other occurrences of attribute such as in the create_database function to "extra_columns" or something along these lines.