refactor dummy to naive (#2831)

Author: TonyBagnall

aeon/forecasting/__init__.py

@@ -1,13 +1,13 @@
 """Forecasters."""
 
 __all__ = [
-    "DummyForecaster",
+    "NaiveForecaster",
     "BaseForecaster",
     "RegressionForecaster",
     "ETSForecaster",
 ]
 
-from aeon.forecasting._dummy import DummyForecaster
 from aeon.forecasting._ets import ETSForecaster
+from aeon.forecasting._naive import NaiveForecaster
 from aeon.forecasting._regression import RegressionForecaster
 from aeon.forecasting.base import BaseForecaster

aeon/forecasting/_dummy.py renamed to aeon/forecasting/_naive.py

@@ -1,24 +1,24 @@
-"""DummyForecaster always predicts the last value seen in training."""
+"""Naive Forecaster."""
 
 from aeon.forecasting.base import BaseForecaster
 
 
-class DummyForecaster(BaseForecaster):
-    """Dummy forecaster always predicts the last value seen in training."""
+class NaiveForecaster(BaseForecaster):
+    """Naive forecaster that always predicts the last value seen in training."""
 
     def __init__(self):
-        """Initialize DummyForecaster."""
+        """Initialize NaiveForecaster."""
         self.last_value_ = None
         super().__init__(horizon=1, axis=1)
 
     def _fit(self, y, exog=None):
-        """Fit dummy forecaster."""
+        """Fit Naive forecaster."""
         y = y.squeeze()
         self.last_value_ = y[-1]
         return self
 
     def _predict(self, y=None, exog=None):
-        """Predict using dummy forecaster."""
+        """Predict using Naive forecaster."""
         return self.last_value_
 
     def _forecast(self, y, exog=None):

aeon/forecasting/base.py

@@ -4,6 +4,9 @@
 
 """
 
+__maintainer__ = ["TonyBagnall"]
+__all__ = ["BaseForecaster"]
+
 from abc import abstractmethod
 
 import numpy as np

aeon/forecasting/tests/test_base.py

@@ -4,12 +4,12 @@
 import pandas as pd
 import pytest
 
-from aeon.forecasting import DummyForecaster
+from aeon.forecasting import NaiveForecaster
 
 
 def test_base_forecaster():
     """Test base forecaster functionality."""
-    f = DummyForecaster()
+    f = NaiveForecaster()
     y = np.random.rand(50)
     f.fit(y)
     p1 = f.predict()
@@ -26,7 +26,7 @@ def test_base_forecaster():
 
 def test_convert_y():
     """Test y conversion in forecasting base."""
-    f = DummyForecaster()
+    f = NaiveForecaster()
     y = np.random.rand(50)
     with pytest.raises(ValueError, match="Input axis should be 0 or 1"):
         f._convert_y(y, axis=2)

examples/forecasting/forecasting.ipynb

@@ -193,9 +193,9 @@
    "cell_type": "code",
    "source": [
     "# Fit then predict\n",
-    "from aeon.forecasting import DummyForecaster\n",
+    "from aeon.forecasting import NaiveForecaster\n",
     "\n",
-    "d = DummyForecaster()\n",
+    "d = NaiveForecaster()\n",
     "print(d.get_tag(\"y_inner_type\"))\n",
     "d.fit(y)\n",
     "p = d.predict()\n",