Adding clustering module to init (#43)

* Adding clustering module to init
* Improve documentation

Author: avilchess

khiva/__init__.py

@@ -8,6 +8,7 @@
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
 from khiva.array import *
+from khiva.clustering import *
 from khiva.dimensionality import *
 from khiva.distances import *
 from khiva.features import *

khiva/clustering.py

@@ -20,11 +20,16 @@
 def k_means(tss, k, tolerance=1e-10, max_iterations=100):
     """ Calculates the K-Means algorithm.
 
+    [1] S. Lloyd. 1982. Least squares quantization in PCM. IEEE Transactions on Information Theory, 28, 2,
+    Pages 129-137.
+
     :param tss: Expects an input array whose dimension zero is the length of the time series (all the same) and
     dimension one indicates the number of time series.
     :param k:                   The number of means to be computed.
     :param tolerance:           The error tolerance to stop the computation of the centroids.
     :param max_iterations:      The maximum number of iterations allowed.
+
+    :return: Tuple with an array of centroids and array of labels.
     """
     centroids = ctypes.c_void_p(0)
     labels = ctypes.c_void_p(0)
@@ -42,11 +47,17 @@ def k_means(tss, k, tolerance=1e-10, max_iterations=100):
 def k_shape(tss, k, tolerance=1e-10, max_iterations=100):
     """ Calculates the K-Shape algorithm.
 
+    [1] John Paparrizos and Luis Gravano. 2016. k-Shape: Efficient and Accurate Clustering of Time Series.
+    SIGMOD Rec. 45, 1 (June 2016), 69-76.
+
+
     :param tss: Expects an input array whose dimension zero is the length of the time series (all the same) and
     dimension one indicates the number of time series.
     :param k:                   The number of means to be computed.
     :param tolerance:           The error tolerance to stop the computation of the centroids.
     :param max_iterations:      The maximum number of iterations allowed.
+
+    :return: Tuple with an array of centroids and array of labels.
     """
     centroids = ctypes.c_void_p(0)
     labels = ctypes.c_void_p(0)

setup.py

@@ -21,7 +21,7 @@
     author="Shapelets.io",
     author_email="dev@shapelets.io",
     name="khiva",
-    version='0.1.4',
+    version='0.2.0',
     long_description = LONG_DESC,
     description="Python bindings for khiva",
     license="MPL 2.0",