CriticalDifferenceDiagram

class CriticalDifferenceDiagram(metric=None, lower_is_better=True, alpha=0.05, width=10, textspace=2.5, reverse=True)[source]

Critical-difference (CD) diagram evaluator.

Object-oriented wrapper around sktime.benchmarking.critical_difference.plot_critical_difference. It computes average ranks and statistically similar cliques (Friedman + Nemenyi) and renders the Demsar critical-difference diagram.

The diagram is the intended rendering primitive for the future Hugging Face leaderboard; plot returns a (fig, ax) tuple so the figure can be embedded without rendering side effects.

Parameters:

metricstr, optional (default=None): Metric to analyse; see BaseBenchmarkAnalyzer.
lower_is_betterbool, optional (default=True): Whether lower scores are better; forwarded as is_errors to the underlying diagram.
alphafloat, optional (default=0.05): Significance level. One of 0.01, 0.05 or 0.1.
widthint, optional (default=10): Figure width in inches.
textspacefloat, optional (default=2.5): Space (in inches) reserved on the figure sides for method names.
reversebool, optional (default=True): If True, the lowest rank is drawn on the right.

Methods

`clone`()	Obtain a clone of the object with same hyper-parameters and config.
`clone_tags`(estimator[, tag_names])	Clone tags from another object as dynamic override.
`create_test_instance`([parameter_set])	Construct an instance of the class, using first test parameter set.
`create_test_instances_and_names`([parameter_set])	Create list of all test instances and a list of names for them.
`evaluate`(results)	Compute results of the benchmark analysis, on benchmark results.
`get_class_tag`(tag_name[, tag_value_default])	Get class tag value from class, with tag level inheritance from parents.
`get_class_tags`()	Get class tags from class, with tag level inheritance from parent classes.
`get_config`()	Get config flags for self.
`get_param_defaults`()	Get object's parameter defaults.
`get_param_names`([sort])	Get object's parameter names.
`get_params`([deep])	Get a dict of parameters values for this object.
`get_tag`(tag_name[, tag_value_default, ...])	Get tag value from instance, with tag level inheritance and overrides.
`get_tags`()	Get tags from instance, with tag level inheritance and overrides.
`get_test_params`([parameter_set])	Return testing parameter settings for the evaluator.
`is_composite`()	Check if the object is composed of other BaseObjects.
`load_from_path`(serial)	Load object from file location.
`load_from_serial`(serial)	Load object from serialized memory container.
`plot`(results)	Render the critical-difference diagram.
`reset`()	Reset the object to a clean post-init state.
`save`([path, serialization_format])	Save serialized self to bytes-like object or to (.zip) file.
`set_config`(**config_dict)	Set config flags to given values.
`set_params`(**params)	Set the parameters of this object.
`set_random_state`([random_state, deep, ...])	Set random_state pseudo-random seed parameters for self.
`set_tags`(**tag_dict)	Set instance level tag overrides to given values.