Skip to content

Releases: vocalpy/crowsetta

0.2.0a5

07 May 16:19
Compare
Choose a tag to compare
0.2.0a5 Pre-release
Pre-release

added

  • Sequence instances have attributes: labels, onsets_s, offsets_s, onsets_Hz,
    offsets_Hz, and file.
  • Explanation of default to_csv function for user formats in howto-user-config.

changed

  • Sequence class totally re-written
    • no longer attrs-based
    • because of somewhat complicated logic for validating arguments that
      was necessary in init (to prevent user from creating a 'bad'
      instance.)
  • Sequences are immutable. Idea is they are just connectors between
    annotation and whatever user needs to do with it so you shouldn't
    need to change any attribute values after loading annotation
  • Segment also immutable (by setting frozen=True in call to attr.s decorator)
  • Transcriber.init uses config.json instead of config.ini to read defaults
    • this makes init logic more readable since we don't have to convert
      user_config dict to strings and then back again; default config just loads as
      a dict from the .json file and we add the user_config dicts to it

0.2.0a4

07 May 16:18
Compare
Choose a tag to compare
0.2.0a4 Pre-release
Pre-release

added

  • data module that downloads small example datasets for each annotation format
    • includes formats function that is imported at package level
      and prints formats built in to crowsetta
  • to_seq_func_to_csv that takes a yourformat2seq function and returns a function
    that will convert the same format to csv files (just a wrapper around your function
    and seq2csv)
  • for docs, Makefile that generates ./notebooks folder from ./doc/notebooks

changed

  • major revamp of docs
  • config_dicts for user_config arg of Transcriber.init only require
    module and to_seq keys; to_csv and to_format are optional, can be
    specified Python None or a string 'None'

fixed

  • Transcriber raises NotImplemented error when to_csv or to_format are
    None for a specified format (instead of crashing mysteriously)
  • seq2csv and csv2seq can deal with None values for one pair of onsets and offsets

0.2.0a3

26 Dec 17:00
Compare
Choose a tag to compare
0.2.0a3 Pre-release
Pre-release

changed

  • fix failing tests

0.2.0a2

26 Dec 16:45
Compare
Choose a tag to compare
0.2.0a2 Pre-release
Pre-release

added

  • Segment class, attrs-based
    • has asdict method (wrapper around attrs function)
    • has class variable _FIELDS which is used in any place
      where we need to know how to go from Segment attributes to rows of
      a csv file, e.g. in src/crowsetta/csv.py and in tests

changed

  • Sequence class is now attrs-based, has factory functions, is itself
    just a list of Segments
    • now has to_dict method
  • Crowsetta class is now called Transcriber

0.2.0a1

23 Dec 20:26
Compare
Choose a tag to compare
0.2.0a1 Pre-release
Pre-release

added

  • add Crowsetta class with simple interface for converting any annotation to
  • add ability to work with user-defined functions
    • user passes an extra_config dict when instantiating Crowsetta
  • add docs

changed

  • change package name to Crowsetta
  • change function names so they are all format2seq or format2csv or
    toformat for consistency