Merge branch 'master' into deploy

changes: Improved subsequence matching (stop at knee, symbolization, ...) Improved support for multivariate series (innerdist, bugfixes) Changed differencing to the gust method Removed unnecessary C files to not confuse compilers on various platforms
wannesm · Jun 13, 2024 · 2a22871 · 2a22871
2 parents 4135a3f + ecd9e35
commit 2a22871
Show file tree

Hide file tree

Showing 43 changed files with 1,220 additions and 1,863 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -1,7 +1,5 @@
 version: 2
 
-requirements_file: requirements.txt
-
 build:
   os: ubuntu-22.04
   tools:

diff --git a/docs/conf.py b/docs/conf.py
@@ -33,7 +33,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = ['sphinx.ext.autodoc',
-    'sphinx.ext.mathjax']
+              'sphinx.ext.mathjax']
 
 autoclass_content = 'both'
 
@@ -51,17 +51,17 @@
 
 # General information about the project.
 project = 'DTAIDistance'
-copyright = '2018-2022, Wannes Meert'
+copyright = '2018-2024, Wannes Meert'
 author = 'Wannes Meert'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '2.2'
+version = '2.3'
 # The full version, including alpha/beta/rc tags.
-release = '2.2.1'
+release = '2.3.9'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -157,6 +157,3 @@
      author, 'DTAIDistance', 'One line description of project.',
      'Miscellaneous'),
 ]
-
-
-
diff --git a/docs/index.rst b/docs/index.rst
@@ -30,6 +30,7 @@ Source available on https://github.com/wannesm/dtaidistance.
    usage/subsequence
    usage/sequence
    usage/similarity
+   usage/advanced
    usage/changelist
 
 
@@ -45,6 +46,7 @@ Source available on https://github.com/wannesm/dtaidistance.
    modules/ed
    modules/clustering
    modules/subsequence
+   modules/preprocessing
 
 
 Indices and tables

diff --git a/docs/modules/dtw.rst b/docs/modules/dtw.rst
@@ -1,3 +1,6 @@
 
 .. automodule:: dtaidistance.dtw
    :members:
+
+.. autoclass:: dtaidistance.dtw.DTWSettings
+   :members:
diff --git a/docs/modules/preprocessing.rst b/docs/modules/preprocessing.rst
@@ -0,0 +1,3 @@
+
+.. automodule:: dtaidistance.preprocessing
+   :members:
diff --git a/docs/modules/subsequence.rst b/docs/modules/subsequence.rst
@@ -5,4 +5,6 @@ subsequence
 .. toctree::
    :caption: Subsequence
 
-   subsequence/dtw
+   subsequence/subsequencesearch
+   subsequence/subsequencealignment
+   subsequence/localconcurrences
diff --git a/docs/modules/subsequence/dtw.rst b/docs/modules/subsequence/dtw.rst
diff --git a/docs/modules/subsequence/localconcurrences.rst b/docs/modules/subsequence/localconcurrences.rst
@@ -0,0 +1,5 @@
+
+.. automodule:: dtaidistance.subsequence.localconcurrences
+   :members:
+   :undoc-members:
+   :inherited-members:
diff --git a/docs/modules/subsequence/subsequencealignment.rst b/docs/modules/subsequence/subsequencealignment.rst
@@ -0,0 +1,5 @@
+
+.. automodule:: dtaidistance.subsequence.subsequencealignment
+   :members:
+   :undoc-members:
+   :inherited-members:
diff --git a/docs/modules/subsequence/subsequencesearch.rst b/docs/modules/subsequence/subsequencesearch.rst
@@ -0,0 +1,5 @@
+
+.. automodule:: dtaidistance.subsequence.subsequencesearch
+   :members:
+   :undoc-members:
+   :inherited-members:
diff --git a/docs/usage/advanced.rst b/docs/usage/advanced.rst
@@ -0,0 +1,20 @@
+Advanced features
+-----------------
+
+Use float instead of double
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The fast version is based on C, which defaults to the double
+datatype. It is possible to compile the C code to use float or
+integers if that is required (requires a C compiler and make):
+
+::
+
+    git clone https://github.com/wannesm/dtaidistance.git
+    cd dtaidistance/dtaidistance/jinja
+    make float
+    # make int
+    cd ../..
+    make build
+    pip install .
+
diff --git a/dtaidistance/__init__.py b/dtaidistance/__init__.py
@@ -32,7 +32,7 @@
     #                "then run `cd {};python3 setup.py build_ext --inplace`.".format(dtaidistance_dir))
     dtw_cc = None
 
-__version__ = "2.3.11"
+__version__ = "2.3.12"
 __author__ = "Wannes Meert"
 __copyright__ = "Copyright 2017-2022 KU Leuven, DTAI Research Group"
 __license__ = "Apache License, Version 2.0"

diff --git a/dtaidistance/clustering/kmeans.py b/dtaidistance/clustering/kmeans.py
@@ -184,8 +184,6 @@ def kmeansplusplus_centers(self, series, use_c=False):
             raise NumpyException("Numpy is required for the KMeans.kmeansplusplus_centers method.")
         logger.debug('Start K-means++ initialization ... ')
         ndim = self.series.detected_ndim
-        print(self.dists_options)
-        print(dtw_ndim.distance(series[0], series[5], **self.dists_options))
         if use_c:
             if ndim == 1:
                 fn = distance_matrix_fast
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@

		.. automodule:: dtaidistance.preprocessing
		:members: