repackaging

CHANGES.txt

+s4d-0.5.0, 23/01/2020 -- Repackaging and creation of CHANGES.txt
\ No newline at end of file

COPYING.LESSER

+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

MANIFEST.in

-include *.md
\ No newline at end of file
+#documentation
+recursive-include docs/_build/html *
+
+
+#include *.txt
+#include *.rst
+#recursive-include sidekit/docs *.rst *.png *.html
+
+include *.md

README.md

 Diarization lib
 +++++++++++++++
 
-INTRODUCTION
-============
 
-This GPL v3 package contains a tool to build a speaker diarization system.
+=============================
+S4D - Sidekit For Diarization
+=============================
+
+| **S4D** is an open source package for speaker diarization.
+| The aim of **S4D** is to provide an educational and efficient toolkit 
+| for speaker diarization including the whole chain of treatment 
+| that goes from the audio data to the analysis of the system performance.
 
 
 PREREQUISITES
@@ -18,6 +23,7 @@ PREREQUISITES
 4. [Pandas](http://http://www.pandas.org/)
 5. [GLPK](https://www.gnu.org/software/glpk/)
 6. [Sphinx 1.1.0 or newer](http://http://sphinx-doc.org/) to build the documentation
+7. [SIDEKIT](https://lium.univ-lemans.fr/sidekit/)
 
 INSTALLATION
 ============
@@ -27,4 +33,15 @@ We recommend the use of a virtual environment (e.g. [Miniconda](https://conda.io
 TUTORIALS
 =========
 
-Once your installation is complete, you can take a look at the [tutorials](https://git-lium.univ-lemans.fr/Meignier/s4d/tree/master/tutorials).
\ No newline at end of file
+Once your installation is complete, you can take a look at the [tutorials](https://git-lium.univ-lemans.fr/Meignier/s4d/tree/master/tutorials).
+
+
+:Authors: 
+	Sylvain Meignier \&
+    Anthony Larcher \&
+    Pierre-Alexandre Broux \&
+    Florent Desnous
+    
+
+
+:Version: 0.5.0 of 2020/01/23
\ No newline at end of file

meta.yaml

+package:
+  name: s4d
+
+source:
+  git_tag: v.0.5.0
+  git_url: https://git-lium.univ-lemans.fr/Meignier/s4d.git
+
+requirements:
+  build:
+    - python
+    - bottleneck
+    - ecyglpki
+    - h5py
+    - matplotlib
+    - mock
+    - nose
+    - numexpr
+    - numpy
+    - pandas
+    - Pillow
+    - PyAudio
+    - pyparsing
+    - python-dateutil
+    - PyYAML
+    - scipy
+    - setuptools
+    - six
+    - scikit_learn
+    - sortedcontainers
+
+  run:
+    - python
+
+test:
+  imports:
+    - s4d
+
+about:
+  home: https://lium.univ-lemans.fr/s4d
+  license: LGPL 3.0
\ No newline at end of file

s4d/__init__.py

-__author__ = 'meignier'
-
-import s4d.clustering.hac_bic
-import s4d.clustering.hac_clr
-import s4d.clustering.hac_iv
-import s4d.clustering.hac_utils
-import s4d.model_iv
-from s4d.clustering.cc_iv import ConnectedComponent
-from s4d.diar import Diar
-from s4d.segmentation import sanity_check, bic_linear, div_gauss
-from s4d.viterbi import Viterbi
-
-__version__ = "0.0.4.3"
+# -*- coding: utf-8 -*-
+#
+# This file is part of s4d.
+#
+# s4d is a python package for speaker diarization.
+# Home page: http://www-lium.univ-lemans.fr/s4d/
+#
+# s4d is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as
+# published by the Free Software Foundation, either version 3 of the License,
+# or (at your option) any later version.
+#
+# s4d is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with s4d.  If not, see <http://www.gnu.org/licenses/>.
+
+
+"""
+Copyright 2014-2020 Sylvain Meignier and Anthony Larcher
+"""
+
+from .clustering.hac_bic import HAC_BIC
+from .clustering.hac_clr import HAC_CLR
+from  .clustering.hac_iv import hac_iv, hac_iv_it
+
+from .clustering.hac_utils import argmin
+from .clustering.hac_utils import argmax
+from .clustering.hac_utils import roll
+from .clustering.hac_utils import stat_server_remove
+from .clustering.hac_utils import scores_remove
+from .clustering.hac_utils import scores2distance
+from .clustering.hac_utils import stat_server_merge
+from .clustering.hac_utils import bic_square_root
+
+from .clustering.cc_iv import ConnectedComponent
+
+from .model_iv import ModelIV
+
+from .diar import Diar
+from .segmentation import sanity_check
+from .segmentation import bic_linear
+from .segmentation import div_gauss
+
+from .viterbi import Viterbi
+
+from .scoring import DER
+
+
+__author__ = "Sylvain Meignier and Anthony Larcher"
+__copyright__ = "Copyright 2014-20120 Sylvain Meignier and Anthony Larcher"
+__license__ = "LGPL"
+__maintainer__ = "Sylvain Meignier"
+__email__ = "sylvain.meignierr@univ-lemans.fr"
+__status__ = "Production"
+__docformat__ = 'reStructuredText'
+__version__ = "0.5.0"

s4d/alien/__init__.py

+# -*- coding: utf-8 -*-
+#
+# This file is part of s4d.
+#
+# s4d is a python package for speaker diarization.
+# Home page: http://www-lium.univ-lemans.fr/s4d/
+#
+# s4d is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as
+# published by the Free Software Foundation, either version 3 of the License,
+# or (at your option) any later version.
+#
+# s4d is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with s4d.  If not, see <http://www.gnu.org/licenses/>.
 
 
+"""
+Copyright 2014-2020 Sylvain Meignier and Anthony Larcher
+"""
+

s4d/alien/hmm.py

@@ -2,13 +2,15 @@
 #
 # Author: Ron Weiss <ronweiss@gmail.com>
 
-import string
 
 import numpy as np
+import string
 
 from sklearn.base import BaseEstimator
 from sklearn import cluster
-from s4d.alien.mixture import GMM, sample_gaussian, _validate_covars, logsum, lmvnpdf, normalize, _distribute_covar_matrix_to_match_cvtype
+from ..alien.mixture import GMM, sample_gaussian, _validate_covars
+from ..alien.mixture import logsum, lmvnpdf, normalize, _distribute_covar_matrix_to_match_cvtype
+
 ZEROLOGPROB = -1e200
 
 

s4d/clustering/__init__.py

-from s4d.clustering.hac_bic import GaussFull
-from s4d.clustering.hac_bic import HAC_BIC
-from s4d.clustering.hac_bic import bic_square_root
+# -*- coding: utf-8 -*-
+#
+# This file is part of s4d.
+#
+# s4d is a python package for speaker diarization.
+# Home page: http://www-lium.univ-lemans.fr/s4d/
+#
+# s4d is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as
+# published by the Free Software Foundation, either version 3 of the License,
+# or (at your option) any later version.
+#
+# s4d is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with s4d.  If not, see <http://www.gnu.org/licenses/>.
 
+
+"""
+Copyright 2014-2020 Sylvain Meignier and Anthony Larcher
+"""
+
+from .gauss import GaussFull
+from .hac_utils import bic_square_root
+from .hac_bic import HAC_BIC
+
+from .hac_utils import argmin
+from .hac_utils import argmax
+from .hac_utils import roll
+from .hac_utils import stat_server_remove
+from .hac_utils import scores_remove
+from .hac_utils import scores2distance
+from .hac_utils import stat_server_merge
+from .hac_utils import bic_square_root
\ No newline at end of file

s4d/clustering/cc_iv.py

-__author__ = 'meignier'
+# -*- coding: utf-8 -*-
+#
+# This file is part of s4d.
+#
+# s4d is a python package for speaker diarization.
+# Home page: http://www-lium.univ-lemans.fr/s4d/
+#
+# s4d is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as
+# published by the Free Software Foundation, either version 3 of the License,
+# or (at your option) any later version.
+#
+# s4d is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with s4d.  If not, see <http://www.gnu.org/licenses/>.
+
+
+"""
+Copyright 2014-2020 Sylvain Meignier and Anthony Larcher
+"""
 
 import copy
 import logging
 import numpy as np
-from scipy.sparse import csgraph
+
 from collections import namedtuple
+from .hac_utils import scores2distance
+from scipy.sparse import csgraph
 from sidekit.bosaris.scores import Scores
-from s4d.clustering.hac_utils import *
-
 
 ConnectedComponentTuple = namedtuple('ConnectedComponent', ['type', 'diarization', 'scores' ])
 
 
 StarGraphTuple = namedtuple('ConnectedComponent', ['type', 'diarization', 'scores',
-                                                     'center', 'within_inertia'])
+                                                   'center', 'within_inertia'])
 
 
 class ConnectedComponent:

s4d/clustering/gauss.py

+# -*- coding: utf-8 -*-
+#
+# This file is part of s4d.
+#
+# s4d is a python package for speaker diarization.
+# Home page: http://www-lium.univ-lemans.fr/s4d/
+#
+# s4d is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as
+# published by the Free Software Foundation, either version 3 of the License,
+# or (at your option) any later version.
+#
+# s4d is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with s4d.  If not, see <http://www.gnu.org/licenses/>.
+
+
+"""
+Copyright 2014-2020 Sylvain Meignier and Anthony Larcher
+"""
+
 import logging
 import numpy as np
 

s4d/clustering/hac_bic.py

-__author__ = 'meignier'
+# -*- coding: utf-8 -*-
+#
+# This file is part of s4d.
+#
+# s4d is a python package for speaker diarization.
+# Home page: http://www-lium.univ-lemans.fr/s4d/
+#
+# s4d is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as
+# published by the Free Software Foundation, either version 3 of the License,
+# or (at your option) any later version.
+#
+# s4d is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with s4d.  If not, see <http://www.gnu.org/licenses/>.
+
+
+"""
+Copyright 2014-2020 Sylvain Meignier and Anthony Larcher
+"""
 
-import numpy as np
-import logging
 import copy
+import logging
+import numpy as np
+
+from ..diar import Diar
+from .gauss import GaussFull
+from .hac_utils import argmin, roll
+from .hac_utils import bic_square_root
 from math import isnan
-from s4d.clustering.hac_utils import argmin, roll
-from s4d.clustering.hac_utils import bic_square_root
-from s4d.clustering.gauss import GaussFull
-from s4d.diar import Diar
+
 
 class HAC_BIC:
     """
@@ -41,7 +66,7 @@ class HAC_BIC:
     """
     def __init__(self, cep, table, alpha=1.0, sr=False):
         self.cep = cep
-        self.dim = cep.shape[1];
+        self.dim = cep.shape[1]
         self.alpha = alpha
         self.diar = copy.deepcopy(table)
         self.models = []
@@ -84,7 +109,7 @@ class HAC_BIC:
             for j in range(i + 1, nb):
                 mj = self.models[j]
                 self.dist[i, j] = self.dist[j, i] = self._dist(mi, mj)
-        #logging.debug(self.dist)
+        # logging.debug(self.dist)
 
     def _dist(self, mi, mj):
         """
@@ -96,7 +121,7 @@ class HAC_BIC:
         v = GaussFull.merge_partial_bic(mi, mj) - mi.partial_bic - mj.partial_bic
         if self.sr:
             v += - bic_square_root(mi.count, mj.count, self.alpha, self.dim)
-        else :
+        else:
             v += - self.cst_bic * np.log(mi.count + mj.count)
         if isnan(v):
             logging.warning('BIC is NAN, mi: '+mi.name+' ' + str(mi.count)+' mj: '+mj.name+' ' + str(mj.count))
@@ -162,15 +187,14 @@ class HAC_BIC:
             i, j, v = argmin(self.dist, nb)
 
         out_diar = copy.deepcopy(self.diar)
-        n = self.nb_merge
 
         if to_the_end:
             while nb > 1:
                 self.information(i, j, v, self.models[i].count+self.models[j].count)
                 self.nb_merge += 1
                 logging.debug('merge: %d c1: %s (%d) c2: %s (%d) dist: %f %d',
-                          self.nb_merge, self.models[i].name, i,
-                          self.models[j].name, j, v, nb)
+                              self.nb_merge, self.models[i].name, i,
+                              self.models[j].name, j, v, nb)
                 self.diar.rename('cluster', [self.models[j].name], self.models[i].name)
                 # update model
                 self.models[i] = self._merge_model(self.models[i], self.models[j])
@@ -186,6 +210,14 @@ class HAC_BIC:
 
 
 def hac_bic(feature_server, diar, threshold, square_root_bic = False):
+    """
+
+    :param feature_server:
+    :param diar:
+    :param threshold:
+    :param square_root_bic:
+    :return:
+    """
     shows = diar.make_index(['show'])
     diar_out = Diar()
     for show in shows:

s4d/clustering/hac_clr.py

-import numpy as np
-import logging
+# -*- coding: utf-8 -*-
+#
+# This file is part of s4d.
+#
+# s4d is a python package for speaker diarization.
+# Home page: http://www-lium.univ-lemans.fr/s4d/
+#
+# s4d is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as
+# published by the Free Software Foundation, either version 3 of the License,
+# or (at your option) any later version.
+#
+# s4d is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with s4d.  If not, see <http://www.gnu.org/licenses/>.
+
+
+"""
+Copyright 2014-2020 Sylvain Meignier and Anthony Larcher
+"""