autogluon.timeseries 1.0.1b20231201__tar.gz → 1.0.1b20231203__tar.gz

{autogluon.timeseries-1.0.1b20231201 → autogluon.timeseries-1.0.1b20231203}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: autogluon.timeseries
-Version: 1.0.1b20231201
+Version: 1.0.1b20231203
 Summary: AutoML for Image, Text, and Tabular Data
 Home-page: https://github.com/autogluon/autogluon
 Author: AutoGluon Community

{autogluon.timeseries-1.0.1b20231201 → autogluon.timeseries-1.0.1b20231203}/src/autogluon/timeseries/dataset/ts_dataframe.py

@@ -23,7 +23,23 @@ TIMESTAMP = "timestamp"
 IRREGULAR_TIME_INDEX_FREQSTR = "IRREG"
 
 
-class TimeSeriesDataFrame(pd.DataFrame):
+class TimeSeriesDataFrameDeprecatedMixin:
+    """Contains deprecated methods from TimeSeriesDataFrame that shouldn't show up in API documentation."""
+
+    def get_reindexed_view(self, *args, **kwargs) -> TimeSeriesDataFrame:
+        raise ValueError(
+            "`TimeSeriesDataFrame.get_reindexed_view` has been deprecated. If your data has irregular timestamps, "
+            "please convert it to a regular frequency with `convert_frequency`."
+        )
+
+    def to_regular_index(self, *args, **kwargs) -> TimeSeriesDataFrame:
+        raise ValueError(
+            "`TimeSeriesDataFrame.to_regular_index` has been deprecated. "
+            "Please use `TimeSeriesDataFrame.convert_frequency` instead."
+        )
+
+
+class TimeSeriesDataFrame(pd.DataFrame, TimeSeriesDataFrameDeprecatedMixin):
     """A collection of univariate time series, where each row is identified by an (``item_id``, ``timestamp``) pair.
 
     For example, a time series data frame could represent the daily sales of a collection of products, where each
@@ -47,7 +63,7 @@ class TimeSeriesDataFrame(pd.DataFrame):
                 7        2 2019-01-02       7
                 8        2 2019-01-03       8
 
-            You can also use :meth:`~autogluon.timeseries.TimeSeriesDataFrame.from_data_frame` for loading data in such format.
+        You can also use :meth:`~autogluon.timeseries.TimeSeriesDataFrame.from_data_frame` for loading data in such format.
 
         2. Path to a data file in CSV or Parquet format. The file must contain columns ``item_id`` and ``timestamp``, as well as columns with time series values. This is similar to Option 1 above (pandas DataFrame format without multi-index). Both remote (e.g., S3) and local paths are accepted. You can also use :meth:`~autogluon.timeseries.TimeSeriesDataFrame.from_path` for loading data in such format.
 
@@ -73,7 +89,7 @@ class TimeSeriesDataFrame(pd.DataFrame):
                     {"target": [6, 7, 8], "start": pd.Period("01-01-2019", freq='D')}
                 ]
 
-            You can also use :meth:`~autogluon.timeseries.TimeSeriesDataFrame.from_iterable_dataset` for loading data in such format.
+        You can also use :meth:`~autogluon.timeseries.TimeSeriesDataFrame.from_iterable_dataset` for loading data in such format.
 
     static_features : pd.DataFrame, str or pathlib.Path, optional
         An optional data frame describing the metadata of each individual time series that does not change with time.
@@ -119,8 +135,7 @@ class TimeSeriesDataFrame(pd.DataFrame):
     freq : str
         A pandas-compatible string describing the frequency of the time series. For example ``"D"`` for daily data,
         ``"H"`` for hourly data, etc. This attribute is determined automatically based on the timestamps. For the full
-        list of possible values, see
-        https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#offset-aliases
+        list of possible values, see `pandas documentation <https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#offset-aliases>`_.
     num_items : int
         Number of items (time series) in the data set.
     item_ids : pd.Index
@@ -375,8 +390,7 @@ class TimeSeriesDataFrame(pd.DataFrame):
         """Construct a ``TimeSeriesDataFrame`` from an Iterable of dictionaries each of which
         represent a single time series.
 
-        This function also offers compatibility with GluonTS data sets, see
-        https://ts.gluon.ai/stable/api/gluonts/gluonts.dataset.common.html#gluonts.dataset.common.ListDataset.
+        This function also offers compatibility with GluonTS `ListDataset format <https://ts.gluon.ai/stable/api/gluonts/gluonts.dataset.common.html#gluonts.dataset.common.ListDataset>`_.
 
         Parameters
         ----------
@@ -493,6 +507,17 @@ class TimeSeriesDataFrame(pd.DataFrame):
         return self.groupby(level=ITEMID, sort=False).size()
 
     def copy(self: TimeSeriesDataFrame, deep: bool = True) -> pd.DataFrame:  # noqa
+        """Make a copy of the TimeSeriesDataFrame.
+
+        When ``deep=True`` (default), a new object will be created with a copy of the calling object's data and
+        indices. Modifications to the data or indices of the copy will not be reflected in the original object.
+
+        When ``deep=False``, a new object will be created without copying the calling object's data or index (only
+        references to the data and index are copied). Any changes to the data of the original will be reflected in the
+        shallow copy (and vice versa).
+
+        For more details, see `pandas documentation <https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.copy.html>`_.
+        """
         obj = super().copy(deep=deep)
 
         # also perform a deep copy for static features
@@ -868,7 +893,7 @@ class TimeSeriesDataFrame(pd.DataFrame):
         Parameters
         ----------
         freq : Union[str, pd.DateOffset]
