auglib


Nameauglib JSON
Version 1.0.2 PyPI version JSON
download
home_page
SummaryAudio augmentations
upload_time2024-01-30 07:07:15
maintainer
docs_urlNone
authorJohannes Wagner, Andrea Crespi, Andreas Triantafyllopoulos, BahaEddine Abrougui
requires_python
licenseMIT License Copyright (c) 2019- audEERING GmbH and Contributors Authors: Hagen Wierstorf Johannes Wagner Anna Derington Andrea Crespi Andreas Triantafyllopoulos BahaEddine Abrougui Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords audio data tools data augmentation machine learning
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ======
auglib
======

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

**auglib** is an augmentation library,
which provides transforms_
to modify audio signals_ and files_.

.. code-block:: python

    import auglib

    transform = auglib.transform.PinkNoise()
    augment = auglib.Augment(transform)
    augment(signal, sampling_rate)

**auglib** can further augment whole datasets_
while caching the results.
It can be easily extended
with external_ or `user defined`_ augmentations.

Have a look at the installation_ instructions
and listen to examples_.


.. _datasets: https://audeering.github.io/usage.html#augment-a-database-to-disk
.. _examples: https://audeering.github.io/examples.html
.. _external: https://audeering.github.io/external.html
.. _files: https://audeering.github.io/usage.html#augment-files-in-memory
.. _installation: https://audeering.github.io/install.html
.. _signals: https://audeering.github.io/usage.html#augment-a-signal
.. _transforms: https://audeering.github.io/api/auglib.transform.html
.. _usage: https://audeering.github.io/usage.html
.. _user defined: https://audeering.github.io/api/auglib.transform.Function.html


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

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "auglib",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "audio,data,tools,data augmentation,machine learning",
    "author": "Johannes Wagner, Andrea Crespi, Andreas Triantafyllopoulos, BahaEddine Abrougui",
    "author_email": "Hagen Wierstorf <hwierstorf@audeering.com>, Anna Derington <aderington@audeering.com>",
    "download_url": "https://files.pythonhosted.org/packages/30/60/9e8666e4538a884d018769bf5c601e6f642bece9163f7af75016bef24f41/auglib-1.0.2.tar.gz",
    "platform": null,
    "description": "======\nauglib\n======\n\n|tests| |coverage| |docs| |python-versions| |license|\n\n**auglib** is an augmentation library,\nwhich provides transforms_\nto modify audio signals_ and files_.\n\n.. code-block:: python\n\n    import auglib\n\n    transform = auglib.transform.PinkNoise()\n    augment = auglib.Augment(transform)\n    augment(signal, sampling_rate)\n\n**auglib** can further augment whole datasets_\nwhile caching the results.\nIt can be easily extended\nwith external_ or `user defined`_ augmentations.\n\nHave a look at the installation_ instructions\nand listen to examples_.\n\n\n.. _datasets: https://audeering.github.io/usage.html#augment-a-database-to-disk\n.. _examples: https://audeering.github.io/examples.html\n.. _external: https://audeering.github.io/external.html\n.. _files: https://audeering.github.io/usage.html#augment-files-in-memory\n.. _installation: https://audeering.github.io/install.html\n.. _signals: https://audeering.github.io/usage.html#augment-a-signal\n.. _transforms: https://audeering.github.io/api/auglib.transform.html\n.. _usage: https://audeering.github.io/usage.html\n.. _user defined: https://audeering.github.io/api/auglib.transform.Function.html\n\n\n.. badges images and links:\n.. |tests| image:: https://github.com/audeering/auglib/workflows/Test/badge.svg\n    :target: https://github.com/audeering/auglib/actions?query=workflow%3ATest\n    :alt: Test status\n.. |coverage| image:: https://codecov.io/gh/audeering/auglib/branch/main/graph/badge.svg?token=3J0sF7GQhA\n    :target: https://codecov.io/gh/audeering/auglib/\n    :alt: code coverage\n.. |docs| image:: https://img.shields.io/pypi/v/auglib?label=docs\n    :target: https://audeering.github.io/auglib/\n    :alt: auglib's documentation\n.. |license| image:: https://img.shields.io/badge/license-MIT-green.svg\n    :target: https://github.com/audeering/auglib/blob/main/LICENSE\n    :alt: auglib's MIT license\n.. |python-versions| image:: https://img.shields.io/pypi/pyversions/auglib.svg\n    :target: https://pypi.org/project/auglib/\n    :alt: auglib's supported Python versions\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2019- audEERING GmbH and Contributors  Authors: Hagen Wierstorf Johannes Wagner Anna Derington Andrea Crespi Andreas Triantafyllopoulos BahaEddine Abrougui  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Audio augmentations",
    "version": "1.0.2",
    "project_urls": {
        "documentation": "https://audeering.github.io/auglib/",
        "repository": "https://github.com/audeering/auglib/"
    },
    "split_keywords": [
        "audio",
        "data",
        "tools",
        "data augmentation",
        "machine learning"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "44088a76455825d60d7224ede984a8a64f188a5de2ffd9e3c23f72b36578a178",
                "md5": "b4b1835b45e61bdd90ab6609cab5dbe7",
                "sha256": "39c39bed214d7efc261fc134f20c8f8189b6853e798419e912647a901d555458"
            },
            "downloads": -1,
            "filename": "auglib-1.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b4b1835b45e61bdd90ab6609cab5dbe7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 708517,
            "upload_time": "2024-01-30T07:07:13",
            "upload_time_iso_8601": "2024-01-30T07:07:13.330210Z",
            "url": "https://files.pythonhosted.org/packages/44/08/8a76455825d60d7224ede984a8a64f188a5de2ffd9e3c23f72b36578a178/auglib-1.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "30609e8666e4538a884d018769bf5c601e6f642bece9163f7af75016bef24f41",
                "md5": "dc5baa096d6425e0a048c01768b93b90",
                "sha256": "3d24ae3f9e1cbb36727d1282100679f22877ca0edb667c2144a8bc8c7afa109c"
            },
            "downloads": -1,
            "filename": "auglib-1.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "dc5baa096d6425e0a048c01768b93b90",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 895795,
            "upload_time": "2024-01-30T07:07:15",
            "upload_time_iso_8601": "2024-01-30T07:07:15.686346Z",
            "url": "https://files.pythonhosted.org/packages/30/60/9e8666e4538a884d018769bf5c601e6f642bece9163f7af75016bef24f41/auglib-1.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-30 07:07:15",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "audeering",
    "github_project": "auglib",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "auglib"
}
        
Elapsed time: 0.16718s