pyts.metrics.show_options

pyts.metrics.show_options(method=None, disp=True)

Show documentation for additional options of DTW methods.

These are method-specific options that can be supplied through the options dict.

Parameters:

method : None or str (default = None)

If None, shows all methods of the specified solver. Otherwise, show only the options for the specified method. If str, it must be either ‘classic’, ‘sakoechiba’, ‘itakura’, ‘multiscale’ or ‘fast’.

disp : bool (default = True)

Whether to print the result rather than returning it.

Returns:

text

Either None (for disp=True) or the text string (disp=False).