[MNT] Update similarity search with new base classes : Query Search (#1508)

* Add query search module and base classes

* Add Unequal length support and fix tests

* Update similarity_search.rst

Fix api doc

* Update docstrings and rename q to X

* Update test to account for parameter name change

* Update test

* Fix unequal length mask wrong condition

* Remove BaseSimilaritySearch and update tests/notebook

* Update test and registry

* Fix test lookup

* Fix tags

* Add back BaseSimilaritySearch

* Refactor query search class

* update api reference

* fix typo in test adapted from old dummy

* Fix test fail due to floating point error without numba

Author: baraline

aeon/registry/_base_classes.py

@@ -46,7 +46,7 @@
 from aeon.forecasting.model_selection._split import BaseSplitter
 from aeon.regression.base import BaseRegressor
 from aeon.segmentation.base import BaseSegmenter
-from aeon.similarity_search.base import BaseSimiliaritySearch
+from aeon.similarity_search.base import BaseSimilaritySearch
 from aeon.transformations.base import BaseTransformer
 from aeon.transformations.collection import BaseCollectionTransformer
 from aeon.transformations.series import BaseSeriesTransformer
@@ -66,7 +66,7 @@
     ("series-estimator", BaseSeriesEstimator, "single series estimator"),
     ("series-transformer", BaseSeriesTransformer, "single series transformer"),
     ("splitter", BaseSplitter, "splitter"),
-    ("similarity-search", BaseSimiliaritySearch, "similarity search"),
+    ("similarity-search", BaseSimilaritySearch, "similarity search"),
     ("transformer", BaseTransformer, "transformer"),
 ]
 

aeon/registry/_tags.py

@@ -246,6 +246,7 @@
             "early_classifier",
             "regressor",
             "transformer",
+            "similarity-search",
             "segmenter",
         ],
         "bool",

aeon/similarity_search/__init__.py

@@ -1,13 +1,6 @@
-"""BaseSimilaritySearch."""
+"""Similarity search module."""
 
-__all__ = [
-    "BaseSimiliaritySearch",
-    "TopKSimilaritySearch",
-    "get_speedup_function_names",
-]
+__all__ = ["BaseSimilaritySearch", "QuerySearch"]
 
-from aeon.similarity_search.base import (
-    BaseSimiliaritySearch,
-    get_speedup_function_names,
-)
-from aeon.similarity_search.top_k_similarity import TopKSimilaritySearch
+from aeon.similarity_search.base import BaseSimilaritySearch
+from aeon.similarity_search.query_search import QuerySearch