Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

REST API on top of PyAnnote

Project Description
# PyAnnote REST API

## Installation

$ pip install pyannote.server

## Running the server

$ python -m pyannote.server.run

## Using the API

### Parsers

* `/parser/` returns list of supported file formats

$ curl -X GET http://localhost:5000/parser/
["mdtm", "uem"]

* `/parser/<format>` parses `POST`ed file and returns its content in PyAnnote JSON format.


### Evaluation metrics

* `/metric/` returns list of available evaluation metrics

$ curl -X GET http://localhost:5000/metric/
["detection", "diarization", "identification"]


* `/metric/<name>` compares `POST`ed reference and hypothesis annotations in JSON format and returns the corresponding evaluation metric.

**Input format (JSON)**

{
"reference": [
...
],
"hypothesis": [
...
]
}

**Output format (JSON)**

{
METRIC: {
METRIC: value,
COMPONENT_1: value_1,
COMPONENT_2: value_2,
... # components are values from
... # which the final value is computed
},
... # one call to /parser/<metric> may
... # return more than one sub-metrics
}


### Error analysis

* `/error/diff` compares `POST`ed reference and hypothesis and returns their differences.

**Input format (JSON)**

# same format as for metric/<name>
{
"reference": [
...
],
"hypothesis": [
...
]
}


* `/error/regression` compares `POST`ed reference with two hypotheses and returns regressions and/or improvements brought by the second one (`after`) over the first one (`before`).

**Input format (JSON)**

{
"reference": [
...
],
"before": [
...
],
"after": [
...
]
}
Release History

Release History

This version
History Node

0.7

History Node

0.6.2

History Node

0.6.1

History Node

0.6

History Node

0.5

History Node

0.4.1

History Node

0.4

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
pyannote.server-0.7.tar.gz (10.1 kB) Copy SHA256 Checksum SHA256 Source Oct 31, 2014

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting