Commit 5bdcbb9b authored by Anthony Larcher's avatar Anthony Larcher
Browse files

documentation

parent dd9d64c5
......@@ -149,7 +149,7 @@ __maintainer__ = "Anthony Larcher"
__email__ = "anthony.larcher@univ-lemans.fr"
__status__ = "Production"
__docformat__ = 'reStructuredText'
__version__="1.1.6"
__version__="1.1.7"
# __all__ = ["io",
# "vad",
......
......@@ -165,8 +165,7 @@
<span class="sd"> :param input_file_name: name of the PCM file to read.</span>
<span class="sd"> </span>
<span class="sd"> :return: the audio signal read from the file in a ndarray encoded on 16 bits,</span>
<span class="sd"> None and 2 (depth of the encoding in bytes)</span>
<span class="sd"> :return: the audio signal read from the file in a ndarray encoded on 16 bits, None and 2 (depth of the encoding in bytes)</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">input_file_name</span><span class="p">,</span> <span class="s1">&#39;rb&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
<span class="n">f</span><span class="o">.</span><span class="n">seek</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span> <span class="c1"># Go to te end of the file</span>
......
This diff is collapsed.
......@@ -6,7 +6,7 @@
.. |logo| image:: logo_lium.png
Welcome to SIDEKIT 1.1.6 documentation!
Welcome to SIDEKIT 1.1.7 documentation!
=======================================
| **SIDEKIT** is an open source package for Speaker and Language recognition.
......@@ -20,11 +20,11 @@ Welcome to SIDEKIT 1.1.6 documentation!
Kong Aik Lee \&
Sylvain Meignier
:Version: 1.1.6 of 2016/10/31
:Version: 1.1.7 of 2016/11/18
.. seealso::
News for **SIDEKIT** 1.1.6:
News for **SIDEKIT** 1.1.7:
- new ``FeaturesExtractor`` for a simplified interface
- new ``FeaturesServer`` provides a simpler and more flexible management of the acoustic parameters
......
......@@ -7,7 +7,7 @@ After installing `miniconda <http://conda.pydata.org/miniconda.html>`_:
.. code-block:: bash
conda install -c anthol sidekit=1.1.6
conda install -c anthol sidekit
Using PIP
......
......@@ -6,7 +6,7 @@ API description
:Authors:
Anthony LACHER, Sylvain MEIGNIER \& Kong Aik LEE
:Version: 1.1.6 of 2016/10/31
:Version: 1.1.7 of 2016/11/18
| This package is the core of the **SIDEKIT** toolkit.
| While developing **SIDEKIT**, we tried to keep in mind two
......
......@@ -176,12 +176,9 @@ class FeaturesExtractor(object):
:param show: ID if the show
:param channel: channel number (0 if mono file)
:param input_audio_filename: name of the input audio file to consider if the name of the audio file is
independent from the ID of the show
:param output_feature_filename: name of the output feature file to consider if the name of the feature file
is independent from the ID of the show
:param backing_store: boolean, if False, nothing is writen to disk, if True, the file is writen to disk
when closed
:param input_audio_filename: name of the input audio file to consider if the name of the audio file is independent from the ID of the show
:param output_feature_filename: name of the output feature file to consider if the name of the feature file is independent from the ID of the show
:param backing_store: boolean, if False, nothing is writen to disk, if True, the file is writen to disk when closed
:return: an hdf5 file handler
"""
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment