audinterface


Nameaudinterface JSON
Version 0.6.8 PyPI version JSON
download
home_pagehttps://github.com/audeering/audinterface/
SummaryGeneric interfaces for signal processing
upload_time2021-07-06 09:07:03
maintainer
docs_urlNone
authorJohannes Wagner, Hagen Wierstorf, Andreas Triantafyllopoulos
requires_python
licenseMIT
keywords dsp audio machine learning
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ============
audinterface
============

|tests| |coverage| |docs| |python-versions| |license|

Generic interfaces for signal processing.


.. badges images and links:
.. |tests| image:: https://github.com/audeering/audinterface/workflows/Test/badge.svg
    :target: https://github.com/audeering/audinterface/actions?query=workflow%3ATest
    :alt: Test status
.. |coverage| image:: https://codecov.io/gh/audeering/audinterface/branch/master/graph/badge.svg?token=dNAlTQNVBt
    :target: https://codecov.io/gh/audeering/audinterface/
    :alt: code coverage
.. |docs| image:: https://img.shields.io/pypi/v/audinterface?label=docs
    :target: https://audeering.github.io/audinterface/
    :alt: audinterface's documentation
.. |license| image:: https://img.shields.io/badge/license-MIT-green.svg
    :target: https://github.com/audeering/audinterface/blob/master/LICENSE
    :alt: audinterface's MIT license
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/audinterface.svg
    :target: https://pypi.org/project/audinterface/
    :alt: audinterfaces's supported Python versions

Changelog
=========

All notable changes to this project will be documented in this file.

The format is based on `Keep a Changelog`_,
and this project adheres to `Semantic Versioning`_.


Version 0.6.8 (2021-07-06)
--------------------------

* Fixed: CHANGELOG

Version 0.6.7 (2021-07-06)
--------------------------

* Added: ``utils.signal_index()`` to create a segmented index without file level
* Changed: use keyword argument with ``pandas.MultiIndex.set_levels()``
* Fixed: raise error if multiple frames are returned but ``win_dur`` is not set
* Fixed: remove ``num_channels`` from ``Feature`` docstring


Version 0.6.6 (2021-06-18)
--------------------------

* Added: tests on Windows and macOC


Version 0.6.5 (2021-06-08)
--------------------------

* Added: ``root`` argument to all functions processing file input


Version 0.6.4 (2021-06-07)
--------------------------

* Fixed: avoid using 'sec' as unit in ``pd.to_timedelta()`` for backward compatibility


Version 0.6.3 (2021-05-03)
--------------------------

* Fixed: empty API section in documentation


Version 0.6.2 (2021-04-28)
--------------------------

* Added: open source release on Github
* Changed: switch to MIT license


Version 0.6.1 (2021-04-16)
--------------------------

* Fixed: ``Process``, ``Feature``: do not apply segmentation twice when ``segment`` object is given


Version 0.6.0 (2021-04-15)
--------------------------

* Added: ``invert`` argument to ``Segment``
* Added: ``Segment.process_index()`` and ``Segment.process_signal_from_index()``
* Changed: ``Process.process_index()`` and ``Process.process_signal_from_index()`` do not ignore segment object
* Changed: ``Feature.process_index()`` and ``Feature.process_signal_from_index()`` do not ignore segment object


Version 0.5.5 (2021-02-17)
--------------------------

* Fixed: PyPI publishing pipeline
* Changed: use new tokenizer in CI pipeline


Version 0.5.4 (2021-02-17)
--------------------------

* Added: support for providing ``start`` and ``end`` time values
  in the same format as done in ``audformat``,
  e.g. as integer, floats, or ``pandas.Timedelta``
* Changed: improve speed of CI pipelines
* Fixed: ``audinterface.Feature`` handles empty index


Version 0.5.3 (2021-01-07)
--------------------------

* Changed: rename
  ``audinterface.Feature.process_unified_format_index``,
  ``audinterface.Process.process_unified_format_index``,
  ``audinterface.ProcessWithContext.process_unified_format_index``
  to
  ``audinterface.Feature.process_index``,
  ``audinterface.Process.process_index``,
  ``audinterface.ProcessWithContext.process_index``


Version 0.5.2 (2020-12-10)
--------------------------

* Fixed: ``audinterface.Feature`` allow
  ``win_dur=None`` with ``unit='samples'``


