Skip to content

Commit

Permalink
added more detailed example for all_estimators function
Browse files Browse the repository at this point in the history
  • Loading branch information
Sebastian Hagn committed Sep 13, 2022
1 parent c773eb4 commit 2567183
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion sktime/registry/_lookup.py
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,12 @@ def all_estimators(
Examples
--------
>>> from sktime.registry import all_estimators
>>> all_estimators("forecaster", as_dataframe=True)
>>> # 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
----------
Expand Down

0 comments on commit 2567183

Please sign in to comment.