all_tags#

all_tags(estimator_types=None, as_dataframe=False)[source]#

Get a list of all tags from sktime.

All objects in sktime are tagged with a set of :term``tag``s. This function allows to list all tags, optionally filtered by the object scitype they apply to.

Parameters:
estimator_types: string, list of string, optional (default=None)

The object type (scitype) for which applicable tags should be listed.

  • If None, no filter is applied and tags for all estimators are returned.

  • Possible values are identifier strings for object scitypes, such as "forecaster", "classifier", ``"transformer", or lists thereof. If list, finds tags applicable to at least one of the listed types. Valid scitype strings are in sktime.registry.BASE_CLASS_SCITYPE_LIST.

as_dataframe: bool, optional (default=False)

if False, return is as described below; if True, return is converted into a pandas.DataFrame for pretty display

Returns:
tags: list of tuples (a, b, c, d),

in alphabetical order by a

a : string - name of the tag as used in the _tags dictionary

b : string - name of the scitype this tag applies to, as in .BASE_CLASS_SCITYPE.LIST

c : string - expected type of the tag value, one of:

  • "bool" - valid values are True/False

  • "int" - valid values are all integers

  • "str" - valid values are all strings

  • ("str", "list_of_string") - any string in list_of_string is valid

  • ("list", "list_of_string") - any string element or sub-list is valid

d : string - plain English description of the tag