Version 0.5.1 (2020-12-04)
--------------------------

* Changed: store ``Process.channels`` always as a list
* Changed: keep ``Feature.win_dur`` and ``Feature.hop_dur`` in original format


Version 0.5.0 (2020-12-03)
--------------------------

* Added: arguments ``channels`` and ``mixdown`` to
  ``audinterface.Process``,
  ``audinterface.ProcessWithContext``,
  ``audinterface.Feature``,
  ``audinterface.Segment``
* Removed: ``channel`` argument from all ``process_*`` functions


Version 0.4.3 (2020-11-24)
--------------------------

* Fixed: ``audinterface.Feature.__call__``
  always returns ``numpy.ndarray``


Version 0.4.2 (2020-11-23)
--------------------------

* Changed: ``audinterface.Process.process_unified_format_index`` and
  ``audinterface.Feature.process_unified_format_index``
  support filewise index


Version 0.4.1 (2020-11-20)
--------------------------

* Added: ``process_func_is_mono`` argument to
  ``audinterface.Feature``,
  ``audinterface.Process``
* Fixed: avoid nested progress bars


Version 0.4.0 (2020-10-21)
--------------------------

* Changed: make
  ``audinterface.Feature``,
  ``audinterface.Process``,
  ``audinterface.ProcessWithContext``,
  ``audinterface.Segment``,
  callable
* Changed: use ``name`` and ``params`` arguments
  in ``audinterface.Feature``


Version 0.3.2 (2020-09-21)
--------------------------

* Changed: switch to ``audeer.run_tasks``
* Changed: cut signal before resampling is applied


Version 0.3.1 (2020-09-18)
--------------------------

* Fixed: ``audinterface.Feature`` raises an due to missing sampling rate
  now only if ``win_dur`` is given


Version 0.3.0 (2020-08-07)
--------------------------

* Changed: switch to ``audsp`` >=0.9.2, which fixes a critical resampling
  issue and introduces a new keyword arg name


Version 0.2.4 (2020-06-12)
--------------------------

* Fixed: description and keywords of package in ``setup.cfg``


Version 0.2.3 (2020-06-11)
--------------------------

* Fixed: syntax error in CHANGELOG


Version 0.2.2 (2020-06-11)
--------------------------

* Fixed: ``audinterface.Process.process_file`` was changing end times
  when process a segmented index


Version 0.2.1 (2020-06-10)
--------------------------

* Changed: ``utils.check_index`` ignores ``datetime``


Version 0.2.0 (2020-06-10)
--------------------------

* Added: ``segment`` argument to ``audinterface.Process`` and ``audinterface.Feature``
* Removed: ``name`` argument from ``audinterface.Feature``


Version 0.1.0 (2020-06-05)
--------------------------

* Added: initial release


.. _Keep a Changelog:
    https://keepachangelog.com/en/1.0.0/
