IBM / snapml-docs

IBM Snap ML Documentation
Apache License 2.0
0 stars 3 forks source link

added the following inherited methods to the docs: #5

Closed martin-petermann closed 2 years ago

martin-petermann commented 3 years ago

get_params score set_params

andreea-anghel commented 3 years ago

Simply removing the list of inherited classes from inherited-members automatically adds all the members of all the inherited classes to the docs? The three new functions will appear in our documentation with their corresponding definition from scikit-learn?

martin-petermann commented 3 years ago

Simply removing the list of inherited classes from inherited-members automatically adds all the members of all the inherited classes to the docs? The three new functions will appear in our documentation with their corresponding definition from scikit-learn?

Yes, this is the case. Furthermore: I only added BaseEstimator but also score from RegressorMixin has not been documented. If I remove BaseEstimator also score gets documented.

The docs on https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html say the following: For example; If your class Foo is derived from list class and you don’t want to document list.len(), you should specify a option :inherited-members: list to avoid special members of list class. It's a bit strange and also in combination with other options I do not see a consistent way how sphinx handle the different settings.