Merge branch 'release/0.14.4'

pyannote · Mar 27, 2017 · 106696e · 106696e
2 parents 0b60aee + 9008b12
commit 106696e
Show file tree

Hide file tree

Showing 8 changed files with 199 additions and 472 deletions.
diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md
@@ -0,0 +1,40 @@
+
+#### Description
+<!-- Example: DiarizationPurity does not return the expected value -->
+
+#### Steps/Code to Reproduce
+<!--
+Example:
+
+```
+from pyannote.core import Annotation, Segment
+reference = Annotation()
+reference[Segment(0, 10)] = 'A'
+reference[Segment(12, 20)] = 'B'
+reference[Segment(24, 27)] = 'A'
+reference[Segment(30, 40)] = 'C'
+hypothesis = Annotation()
+hypothesis[Segment(2, 13)] = 'a'
+hypothesis[Segment(13, 14)] = 'd'
+hypothesis[Segment(14, 20)] = 'b'
+hypothesis[Segment(22, 38)] = 'c'
+hypothesis[Segment(38, 40)] = 'd'
+
+from pyannote.metrics.diarization import DiarizationPurity
+purity = DiarizationPurity()
+print "Purity = {0:.3f}".format(purity(reference, hypothesis))
+```
+If the code is too long, feel free to put it in a public gist and link
+it in the issue: https://gist.github.com
+-->
+
+#### Expected Results
+<!-- Example: Output should be "Purity = 0.667". Please paste or describe the expected results.-->
+
+#### Actual Results
+<!-- Please paste or specifically describe the actual output or traceback. -->
+
+#### Versions
+<!-- Please paste the output of `pip freeze | grep pyannote` below -->
+
+<!-- Thanks for contributing! -->
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 > a toolkit for reproducible evaluation, diagnostic, and error analysis of speaker diarization systems
 
-An overview of `pyannote.metrics` is available as a [technical report](doc/pyannote-metrics.pdf): it is recommended to read it first, to quickly get an idea whether this tool is for you.
+An overview of `pyannote.metrics` is available as a [technical report](docs/pyannote-metrics.pdf): it is recommended to read it first, to quickly get an idea whether this tool is for you.
 
 ## Installation
 

diff --git a/notebooks/pyannote-metrics.pdf → docs/pyannote-metrics.pdf b/notebooks/pyannote-metrics.pdf → docs/pyannote-metrics.pdf
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -2,6 +2,11 @@
 Changelog
 #########
 
+Version 0.14.4 (2017-03-27)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- doc: update notebook to latest version
+
 Version 0.14.3 (2017-03-27)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

diff --git a/notebooks/index.ipynb b/notebooks/index.ipynb
@@ -1,99 +1,34 @@
 {
  "cells": [
   {
-   "cell_type": "code",
-   "execution_count": 1,
+   "cell_type": "markdown",
    "metadata": {
-    "collapsed": false
+    "deletable": true,
+    "editable": true
    },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Populating the interactive namespace from numpy and matplotlib\n"
-     ]
-    }
-   ],
-   "source": [
-    "%pylab inline"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# Documentation for `pyannote.metrics`"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Install"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "`pyannote.metrics` package can be installed the easy way:\n",
-    "```bash\n",
-    "$ pip install pyannote.metrics\n",
-    "```"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Available metrics"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
    "source": [
     "* Diarization ([pyannote.metrics.diarization](pyannote.metrics.diarization.ipynb))\n",
-    "* Identification ([pyannote.metrics.identification](pyannote.metrics.identification.ipynb))\n",
-    "* Segmentation ([pyannote.metrics.segmentation](pyannote.metrics.segmentation.ipynb))"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Contribute"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "`pyannote.metrics` is on [Github](https://github.com/pyannote/pyannote-metrics).  \n",
-    " \n",
-    " \n",
-    " Fork and pull requests are very welcome!"
+    "* Identification ([pyannote.metrics.identification](pyannote.metrics.identification.ipynb))"
    ]
   }
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 2",
+   "display_name": "Python 3",
    "language": "python",
-   "name": "python2"
+   "name": "python3"
   },
   "language_info": {
    "codemirror_mode": {
     "name": "ipython",
-    "version": 2
+    "version": 3
    },
    "file_extension": ".py",
    "mimetype": "text/x-python",
    "name": "python",
    "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython2",
-   "version": "2.7.10"
+   "pygments_lexer": "ipython3",
+   "version": "3.4.3"
   }
  },
  "nbformat": 4,

diff --git a/notebooks/pyannote.metrics.diarization.ipynb b/notebooks/pyannote.metrics.diarization.ipynb
diff --git a/notebooks/pyannote.metrics.identification.ipynb b/notebooks/pyannote.metrics.identification.ipynb