Metadata-Version: 2.1
Name: speechmatics-diarization-metrics
Version: 0.0.2
Summary: Python module for evaluating speaker diarization.
Home-page: UNKNOWN
Author: Speechmatics
Author-email: support@speechmatics.com
License: Speechmatics Proprietary License
Platform: linux
Requires-Python: >=3.5
Description-Content-Type: text/markdown
Requires-Dist: pyannote.core
Requires-Dist: pyannote.database
Requires-Dist: docopt
Requires-Dist: tabulate

## Getting Started

This project is Speechmatics' fork of https://github.com/pyannote/pyannote-metrics used to calculate various speaker diarization metrics from reference/hypothesis transcript pairs.

To install the package:  

`pip install speechmatics-diarization-metrics`

This package has a CLI supporting ctm, lab, or V2 JSON format transcripts and can be run using:  

`python3 -m sm_diarization_metrics.cookbook reference.json transcript.json`

For further guidance run:  

`python3 -m sm_diarization_metrics.cookbook -h`

### Run from source code

If you would prefer to clone the repo and run the source code:  

`git clone git@github.com:speechmatics/speechmatics-python.git`  

`cd speechmatics-python/metrics/sm_diarization_metrics`  

`pip install -r ./requirements.txt`  

`python3 -m sm_diarization_metrics.cookbook reference.json transcript.json`   

### Build wheel
To build and install the wheel run:
`make wheel`
`make install`

### Docs

Further description of how to use the tool and the metrics available are in sm_diarization_metrics.pdf



