diff --git a/docs/source/api_reference/data_format.rst b/docs/source/api_reference/data_format.rst index 6d42cd3a6de..4f232999617 100644 --- a/docs/source/api_reference/data_format.rst +++ b/docs/source/api_reference/data_format.rst @@ -76,6 +76,10 @@ The ``Series`` mtype represents a single time series. .. currentmodule:: sktime.datatypes._series._check +.. autosummary:: + :toctree: auto_generated/ + :template: class.rst + SeriesPdDataFrame SeriesPdSeries SeriesNp2D @@ -93,6 +97,10 @@ The ``Panel`` mtype represents a flat collection of time series. .. currentmodule:: sktime.datatypes._panel._check +.. autosummary:: + :toctree: auto_generated/ + :template: class.rst + PanelPdMultiIndex PanelNp3D PanelDfList @@ -109,6 +117,10 @@ The ``Hierarchical`` mtype represents a hierarchical collection of time series. .. currentmodule:: sktime.datatypes._hierarchical._check +.. autosummary:: + :toctree: auto_generated/ + :template: class.rst + HierarchicalPdMultiIndex HierarchicalDask HierarchicalPolarsEager @@ -121,6 +133,10 @@ The ``Table`` mtype represents a (non-temporal) data frame table. .. currentmodule:: sktime.datatypes._table._check +.. autosummary:: + :toctree: auto_generated/ + :template: class.rst + TablePdDataFrame TablePdSeries TableNp1D diff --git a/sktime/datatypes/_table/_base.py b/sktime/datatypes/_table/_base.py index 0c12cfa7c0f..4742704e1d7 100644 --- a/sktime/datatypes/_table/_base.py +++ b/sktime/datatypes/_table/_base.py @@ -6,8 +6,8 @@ from sktime.datatypes._base import BaseDatatype -class BaseTable(BaseDatatype): - """Base class for Table data types. +class ScitypeTable(BaseDatatype): + """Data Frame or Table data type. Parameters ---------- diff --git a/sktime/datatypes/_table/_check.py b/sktime/datatypes/_table/_check.py index a6e7c7872e1..4517e733866 100644 --- a/sktime/datatypes/_table/_check.py +++ b/sktime/datatypes/_table/_check.py @@ -39,12 +39,12 @@ from sktime.datatypes._base._common import _req, _ret from sktime.datatypes._dtypekind import _get_feature_kind, _get_table_dtypekind -from sktime.datatypes._table._base import BaseTable +from sktime.datatypes._table._base import ScitypeTable PRIMITIVE_TYPES = (float, int, str) -class TablePdDataFrame(BaseTable): +class TablePdDataFrame(ScitypeTable): """Data type: pandas.DataFrame based specification of data frame table. Parameters are inferred by check. @@ -138,7 +138,7 @@ def _check_pddataframe_table(obj, return_metadata=False, var_name="obj"): return _ret(True, None, metadata, return_metadata) -class TablePdSeries(BaseTable): +class TablePdSeries(ScitypeTable): """Data type: pandas.Series based specification of data frame table. Parameters are inferred by check. @@ -237,7 +237,7 @@ def _check_pdseries_table(obj, return_metadata=False, var_name="obj"): return _ret(True, None, metadata, return_metadata) -class TableNp1D(BaseTable): +class TableNp1D(ScitypeTable): """Data type: 1D np.ndarray based specification of data frame table. Parameters are inferred by check. @@ -336,7 +336,7 @@ def _check_numpy1d_table(obj, return_metadata=False, var_name="obj"): return _ret(True, None, metadata, return_metadata) -class TableNp2D(BaseTable): +class TableNp2D(ScitypeTable): """Data type: 2D np.ndarray based specification of data frame table. Parameters are inferred by check. @@ -434,7 +434,7 @@ def _check_numpy2d_table(obj, return_metadata=False, var_name="obj"): return _ret(True, None, metadata, return_metadata) -class TableListOfDict(BaseTable): +class TableListOfDict(ScitypeTable): """Data type: list of dict based specification of data frame table. Parameters are inferred by check. @@ -555,7 +555,7 @@ def _check_list_of_dict_table(obj, return_metadata=False, var_name="obj"): return _ret(True, None, metadata, return_metadata) -class TablePolarsEager(BaseTable): +class TablePolarsEager(ScitypeTable): """Data type: eager polars DataFrame based specification of data frame table. Parameters are inferred by check. @@ -620,7 +620,7 @@ def _check(self, obj, return_metadata=False, var_name="obj"): return check_polars_frame(obj, return_metadata, var_name, lazy=False) -class TablePolarsLazy(BaseTable): +class TablePolarsLazy(ScitypeTable): """Data type: lazy polars DataFrame based specification of data frame table. Parameters are inferred by check.