https://github.com/hadware/pyannote-extension-template
A template repository to make a pyannote extension class
https://github.com/hadware/pyannote-extension-template
Last synced: about 2 months ago
JSON representation
A template repository to make a pyannote extension class
- Host: GitHub
- URL: https://github.com/hadware/pyannote-extension-template
- Owner: hadware
- License: mit
- Created: 2019-07-26T19:43:26.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-07-28T03:01:24.000Z (almost 6 years ago)
- Last Synced: 2025-01-30T15:44:43.828Z (4 months ago)
- Language: Python
- Size: 4.88 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pyannote-extension-template
This is a template for any external class that would be needed at any step of the
pyannote pipeline. The classes that are defined in your extension can be then
used through the `config.yml` file.
The name of submodule you use in the `pyannote/` folder should reflect what your
extension is about (`models`, `features`, `callbacks`, ...).
## Installation
Pyannote extensions usually require the
[pyannote-audio](https://github.com/pyannote/pyannote-audio) environment to be installed
and activated. Be sure to follow the installation instructions on the aforementioned's repo.
Once this is done (and the environment activated), you can install it through pip:
```
pip install git+git://github.com/pyannote/pyannote-myextension.git
```
## Pyannote Configuration
To use the model contained in this library, this is the kind of configuration you
should add your `config.yml` file:
```yaml
pipeline_step_name:
name: pyannote.submodule.MyClass
params:
param_1 : 1
param_2 : some other string value
param_3 : 4577
```
Be sure to add one or more sample configurations in the `sample_config` folder.