Registry lookup - all_estimators refactor, and new all_tags (#1196)

This PR consolidates registry lookup in the `registry` module: * `all_estimators` is moved to the `registry`, with all dependencies referencing the new location * `all_estimators` has a new argument `filter_tags`, which allows to filter by tags (incl scitypes, capabilities, etc); order of arguments has been changed so filtering is first, output format args last * new lookup function `all_tags`, which allows to lookup tags, possibly filtered by estimator type * both lookups have a new argument `as_dataframe`, which allows for pretty printing in jupyter notebooks, useful for the standard user archetype
sktime · Jul 26, 2021 · d1b5ffa · d1b5ffa
1 parent d296230
commit d1b5ffa
Show file tree

Hide file tree

Showing 16 changed files with 352 additions and 197 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -224,7 +224,7 @@ def find_source():
 def _make_estimator_overview(app):
     """Make estimator overview table."""
     import pandas as pd
-    from sktime.utils import all_estimators
+    from sktime.registry import all_estimators
 
     def _process_author_info(author_info):
         """

diff --git a/examples/01_forecasting.ipynb b/examples/01_forecasting.ipynb
@@ -1341,7 +1341,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from sktime.utils import all_estimators"
+    "from sktime.registry import all_estimators"
    ]
   },
   {
@@ -1360,7 +1360,7 @@
    "outputs": [],
    "source": [
     "# all_estimators returns list of pairs - data frame conversion for pretty printing\n",
-    "pd.DataFrame(all_estimators(\"forecaster\"), columns=[\"name\", \"class\"])"
+    "all_estimators(\"forecaster\", as_dataframe=True)"
    ]
   },
   {

diff --git a/examples/02_classification_univariate.ipynb b/examples/02_classification_univariate.ipynb
@@ -1458,9 +1458,9 @@
     }
    ],
    "source": [
-    "from sktime.utils import all_estimators\n",
+    "from sktime.registry import all_estimators\n",
     "\n",
-    "all_estimators(estimator_types=\"classifier\")"
+    "all_estimators(estimator_types=\"classifier\", as_dataframe=True)"
    ]
   }
  ],

diff --git a/sktime/annotation/tests/test_all_annotators.py b/sktime/annotation/tests/test_all_annotators.py
@@ -3,7 +3,7 @@
 
 import pytest
 from sktime.utils._testing.estimator_checks import _construct_instance, _make_args
-from sktime.utils import all_estimators
+from sktime.registry import all_estimators
 
 ALL_ANNOTATORS = all_estimators(estimator_types="series-annotator", return_names=False)
 

diff --git a/sktime/dists_kernels/tests/test_all_dist_kernels.py b/sktime/dists_kernels/tests/test_all_dist_kernels.py
@@ -2,7 +2,7 @@
 import numpy as np
 import pytest
 
-from sktime.utils import all_estimators
+from sktime.registry import all_estimators
 from sktime.utils._testing.panel import make_transformer_problem
 from sktime.tests._config import ESTIMATOR_TEST_PARAMS
 

diff --git a/sktime/dists_kernels/tests/test_compose_tab_to_panel.py b/sktime/dists_kernels/tests/test_compose_tab_to_panel.py
@@ -3,7 +3,7 @@
 from sktime.dists_kernels.compose_tab_to_panel import AggrDist
 from sktime.dists_kernels.scipy_dist import ScipyDist
 from sktime.utils._testing.panel import make_transformer_problem
-from sktime.utils import all_estimators
+from sktime.registry import all_estimators
 
 PAIRWISE_TRANSFORMERS_TAB = all_estimators(
     estimator_types="transformer-pairwise", return_names=False

diff --git a/sktime/forecasting/tests/test_all_forecasters.py b/sktime/forecasting/tests/test_all_forecasters.py
@@ -37,7 +37,7 @@
 from sktime.performance_metrics.forecasting import (
     mean_absolute_percentage_error,
 )
-from sktime.utils import all_estimators
+from sktime.registry import all_estimators
 from sktime.utils._testing.estimator_checks import _construct_instance
 from sktime.utils._testing.forecasting import _assert_correct_pred_time_index
 from sktime.utils._testing.forecasting import _get_expected_index_for_update_predict

diff --git a/sktime/forecasting/tests/test_sktime_forecasters.py b/sktime/forecasting/tests/test_sktime_forecasters.py
@@ -24,7 +24,7 @@
 from sktime.forecasting.base import BaseForecaster
 from sktime.forecasting.base._sktime import _BaseWindowForecaster
 from sktime.forecasting.model_selection import temporal_train_test_split
-from sktime.utils import all_estimators
+from sktime.registry import all_estimators
 from sktime.utils._testing.estimator_checks import _construct_instance
 from sktime.utils._testing.forecasting import make_forecasting_problem
 

diff --git a/sktime/registry/__init__.py b/sktime/registry/__init__.py
@@ -1,6 +1,12 @@
 # -*- coding: utf-8 -*-
+"""Sktime registry module exports."""
+
+from sktime.registry._tags import (
+    ESTIMATOR_TAG_REGISTER,
+    ESTIMATOR_TAG_LIST,
+    check_tag_is_valid,
+)
 
-from sktime.registry._tags import ESTIMATOR_TAG_REGISTER, ESTIMATOR_TAG_LIST
 from sktime.registry._base_classes import (
     BASE_CLASS_REGISTER,
     BASE_CLASS_LIST,
@@ -12,7 +18,13 @@
     TRANSFORMER_MIXIN_SCITYPE_LIST,
 )
 
+from sktime.registry._lookup import all_estimators, all_tags
+
+
 __all__ = [
+    "all_estimators",
+    "all_tags",
+    "check_tag_is_valid",
     "ESTIMATOR_TAG_LIST",
     "ESTIMATOR_TAG_REGISTER",
     "BASE_CLASS_REGISTER",