pyts.metrics
.show_options¶
-
pyts.metrics.
show_options
(method=None, disp=True)[source]¶ Show documentation for additional options of Dynamic Time Warping 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. Otherwise, shows only the options for the specified method. If str, it must be either ‘classic’, ‘sakoechiba’, ‘itakura’, ‘region’, ‘multiscale’ or ‘fast’.
- disp : bool (default = True)
Whether to print the result rather than returning it.
Returns: - text : None or str
Either None (if
disp=True
) or the text string (ifdisp=False
).
Notes
The available methods are: