Add deprecation warning for old ARIMA primitive (#10)

* Bump version: 0.1.4.dev0 → 0.1.4.dev1 * deprecate arima JSON * add warning
sintel-dev · Oct 1, 2023 · 84ddb36 · 84ddb36
1 parent 9297173
commit 84ddb36
Show file tree

Hide file tree

Showing 6 changed files with 84 additions and 4 deletions.
diff --git a/mlstars/__init__.py b/mlstars/__init__.py
@@ -2,7 +2,7 @@
 
 __author__ = 'MIT Data To AI Lab'
 __email__ = 'dailabmit@gmail.com'
-__version__ = '0.1.4.dev0'
+__version__ = '0.1.4.dev1'
 
 import os
 

diff --git a/mlstars/adapters/statsmodels.py b/mlstars/adapters/statsmodels.py
@@ -1,9 +1,17 @@
+import warnings
+
 import numpy as np
 from statsmodels.tsa.arima import model
 
+_ARIMA_MODEL_DEPRECATION_WARNING = (
+    "statsmodels.tsa.arima_model.Arima is deprecated "
+    "and will be removed in a future version. Please use "
+    "statsmodels.tsa.arima.model.ARIMA instead."
+)
+
 
 class ARIMA(object):
-    """A Wrapper for the statsmodels.tsa.arima_model.ARIMA class."""
+    """A Wrapper for the statsmodels.tsa.arima.model.ARIMA class."""
 
     def __init__(self, p, d, q, trend, steps):
         """Initialize the ARIMA object.
@@ -22,6 +30,8 @@ def __init__(self, p, d, q, trend, steps):
             steps (int):
                 Integer denoting the number of time steps to predict ahead.
         """
+        warnings.warn(_ARIMA_MODEL_DEPRECATION_WARNING, DeprecationWarning)
+
         self.p = p
         self.d = d
         self.q = q

diff --git a/mlstars/primitives/statsmodels.tsa.arima.model.ARIMA.json b/mlstars/primitives/statsmodels.tsa.arima.model.ARIMA.json
@@ -28,6 +28,10 @@
     },
     "hyperparameters": {
         "fixed": {
+            "trend": {
+                "type": "str",
+                "default": "t"
+            },
             "steps": {
                 "type": "int",
                 "default": 10

diff --git a/mlstars/primitives/statsmodels.tsa.arima_model.Arima.json b/mlstars/primitives/statsmodels.tsa.arima_model.Arima.json
@@ -0,0 +1,66 @@
+{
+    "name": "statsmodels.tsa.arima_model.Arima",
+    "contributors": [
+        "Alexander Geiger <geigera@mit.edu>"
+    ],
+    "description": "ARIMA Model; mstatsmodels.tsa.arima_model.Arima is deprecated and will be removed in a future version. Please use statsmodels.tsa.arima.model.ARIMA instead.",
+    "classifiers": {
+        "type": "estimator",
+        "subtype": "regressor"
+    },
+    "modalities": [],
+    "primitive": "mlstars.adapters.statsmodels.ARIMA",
+    "produce": {
+        "method": "predict",
+        "args": [
+            {
+                "name": "X",
+                "type": "ndarray"
+            }
+        ],
+        "output": [
+            {
+                "name": "y",
+                "type": "ndarray"
+            }
+        ]
+    },
+    "hyperparameters": {
+        "fixed": {
+            "trend": {
+                "type": "str",
+                "default": "t"
+            },
+            "steps": {
+                "type": "int",
+                "default": 10
+            }
+        },
+        "tunable": {
+            "p": {
+                "type": "int",
+                "default": 1,
+                "range": [
+                    0,
+                    40
+                ]
+            },
+            "d": {
+                "type": "int",
+                "default": 0,
+                "range": [
+                    0,
+                    3
+                ]
+            },
+            "q": {
+                "type": "int",
+                "default": 0,
+                "range": [
+                    0,
+                    12
+                ]
+            }
+        }
+    }
+}
diff --git a/setup.cfg b/setup.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.1.4.dev0
+current_version = 0.1.4.dev1
 commit = True
 tag = True
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\.(?P<release>[a-z]+)(?P<candidate>\d+))?

diff --git a/setup.py b/setup.py
@@ -109,6 +109,6 @@
     test_suite='tests',
     tests_require=tests_require,
     url='https://github.com/sintel-dev/ml-stars',
-    version='0.1.4.dev0',
+    version='0.1.4.dev1',
     zip_safe=False,
 )