audmodel 1.3.0__tar.gz

audmodel-1.3.0/.github/workflows/doc.yml

@@ -0,0 +1,39 @@
+name: Documentation
+
+on:
+  push:
+    branches: [ main, dev ]
+  pull_request:
+    branches: [ main, dev ]
+
+jobs:
+  build:
+
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ ubuntu-latest ]
+        python-version: [ '3.10' ]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install package
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+
+      # DOCS
+    - name: Install docs requirements
+      run: pip install -r docs/requirements.txt
+
+    - name: Test building documentation
+      run: python -m sphinx docs/ docs/_build/ -b html -W
+
+    - name: Check links in documentation
+      run: python -m sphinx docs/ docs/_build/ -b linkcheck -W

audmodel-1.3.0/.github/workflows/linter.yml

@@ -0,0 +1,29 @@
+name: Linter
+
+on:
+  push:
+    branches: [ main, dev ]
+  pull_request:
+    branches: [ main, dev ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.10'
+
+    - name: Install pre-commit hooks
+      run: |
+        pip install pre-commit
+        pre-commit install --install-hooks
+
+    - name: Code style check via pre-commit
+      run: |
+        pre-commit run --all-files

audmodel-1.3.0/.github/workflows/publish.yml

@@ -0,0 +1,87 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      contents: write
+      id-token: write
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 2
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.10'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build virtualenv
+
+    # PyPI package
+    - name: Build Python package
+      run: python -m build
+
+    - name: Publish Python package to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+    # Remove apt repos that are known to break from time to time
+    # See https://github.com/actions/virtual-environments/issues/323
+    - name: Remove broken apt repos
+      run: |
+        for apt_file in `grep -lr microsoft /etc/apt/sources.list.d/`; do sudo rm $apt_file; done
+
+    # Documentation
+    - name: Install doc dependencies
+      run: |
+        sudo apt-get install --no-install-recommends --yes libsndfile1 sox
+        sudo apt-get install --yes graphviz
+        pip install -r requirements.txt
+        pip install -r docs/requirements.txt
+
+    - name: Build documentation
+      run: |
+        python -m sphinx docs/ docs/_build/ -b html
+
+    - name: Deploy documentation to Github pages
+      uses: peaceiris/actions-gh-pages@v4
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./docs/_build
+
+    # Github release
+    - name: Read CHANGELOG
+      id: changelog
+      run: |
+        # Get bullet points from last CHANGELOG entry
+        CHANGELOG=$(git diff -U0 HEAD^ HEAD | grep '^[+][\* ]' | sed 's/\+//')
+        echo "Got changelog: $CHANGELOG"
+        # Support for multiline, see
+        # https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#multiline-strings
+        {
+          echo 'body<<EOF'
+          echo "$CHANGELOG"
+          echo EOF
+        } >> "$GITHUB_OUTPUT"
+
+    - name: Create release on Github
+      id: create_release
+      uses: softprops/action-gh-release@v2
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        tag_name: ${{ github.ref }}
+        name: Release ${{ github.ref_name }}
+        body: ${{ steps.changelog.outputs.body }}

audmodel-1.3.0/.github/workflows/test.yml

@@ -0,0 +1,57 @@
+name: Test
+
+on:
+  push:
+    branches: [ main, dev ]
+  pull_request:
+    branches: [ main, dev ]
+
+jobs:
+  build:
+
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        include:
+          # Different platforms
+          - os: ubuntu-latest
+            python-version: '3.10'
+          - os: macOS-latest
+            python-version: '3.10'
+          - os: windows-latest
+            python-version: '3.10'
+          # Other Python versions
+          - os: ubuntu-latest
+            python-version: '3.9'
+          - os: ubuntu-latest
+            python-version: '3.11'
+          - os: ubuntu-latest
+            python-version: '3.12'
+          - os: ubuntu-latest
+            python-version: '3.13'
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install package
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+
+    - name: Install tests requirements
+      run: pip install -r tests/requirements.txt
+
+    - name: Test with pytest
+      run: python -m pytest
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v4
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        file: ./coverage.xml
+      if: matrix.os == 'ubuntu-latest'

audmodel-1.3.0/.gitignore

@@ -0,0 +1,11 @@
+__pycache__
+*.egg-info/
+.eggs/
+build/
+dist/
+.idea/
+venv/
+.coverage
+docs/pics/*.svg
+docs/.ipynb_checkpoints
+docs/api/

audmodel-1.3.0/.pre-commit-config.yaml

@@ -0,0 +1,26 @@
+# Configuration of checks run by pre-commit
+#
+# The tests are executed in the CI pipeline,
+# see CONTRIBUTING.rst for further instructions.
+# You can also run the checks directly at the terminal, e.g.
+#
+# $ pre-commit install
+# $ pre-commit run --all-files
+#
+#
+default_language_version:
+  python: python3.10
+
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.7.0
+    hooks:
+      - id: ruff
+        args: [ --fix ]
+      - id: ruff-format
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.3.0
+    hooks:
+      - id: codespell
+        additional_dependencies:
+          - tomli

audmodel-1.3.0/CHANGELOG.rst

@@ -0,0 +1,283 @@
+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 1.3.0 (2024-12-11)
+--------------------------
+
+* Added: open-source release
+* Added: ``audmodel-internal`` repository
+  on S3
+* Added: support for Python 3.11
+* Added: support for Python 3.12 (without Artifactory backend)
+* Added: support for Python 3.13 (without Artifactory backend)
+* Changed: switch to MIT license
+
+
+Version 1.2.0 (2024-05-10)
+--------------------------
+
+* Added: ``audmodel.Repository``
+  to handle repositories for model storage
+* Changed: depend on ``audbackend>=2.0.0``
+
+
+Version 1.1.2 (2024-02-21)
+--------------------------
+
+* Fixed: link to repository
+  and documentation
+  inside the Python package
+
+
+Version 1.1.1 (2023-11-13)
+--------------------------
+
+* Fixed: ensure ``audmodel.uid()`` returns the same ID
+  when ``subgroup`` is ``None`` or ``''``
+
+
+Version 1.1.0 (2023-10-17)
+--------------------------
+
+* Added: support for new backend API
+* Changed: depend on ``audbackend>=1.0.0``
+
+
+Version 1.0.7 (2023-01-04)
+--------------------------
+
+* Changed: split API documentation into sub-pages
+  for each function/class
+
+
+Version 1.0.6 (2022-05-05)
+--------------------------
+
+* Changed: update naming conventions for publishing a model
+* Changed: add docstring examples for all API functions
+* Fixed: ``audmodel.update_meta()`` does now return the updated metadata
+  dictionary
+
+
+Version 1.0.5 (2021-12-30)
+--------------------------
+
+* Changed: support Python 3.8 as default version
+
+
+Version 1.0.4 (2021-11-26)
+--------------------------
+
+* Added: ``verbose`` argument to functions that interact with the backend
+* Changed: use new sphinx-audeering-theme
+
+
+Version 1.0.3 (2021-09-29)
+--------------------------
+
+* Fixed: ``audmodel.load()`` could fail when broken folders
+  loaded by older versions of ``audmodel`` were present in the cache
+
+
+Version 1.0.2 (2021-09-14)
+--------------------------
+
+* Added: tests for Windows
+* Added: tests for macOS
+* Fixed: folder creation bug under Windows when loading a model
+
+
+Version 1.0.1 (2021-07-23)
+--------------------------
+
+* Changed: raise error if meta or parameters cannot be serialized
+* Fixed: clean up files when :func:`audmodel.publish` is interrupted
+
+
+Version 1.0.0 (2021-07-20)
+--------------------------
+
+* Added: :func:`audmodel.header`
+* Added: :func:`audmodel.meta`
+* Added: :func:`audmodel.legacy_uid`
+* Added: :func:`audmodel.update_meta`
+* Added: argument ``cache_root`` to several functions
+* Added: argument ``type`` to :func:`audmodel.url`
+* Changed: make ``'models-local'`` default repository
+* Changed: shorter model ID format, e.g. ``'5fbbaf38-3.0.0'``
+* Changed: support for different backends
+* Deprecated: ``private`` in :func:`audmodel.publish`
+* Deprecated: ``root`` in :func:`audmodel.load`
+* Removed: ``audmodel.lookup_table()``
+* Removed: ``audmodel.remove()``
+
+
+Version 0.10.0 (2021-04-06)
+---------------------------
+
+* Changed: use audfactory>=1.0.0
+
+
+Version 0.9.1 (2021-01-26)
+--------------------------
+
+* Fixed: allow for newer versions of ``audfactory``
+
+
+Version 0.9.0 (2021-01-25)
+--------------------------
+
+* Added: :func:`audmodel.date`
+* Added: :func:`audmodel.author`
+* Added: :func:`audmodel.exists`
+* Changed: include the repository name in the folders created in cache
+* Changed: :func:`audmodel.url` raises now ``ConnectionError``
+  instead of ``RuntimeError`` if Artifactory is offline
+
+
+Version 0.8.0 (2020-09-14)
+--------------------------
+
+.. note:: With this version it becomes possible
+    to load models only by their unique id.
+    This introduces several breaking changes.
+    For more details see the following
+    `issue <https://gitlab.audeering.com/tools/audmodel/-/merge_requests/41>`_.
+
+* Added:
+
+  * :meth:`audmodel.default_cache_root`
+  * :meth:`audmodel.name`
+  * :meth:`audmodel.parameters`
+  * :meth:`audmodel.subgroup`
+  * :meth:`audmodel.uid`
+  * :meth:`audmodel.url`
+  * :meth:`audmodel.version`
+
+* Changed:
+
+  * :meth:`audmodel.latest_version`
+  * :meth:`audmodel.load`
+  * :meth:`audmodel.remove`
+  * :meth:`audmodel.versions`
+
+* Removed:
+
+  * ``audmodel.create_lookup_table``
+  * ``audmodel.delete_lookup_table``
+  * ``audmodel.extend_params``
+  * ``audmodel.get_*``
+  * ``audmodel.load_by_id``
+  * ``audmodel.Parameter``
+  * ``audmodel.Parameters``
+
+
+Version 0.6.1 (2020-07-01)
+--------------------------
+
+* Fixed: :func:`audmodel.versions` where not using the correct lookup table name
+  and was broken
+
+
+Version 0.6.0 (2020-06-22)
+--------------------------
+
+* Added: :class:`audmodel.Parameter` and :class:`audmodel.Parameters`
+* Changed: ``unittest-public-local`` repository for unit testing
+* Changed: replace ``Lookup`` class with :class:`audfactory.Lookup`
+* Removed: remove ``aumodel.interface`` module
+* Removed: dependencies to ``audiofile``, ``audsp``, ``numpy``, ``pandas``
+
+
+Version 0.5.2 (2020-04-24)
+--------------------------
+
+* Added: :class:`audmodel.interface.ProcessWithContext`
+* Changed: :meth:`audmodel.load` prints more informative error message
+
+
+Version 0.5.1 (2020-04-23)
+--------------------------
+
+* Fixed: :meth:`audmodel.interface.Process.process_signal` uses correct
+  sampling rate after resampling
+
+
+Version 0.5.0 (2020-04-23)
+--------------------------
+
+* Added: :class:`audmodel.interface.Segment`
+* Added: :meth:`audmodel.get_model_url`
+* Changed: renamed interface class `Generic` to :class:`audmodel.interface.Process`
+* Changed: :meth:`audmodel.publish` returns the model's uid instead of url
+
+
+Version 0.4.1 (2020-04-20)
+--------------------------
+
+* Added: :meth:`audmodel.extend_params` and :meth:`audmodel.get_params`
+* Fixed: return type of :meth:`audmodel.interface.Generic.read_audio`
+
+
+Version 0.4.0 (2020-04-16)
+--------------------------
+
+* Added: :class:`audmodel.interface.Generic`
+
+
+Version 0.3.3 (2020-03-18)
+--------------------------
+
+* Added: verbose flag
+* Added: publish models under a subgroup
+
+
+Version 0.3.2 (2020-03-10)
+--------------------------
+
+* Changed: :class:`audmodel.config` now member of :mod:`audmodel`
+* Fixed: url of tutorial notebook
+
+
+Version 0.3.1 (2020-02-27)
+--------------------------
+
+* Changed: update documentation
+
+
+Version 0.3.0 (2020-02-27)
+--------------------------
+
+* Added: Sphinx documentation
+* Added: Jupyter tutorial
+* Changed: request (latest) version(s) for specific parameters (see
+  :func:`audmodel.version` and :func:`audmodel.latest_version`)
+* Changed: running tests in parallel
+
+
+Version 0.2.0 (2020-02-25)
+--------------------------
+
+* Added: unit tests with full code coverage
+* Added: :func:`audmodel.delete_lookup_table`
+* Added: :func:`audmodel.get_default_cache_root`
+* Added: :func:`audmodel.latest_version`
+* Added: :func:`audmodel.versions`
+
+
+Version 0.1.0 (2020-02-24)
+--------------------------
+
+* Added: initial release
+
+
+.. _Keep a Changelog:
+    https://keepachangelog.com/en/1.0.0/
+.. _Semantic Versioning:
+    https://semver.org/spec/v2.0.0.html

audmodel-1.3.0/CONTRIBUTING.rst

@@ -0,0 +1,125 @@
+Contributing
+============
+
+If you would like to add new functionality fell free to create a `merge
+request`_ . If you find errors, omissions, inconsistencies or other things
+that need improvement, please create an issue_.
+Contributions are always welcome!
+
+.. _issue: https://gitlab.audeering.com/tools/audmodel/issues/new?issue%5BD=
+.. _merge request: https://gitlab.audeering.com/tools/audmodel/merge_requests/new
+
+
+Development Installation
+------------------------
+
+Instead of pip-installing the latest release from PyPI, you should get the
+newest development version from Gitlab_::
+
+    git clone git@srv-app-01.audeering.local:tools/audmodel.git
+    cd audmodel
+    # Use virtual environment
+    pip install -r requirements.txt
+
+.. _Gitlab: https://gitlab.audeering.com/tools/audmodel
+
+This way, your installation always stays up-to-date, even if you pull new
+changes from the Gitlab repository.
+
+
+Coding Convention
+-----------------
+
+We follow the PEP8_ convention for Python code
+and use ruff_ as a linter and code formatter.
+In addition,
+we check for common spelling errors with codespell_.
+Both tools and possible exceptions
+are defined in :file:`pyproject.toml`.
+
+The checks are executed in the CI using `pre-commit`_.
+You can enable those checks locally by executing::
+
+    pip install pre-commit  # consider system wide installation
+    pre-commit install
+    pre-commit run --all-files
+
+Afterwards ruff_ and codespell_ are executed
+every time you create a commit.
+
+You can also install ruff_ and codespell_
+and call it directly::
+
+    pip install ruff codespell  # consider system wide installation
+    ruff check --fix .  # lint all Python files, and fix any fixable errors
+    ruff format .  # format code of all Python files
+    codespell
+
+It can be restricted to specific folders::
+
+    ruff check audfoo/ tests/
+    codespell audfoo/ tests/
+
+
+.. _codespell: https://github.com/codespell-project/codespell/
+.. _PEP8: http://www.python.org/dev/peps/pep-0008/
+.. _pre-commit: https://pre-commit.com
+.. _ruff: https://beta.ruff.rs
+
+
+Building the Documentation
+--------------------------
+
+If you make changes to the documentation,
+you can re-create the HTML pages using Sphinx_.
+You can install it and a few other necessary packages with::
+
+    pip install -r docs/requirements.txt
+
+To create the HTML pages, use::
+
+    python -m sphinx docs/ build/sphinx/html -b html
+
+The generated files will be available
+in the directory :file:`build/sphinx/html/`.
+
+It is also possible to automatically check if all links are still valid::
+
+    python -m sphinx docs/ build/sphinx/html -b linkcheck
+
+.. _Sphinx: https://www.sphinx-doc.org
+
+
+Running the Tests
+-----------------
+
+You'll need pytest_ for that.
+It can be installed with::
+
+    pip install -r tests/requirements.txt
+
+To execute the tests, simply run::
+
+    pytest tests/
+
+To run the tests on the Gitlab CI server,
+contributors have to make sure
+they have an existing ``artifactory-tokenizer`` repository
+as described in the `Artifactory tokenizer documentation`_.
+
+.. _pytest: https://pytest.org/
+.. _Artifactory tokenizer documentation: https://gitlab.audeering.com/devops/artifactory/tree/master/token
+
+
+Creating a New Release
+----------------------
+
+New releases are made using the following steps:
+
+#. Update ``CHANGELOG.rst``
+#. Commit those changes as "Release X.Y.Z"
+#. Create an (annotated) tag with ``git tag -a vX.Y.Z``
+#. Make sure you have an `artifactory-tokenizer`_ project
+#. Push the commit and the tag to Gitlab
+
+.. _artifactory-tokenizer: https://gitlab.audeering.com/devops/artifactory/tree/master/token

audmodel-1.3.0/LICENSE

@@ -0,0 +1,25 @@
+MIT License
+
+Copyright (c) 2019-present audEERING GmbH and Contributors
+
+Authors:
+    Hagen Wierstorf
+    Johannes Wagner
+
+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.