aeon icon indicating copy to clipboard operation
aeon copied to clipboard

[DOC] Add individual estimator capabilities in the documentation

Open baraline opened this issue 2 months ago • 0 comments

Describe the issue linked to the documentation

Following #1242 and #1426, we would like to add the estimator capabilities in the API documentation. While an automatic way to do this would be best, another option is to manually add a table in the docstring of each estimator.

One way to (manually) achieve the result would be to use the notes sections of the class docstring as follows:

Notes
-----
   +-----------------+----------------+
   | Capability      |    Support     |
   +=================+================+
   | multivariate    |       ✗        |
   +-----------------+----------------+
   | missing values  |       ✓        |
   +-----------------+----------------+
   | unequal length  |       ✓        |
   +-----------------+----------------+

The value of these tags can be determined by calling the estimator.get_class_tags() .

Suggest a potential alternative/fix

No response

baraline avatar Apr 16 '24 08:04 baraline