.. _Semantic Versioning:
    https://semver.org/spec/v2.0.0.html



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/audeering/audinterface/",
    "name": "audinterface",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "dsp,audio,machine learning",
    "author": "Johannes Wagner, Hagen Wierstorf, Andreas Triantafyllopoulos",
    "author_email": "jwagner@audeering.com, hwierstorf@audeering.com, atriant@audeering.com",
    "download_url": "https://files.pythonhosted.org/packages/14/15/12e5c52fb160340cfcdd4782b211d7fa552bc083dce095cec7e79c84c35c/audinterface-0.6.8.tar.gz",
    "platform": "any",
    "description": "============\naudinterface\n============\n\n|tests| |coverage| |docs| |python-versions| |license|\n\nGeneric interfaces for signal processing.\n\n\n.. badges images and links:\n.. |tests| image:: https://github.com/audeering/audinterface/workflows/Test/badge.svg\n    :target: https://github.com/audeering/audinterface/actions?query=workflow%3ATest\n    :alt: Test status\n.. |coverage| image:: https://codecov.io/gh/audeering/audinterface/branch/master/graph/badge.svg?token=dNAlTQNVBt\n    :target: https://codecov.io/gh/audeering/audinterface/\n    :alt: code coverage\n.. |docs| image:: https://img.shields.io/pypi/v/audinterface?label=docs\n    :target: https://audeering.github.io/audinterface/\n    :alt: audinterface's documentation\n.. |license| image:: https://img.shields.io/badge/license-MIT-green.svg\n    :target: https://github.com/audeering/audinterface/blob/master/LICENSE\n    :alt: audinterface's MIT license\n.. |python-versions| image:: https://img.shields.io/pypi/pyversions/audinterface.svg\n    :target: https://pypi.org/project/audinterface/\n    :alt: audinterfaces's supported Python versions\n\nChangelog\n=========\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on `Keep a Changelog`_,\nand this project adheres to `Semantic Versioning`_.\n\n\nVersion 0.6.8 (2021-07-06)\n--------------------------\n\n* Fixed: CHANGELOG\n\nVersion 0.6.7 (2021-07-06)\n--------------------------\n\n* Added: ``utils.signal_index()`` to create a segmented index without file level\n* Changed: use keyword argument with ``pandas.MultiIndex.set_levels()``\n* Fixed: raise error if multiple frames are returned but ``win_dur`` is not set\n* Fixed: remove ``num_channels`` from ``Feature`` docstring\n\n\nVersion 0.6.6 (2021-06-18)\n--------------------------\n\n* Added: tests on Windows and macOC\n\n\nVersion 0.6.5 (2021-06-08)\n--------------------------\n\n* Added: ``root`` argument to all functions processing file input\n\n\nVersion 0.6.4 (2021-06-07)\n--------------------------\n\n* Fixed: avoid using 'sec' as unit in ``pd.to_timedelta()`` for backward compatibility\n\n\nVersion 0.6.3 (2021-05-03)\n--------------------------\n\n* Fixed: empty API section in documentation\n\n\nVersion 0.6.2 (2021-04-28)\n--------------------------\n\n* Added: open source release on Github\n* Changed: switch to MIT license\n\n\nVersion 0.6.1 (2021-04-16)\n--------------------------\n\n* Fixed: ``Process``, ``Feature``: do not apply segmentation twice when ``segment`` object is given\n\n\nVersion 0.6.0 (2021-04-15)\n--------------------------\n\n* Added: ``invert`` argument to ``Segment``\n* Added: ``Segment.process_index()`` and ``Segment.process_signal_from_index()``\n* Changed: ``Process.process_index()`` and ``Process.process_signal_from_index()`` do not ignore segment object\n* Changed: ``Feature.process_index()`` and ``Feature.process_signal_from_index()`` do not ignore segment object\n\n\nVersion 0.5.5 (2021-02-17)\n--------------------------\n\n* Fixed: PyPI publishing pipeline\n* Changed: use new tokenizer in CI pipeline\n\n\nVersion 0.5.4 (2021-02-17)\n--------------------------\n\n* Added: support for providing ``start`` and ``end`` time values\n  in the same format as done in ``audformat``,\n  e.g. as integer, floats, or ``pandas.Timedelta``\n* Changed: improve speed of CI pipelines\n* Fixed: ``audinterface.Feature`` handles empty index\n\n\nVersion 0.5.3 (2021-01-07)\n--------------------------\n\n* Changed: rename\n  ``audinterface.Feature.process_unified_format_index``,\n  ``audinterface.Process.process_unified_format_index``,\n  ``audinterface.ProcessWithContext.process_unified_format_index``\n  to\n  ``audinterface.Feature.process_index``,\n  ``audinterface.Process.process_index``,\n  ``audinterface.ProcessWithContext.process_index``\n\n\nVersion 0.5.2 (2020-12-10)\n--------------------------\n\n* Fixed: ``audinterface.Feature`` allow\n  ``win_dur=None`` with ``unit='samples'``\n\n\nVersion 0.5.1 (2020-12-04)\n--------------------------\n\n* Changed: store ``Process.channels`` always as a list\n* Changed: keep ``Feature.win_dur`` and ``Feature.hop_dur`` in original format\n\n\nVersion 0.5.0 (2020-12-03)\n--------------------------\n\n* Added: arguments ``channels`` and ``mixdown`` to\n  ``audinterface.Process``,\n  ``audinterface.ProcessWithContext``,\n  ``audinterface.Feature``,\n  ``audinterface.Segment``\n* Removed: ``channel`` argument from all ``process_*`` functions\n\n\nVersion 0.4.3 (2020-11-24)\n--------------------------\n\n* Fixed: ``audinterface.Feature.__call__``\n  always returns ``numpy.ndarray``\n\n\nVersion 0.4.2 (2020-11-23)\n--------------------------\n\n* Changed: ``audinterface.Process.process_unified_format_index`` and\n  ``audinterface.Feature.process_unified_format_index``\n  support filewise index\n\n\nVersion 0.4.1 (2020-11-20)\n--------------------------\n\n* Added: ``process_func_is_mono`` argument to\n  ``audinterface.Feature``,\n  ``audinterface.Process``\n* Fixed: avoid nested progress bars\n\n\nVersion 0.4.0 (2020-10-21)\n--------------------------\n\n* Changed: make\n  ``audinterface.Feature``,\n  ``audinterface.Process``,\n  ``audinterface.ProcessWithContext``,\n  ``audinterface.Segment``,\n  callable\n* Changed: use ``name`` and ``params`` arguments\n  in ``audinterface.Feature``\n\n\nVersion 0.3.2 (2020-09-21)\n--------------------------\n\n* Changed: switch to ``audeer.run_tasks``\n* Changed: cut signal before resampling is applied\n\n\nVersion 0.3.1 (2020-09-18)\n--------------------------\n\n* Fixed: ``audinterface.Feature`` raises an due to missing sampling rate\n  now only if ``win_dur`` is given\n\n\nVersion 0.3.0 (2020-08-07)\n--------------------------\n\n* Changed: switch to ``audsp`` >=0.9.2, which fixes a critical resampling\n  issue and introduces a new keyword arg name\n\n\nVersion 0.2.4 (2020-06-12)\n--------------------------\n\n* Fixed: description and keywords of package in ``setup.cfg``\n\n\nVersion 0.2.3 (2020-06-11)\n--------------------------\n\n* Fixed: syntax error in CHANGELOG\n\n\nVersion 0.2.2 (2020-06-11)\n--------------------------\n\n* Fixed: ``audinterface.Process.process_file`` was changing end times\n  when process a segmented index\n\n\nVersion 0.2.1 (2020-06-10)\n--------------------------\n\n* Changed: ``utils.check_index`` ignores ``datetime``\n\n\nVersion 0.2.0 (2020-06-10)\n--------------------------\n\n* Added: ``segment`` argument to ``audinterface.Process`` and ``audinterface.Feature``\n* Removed: ``name`` argument from ``audinterface.Feature``\n\n\nVersion 0.1.0 (2020-06-05)\n--------------------------\n\n* Added: initial release\n\n\n.. _Keep a Changelog:\n    https://keepachangelog.com/en/1.0.0/\n.. _Semantic Versioning:\n    https://semver.org/spec/v2.0.0.html\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Generic interfaces for signal processing",
    "version": "0.6.8",
    "split_keywords": [
        "dsp",
        "audio",
        "machine learning"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "2038232a1e5026ec931ab773f3fd7d46",
                "sha256": "e5a0ae648e2df7651494309ce59d75b0fca90ad74dfd926d743eb371708ce943"
            },
            "downloads": -1,
            "filename": "audinterface-0.6.8-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2038232a1e5026ec931ab773f3fd7d46",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 20835,
            "upload_time": "2021-07-06T09:07:02",
            "upload_time_iso_8601": "2021-07-06T09:07:02.686137Z",
            "url": "https://files.pythonhosted.org/packages/d4/e1/7d137eba4ab5a6db95063339109efa74d208f7731bcec5e873f80051c4be/audinterface-0.6.8-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "f6e9075d4cf61af8cbcb6204cc3b50f0",
                "sha256": "d5591dc75679720d8e573a9ae0f13728a3043e6e9bbe31b1516f6cc531988267"
            },
            "downloads": -1,
            "filename": "audinterface-0.6.8.tar.gz",
            "has_sig": false,
            "md5_digest": "f6e9075d4cf61af8cbcb6204cc3b50f0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 40816,
            "upload_time": "2021-07-06T09:07:03",
            "upload_time_iso_8601": "2021-07-06T09:07:03.757623Z",
            "url": "https://files.pythonhosted.org/packages/14/15/12e5c52fb160340cfcdd4782b211d7fa552bc083dce095cec7e79c84c35c/audinterface-0.6.8.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-07-06 09:07:03",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "audeering",
    "github_project": "audinterface",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "audinterface"
}
        
Elapsed time: 0.30269s