-            Frequency to which the data should be converted. See [pandas frequency aliases](https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#offset-aliases)
+            Frequency to which the data should be converted. See `pandas frequency aliases <https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#offset-aliases>`_
             for supported values.
         agg_numeric : {"max", "min", "sum", "mean", "median", "first", "last"}, default = "mean"
             Aggregation method applied to numeric columns.
@@ -975,15 +1000,3 @@ class TimeSeriesDataFrame(pd.DataFrame):
         # This hides method from IPython autocomplete, but not VSCode autocomplete
         deprecated = ["get_reindexed_view", "to_regular_index"]
         return [d for d in super().__dir__() if d not in deprecated]
-
-    def get_reindexed_view(self, *args, **kwargs) -> TimeSeriesDataFrame:
-        raise ValueError(
-            "`TimeSeriesDataFrame.get_reindexed_view` has been deprecated. If your data has irregular timestamps, "
-            "please convert it to a regular frequency with `convert_frequency`."
-        )
-
-    def to_regular_index(self, *args, **kwargs) -> TimeSeriesDataFrame:
-        raise ValueError(
-            "`TimeSeriesDataFrame.to_regular_index` has been deprecated. "
-            "Please use `TimeSeriesDataFrame.convert_frequency` instead."
-        )

{autogluon.timeseries-1.0.1b20231201 → autogluon.timeseries-1.0.1b20231203}/src/autogluon/timeseries/predictor.py

@@ -26,7 +26,23 @@ from autogluon.timeseries.trainer import AbstractTimeSeriesTrainer
 logger = logging.getLogger(__name__)
 
 
-class TimeSeriesPredictor:
+class TimeSeriesPredictorDeprecatedMixin:
+    """Contains deprecated methods from TimeSeriesPredictor that shouldn't show up in API documentation."""
+
+    @Deprecated(min_version_to_warn="0.8.3", min_version_to_error="1.2", version_to_remove="1.2", new="evaluate")
+    def score(self, *args, **kwargs):
+        return self.evaluate(*args, **kwargs)
+
+    @Deprecated(min_version_to_warn="0.8.3", min_version_to_error="1.2", version_to_remove="1.2", new="model_best")
+    def get_model_best(self) -> str:
+        return self.model_best
+
+    @Deprecated(min_version_to_warn="0.8.3", min_version_to_error="1.2", version_to_remove="1.2", new="model_names")
+    def get_model_names(self) -> str:
+        return self.model_names()
+
+
+class TimeSeriesPredictor(TimeSeriesPredictorDeprecatedMixin):
     """AutoGluon ``TimeSeriesPredictor`` predicts future values of multiple related time series.
 
     ``TimeSeriesPredictor`` provides probabilistic (quantile) multi-step-ahead forecasts for univariate time series.
@@ -937,7 +953,8 @@ class TimeSeriesPredictor:
         * ``score_test``: The test score of the model on ``data``, if provided. Computed according to ``eval_metric``.
         * ``score_val``: The validation score of the model using the internal validation data. Computed according to ``eval_metric``.
 
-            **NOTE:** Metrics scores are always shown in 'higher is better' format.
+        .. note::
+            Metrics scores are always shown in 'higher is better' format.
             This means that metrics such as MASE or MAPE will be multiplied by -1, so their values will be negative.
             This is necessary to avoid the user needing to know the metric to understand if higher is better when
             looking at leaderboard.
@@ -1107,15 +1124,3 @@ class TimeSeriesPredictor:
         # This hides method from IPython autocomplete, but not VSCode autocomplete
         deprecated = ["score", "get_model_best", "get_model_names"]
         return [d for d in super().__dir__() if d not in deprecated]
-
-    @Deprecated(min_version_to_warn="0.8.3", min_version_to_error="1.2", version_to_remove="1.2", new="evaluate")
-    def score(self, *args, **kwargs):
-        return self.evaluate(*args, **kwargs)
-
-    @Deprecated(min_version_to_warn="0.8.3", min_version_to_error="1.2", version_to_remove="1.2", new="model_best")
-    def get_model_best(self) -> str:
-        return self.model_best
-
-    @Deprecated(min_version_to_warn="0.8.3", min_version_to_error="1.2", version_to_remove="1.2", new="model_names")
-    def get_model_names(self) -> List[str]:
-        return self.model_names()

{autogluon.timeseries-1.0.1b20231201 → autogluon.timeseries-1.0.1b20231203}/src/autogluon/timeseries/version.py

@@ -1,3 +1,3 @@
 """This is the autogluon version file."""
-__version__ = '1.0.1b20231201'
+__version__ = '1.0.1b20231203'
 __lite__ = False

{autogluon.timeseries-1.0.1b20231201 → autogluon.timeseries-1.0.1b20231203}/src/autogluon.timeseries.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: autogluon.timeseries
-Version: 1.0.1b20231201
+Version: 1.0.1b20231203
 Summary: AutoML for Image, Text, and Tabular Data
 Home-page: https://github.com/autogluon/autogluon
 Author: AutoGluon Community

{autogluon.timeseries-1.0.1b20231201 → autogluon.timeseries-1.0.1b20231203}/src/autogluon.timeseries.egg-info/requires.txt

@@ -14,9 +14,9 @@ utilsforecast<0.0.11,>=0.0.10
 tqdm<5,>=4.38
 orjson~=3.9
 tensorboard<3,>=2.9
-autogluon.core[raytune]==1.0.1b20231201
-autogluon.common==1.0.1b20231201
-autogluon.tabular[catboost,lightgbm,xgboost]==1.0.1b20231201
+autogluon.core[raytune]==1.0.1b20231203
+autogluon.common==1.0.1b20231203
+autogluon.tabular[catboost,lightgbm,xgboost]==1.0.1b20231203
 
 [all]