[DOC] Added example to plot_series & fixed example for plot_lags

.all-contributorsrc

@@ -1760,6 +1760,15 @@
         "test"
       ]
     },
+    {
+      "login": "shagn",
+      "name": "Sebastian Hagn",
+      "avatar_url": "https://avatars.githubusercontent.com/u/16029092?v=4",
+      "profile": "https://github.com/shagn",
+      "contributions": [
+        "doc",
+      ]
+    },
   ],
   "projectName": "sktime",
   "projectOwner": "alan-turing-institute",

docs/source/installation.rst

@@ -221,6 +221,7 @@ Virtual environments
 ~~~~~~~~~~~~~~~~~~~~
 
 Two good options for virtual environment managers are:
+
 * `conda <https://uoa-eresearch.github.io/eresearch-cookbook/recipe/2014/11/20/conda/>`_ (many sktime community members us this)
 * `venv <https://realpython.com/python-virtual-environments-a-primer/>`_ (also quite good!).
 

sktime/registry/_lookup.py

@@ -125,6 +125,16 @@ def all_estimators(
             passed in return_tags will serve as column names for all columns of
             tags that were optionally requested.
 
+    Examples
+    --------
+    >>> from sktime.registry import all_estimators
+    >>> # return a complete list of estimators as pd.Dataframe
+    >>> all_estimators(as_dataframe=True)
+    >>> # return all forecasters by filtering for estimator type
+    >>> all_estimators("forecaster")
+    >>> # return all forecasters which handle missing data in the input by tag filtering
+    >>> all_estimators("forecaster", filter_tags={"handles-missing-data": True})
+
     References
     ----------
     Modified version from scikit-learn's `all_estimators()`.

sktime/utils/plotting.py

@@ -38,6 +38,13 @@ def plot_series(
     -------
     fig : plt.Figure
     ax : plt.Axis
+
+    Examples
+    --------
+    >>> from sktime.utils.plotting import plot_series
+    >>> from sktime.datasets import load_airline
+    >>> y = load_airline()
+    >>> fig, ax = plot_series(y)
     """
     _check_soft_dependencies("matplotlib", "seaborn")
     import matplotlib.pyplot as plt
@@ -159,6 +166,7 @@ def plot_lags(series, lags=1, suptitle=None):
 
     Examples
     --------
+    >>> from sktime.utils.plotting import plot_lags
     >>> from sktime.datasets import load_airline
     >>> y = load_airline()
     >>> fig, ax = plot_lags(y, lags=2) # plot of y(t) with y(t-2)  # doctest: +SKIP
@@ -266,6 +274,13 @@ def plot_correlations(
 
     axes : np.ndarray
         Array of the figure's Axe objects
+
+    Examples
+    --------
+    >>> from sktime.utils.plotting import plot_correlations
+    >>> from sktime.datasets import load_airline
+    >>> y = load_airline()
+    >>> fig, ax = plot_correlations(y)
     """
     _check_soft_dependencies("matplotlib")
     import matplotlib.pyplot as plt