Move base classes to skbase.base

skbase/__init__.py

@@ -6,6 +6,10 @@
 The included functionality makes it easy to re-use scikit-learn and
 sktime design principles in your project.
 """
+import warnings
+
+from skbase.base import BaseEstimator, BaseObject, _HeterogenousMetaEstimator
+from skbase.lookup import all_objects, get_package_metadata
 
 __version__ = "0.2.0"
 
@@ -18,6 +22,15 @@
     "get_package_metadata",
 ]
 
-from skbase._base import BaseEstimator, BaseObject
-from skbase._lookup import all_objects, get_package_metadata
-from skbase._meta import _HeterogenousMetaEstimator
+warnings.warn(
+    " ".join(
+        [
+            "Importing from the `skbase` module is deprecated as of version 0.3.0.",
+            "Ability to import from `skbase` will be removed in version 0.5.0."
+            "Import BaseObject, BaseEstimator, and _HeterogenousMetaEstimator"
+            "from skbase.base. Import lookup functionality "
+            "(all_objects, get_package_metadata) from skbase.lookup.",
+        ]
+    ),
+    DeprecationWarning,
+)

skbase/base/__init__.py

@@ -0,0 +1,18 @@
+#!/usr/bin/env python3 -u
+# -*- coding: utf-8 -*-
+# copyright: skbase developers, BSD-3-Clause License (see LICENSE file)
+""":mod:`skbase.base` contains base classes for creating parametric objects.
+
+The included functionality makes it easy to re-use scikit-learn and
+sktime design principles in your project.
+"""
+
+__author__ = ["mloning", "RNKuhns", "fkiraly"]
+__all__ = [
+    "BaseObject",
+    "BaseEstimator",
+    "_HeterogenousMetaEstimator",
+]
+
+from skbase.base._base import BaseEstimator, BaseObject
+from skbase.base._meta import _HeterogenousMetaEstimator

skbase/_meta.py → skbase/base/_meta.py

@@ -11,7 +11,7 @@
 
 from inspect import isclass
 
-from skbase import BaseEstimator
+from skbase.base._base import BaseEstimator
 
 
 class _HeterogenousMetaEstimator(BaseEstimator):