gryannote


Namegryannote JSON
Version 0.3.3 PyPI version JSON
download
home_pageNone
SummaryProvide Gradio custom components to make the diarization-based audio annotation process easier
upload_time2024-11-06 13:30:26
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseMIT License Copyright (c) 2024 CNRS 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 annotation-tool audio gradio-custom-component pyannote speaker-diarization
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <p align="center">
  <img src="https://github.com/clement-pages/gryannote/blob/main/docs/assets/logo-gryannote.png?raw=true" alt="gryannote logo" width="200">
<p>

# gryannote: a  speaker diarization labeling tool

gryannote is a collection of [`Gradio`](https://www.gradio.app/) custom components focusing on the labeling of speaker diarization data. Integrated with the [`pyannote`](https://github.com/pyannote/pyannote-audio) speaker diarization ecosystem, it allows to build web applications to load pretrained `pyannote` pipelines and customize their hyper-parameters, upload or record an audio file, process it with the pipeline, visualize and interact with its outputs, correct them if needed, and export the final annotation in RTTM format. Each of these components can be used independently from each other.

## Available `Gradio` custom components

Here is the list of `Gradio` custom components integrated in `gryannote`

- [gryannote_audio](https://github.com/clement-pages/gryannote/tree/main/gryannote/audio/README.md)
- [gryannote_pipeline](https://github.com/clement-pages/gryannote/tree/main/gryannote/pipeline/README.md)
- [gryannote_rttm](https://github.com/clement-pages/gryannote/tree/main/gryannote/rttm/README.md)

## Installation

```shell
pip install gryannote
```

## Usage

The following code snippet show how to use the `gryannote_audio` component with a `pyannote` pipeline in just a few lines of code. You can find a complete example that uses the three component
in `app.py` script.

```python
import gradio as gr
from gryannote_audio import AudioLabeling
from pyannote.audio import Pipeline

audio_labeling = AudioLabeling(type="filepath", interactive=True)


def apply_pipeline(audio):
    pipeline = Pipeline.from_pretrained("pyannote/speaker-diarization-3.1")
    annotations = pipeline(audio)
    return (audio, annotations)

demo = gr.Interface(apply_pipeline, inputs=audio_labeling, outputs=audio_labeling)

demo.launch()
```

## Interface

Launching `demo/app.py` script will generate the following interface. This interface uses the three `gryannote` components. More details about these components and their interface can be found
in their respective README.

![](https://github.com/clement-pages/gryannote/blob/main/docs/assets/gryannote_interface.png?raw=1)

RTTM annotations in RTTM component are dynamically updated according to the audio labeling made in the audio component.

## Try it!

A `gryannote` app can be runned in this [Hugging Face space](https://huggingface.co/spaces/clement-pages/gryannote)

## Citation

If you are using `gryannote`, please use the following citation:

```bibtex
@inproceedings{pages24_interspeech,
  title     = {Gryannote open-source speaker diarization labeling tool},
  author    = {Clément Pages and Hervé Bredin},
  year      = {2024},
  booktitle = {Interspeech 2024},
  pages     = {3650--3651},
}
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "gryannote",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "annotation-tool, audio, gradio-custom-component, pyannote, speaker-diarization",
    "author": null,
    "author_email": "Cl\u00e9ment Pag\u00e9s <clement.pages@irit.fr>",
    "download_url": "https://files.pythonhosted.org/packages/f6/12/52fbe3efcf2ae940eec11017c8978e1dd29767a7349e87d61009a3e6e295/gryannote-0.3.3.tar.gz",
    "platform": null,
    "description": "<p align=\"center\">\n  <img src=\"https://github.com/clement-pages/gryannote/blob/main/docs/assets/logo-gryannote.png?raw=true\" alt=\"gryannote logo\" width=\"200\">\n<p>\n\n# gryannote: a  speaker diarization labeling tool\n\ngryannote is a collection of [`Gradio`](https://www.gradio.app/) custom components focusing on the labeling of speaker diarization data. Integrated with the [`pyannote`](https://github.com/pyannote/pyannote-audio) speaker diarization ecosystem, it allows to build web applications to load pretrained `pyannote` pipelines and customize their hyper-parameters, upload or record an audio file, process it with the pipeline, visualize and interact with its outputs, correct them if needed, and export the final annotation in RTTM format. Each of these components can be used independently from each other.\n\n## Available `Gradio` custom components\n\nHere is the list of `Gradio` custom components integrated in `gryannote`\n\n- [gryannote_audio](https://github.com/clement-pages/gryannote/tree/main/gryannote/audio/README.md)\n- [gryannote_pipeline](https://github.com/clement-pages/gryannote/tree/main/gryannote/pipeline/README.md)\n- [gryannote_rttm](https://github.com/clement-pages/gryannote/tree/main/gryannote/rttm/README.md)\n\n## Installation\n\n```shell\npip install gryannote\n```\n\n## Usage\n\nThe following code snippet show how to use the `gryannote_audio` component with a `pyannote` pipeline in just a few lines of code. You can find a complete example that uses the three component\nin `app.py` script.\n\n```python\nimport gradio as gr\nfrom gryannote_audio import AudioLabeling\nfrom pyannote.audio import Pipeline\n\naudio_labeling = AudioLabeling(type=\"filepath\", interactive=True)\n\n\ndef apply_pipeline(audio):\n    pipeline = Pipeline.from_pretrained(\"pyannote/speaker-diarization-3.1\")\n    annotations = pipeline(audio)\n    return (audio, annotations)\n\ndemo = gr.Interface(apply_pipeline, inputs=audio_labeling, outputs=audio_labeling)\n\ndemo.launch()\n```\n\n## Interface\n\nLaunching `demo/app.py` script will generate the following interface. This interface uses the three `gryannote` components. More details about these components and their interface can be found\nin their respective README.\n\n![](https://github.com/clement-pages/gryannote/blob/main/docs/assets/gryannote_interface.png?raw=1)\n\nRTTM annotations in RTTM component are dynamically updated according to the audio labeling made in the audio component.\n\n## Try it!\n\nA `gryannote` app can be runned in this [Hugging Face space](https://huggingface.co/spaces/clement-pages/gryannote)\n\n## Citation\n\nIf you are using `gryannote`, please use the following citation:\n\n```bibtex\n@inproceedings{pages24_interspeech,\n  title     = {Gryannote open-source speaker diarization labeling tool},\n  author    = {Cl\u00e9ment Pages and Herv\u00e9 Bredin},\n  year      = {2024},\n  booktitle = {Interspeech 2024},\n  pages     = {3650--3651},\n}\n```\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2024 CNRS  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": "Provide Gradio custom components to make the diarization-based audio annotation process easier",
    "version": "0.3.3",
    "project_urls": {
        "Homepage": "https://github.com/clement-pages/gryannote"
    },
    "split_keywords": [
        "annotation-tool",
        " audio",
        " gradio-custom-component",
        " pyannote",
        " speaker-diarization"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a18b53179fdda2f36d76670162335c1f984124565f2117f09567756e95d95cff",
                "md5": "7ef86c9c66416574d1f631c755ae8f07",
                "sha256": "2513b7a3623a887e947b6765201d1d0f38dd5331f1b7544828187c0549ffeda3"
            },
            "downloads": -1,
            "filename": "gryannote-0.3.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7ef86c9c66416574d1f631c755ae8f07",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 296200,
            "upload_time": "2024-11-06T13:30:22",
            "upload_time_iso_8601": "2024-11-06T13:30:22.603999Z",
            "url": "https://files.pythonhosted.org/packages/a1/8b/53179fdda2f36d76670162335c1f984124565f2117f09567756e95d95cff/gryannote-0.3.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f61252fbe3efcf2ae940eec11017c8978e1dd29767a7349e87d61009a3e6e295",
                "md5": "166744b862ce61e11c1cf61dce888610",
                "sha256": "b8e4b2d908dec3b47cdaf417cec1530c56adf3b228ad8444e80a0dc2392d8e45"
            },
            "downloads": -1,
            "filename": "gryannote-0.3.3.tar.gz",
            "has_sig": false,
            "md5_digest": "166744b862ce61e11c1cf61dce888610",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 2210324,
            "upload_time": "2024-11-06T13:30:26",
            "upload_time_iso_8601": "2024-11-06T13:30:26.381865Z",
            "url": "https://files.pythonhosted.org/packages/f6/12/52fbe3efcf2ae940eec11017c8978e1dd29767a7349e87d61009a3e6e295/gryannote-0.3.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-06 13:30:26",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "clement-pages",
    "github_project": "gryannote",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "gryannote"
}
        
Elapsed time: 1.21774s