search

scikit-learn-contrib / scikit-matter

A collection of scikit-learn compatible utilities that implement methods born out of the materials science and chemistry communities
https://scikit-matter.readthedocs.io/en/v0.2.0/
BSD 3-Clause "New" or "Revised" License
70 stars 18 forks source link

Moving to doctest examples #201

Closed agoscinski closed 11 months ago

agoscinski commented 11 months ago

Most if it is rather straightforward. Still need to change some existing code blocks. But I also need to change the way the python API is embedded into the doc to include the doctest which is in the python code. See change

.. autoclass:: skmatter.feature_selection.CUR
   :members:
   :undoc-members:
   :inherited-members:
   :show-inheritance:

@rosecers Are you okay with this? Check out https://scikit-matter--201.org.readthedocs.build/en/201/selection.html#cur Then I continue doing it for the other classes.

:books: Documentation preview :books:: https://scikit-matter--201.org.readthedocs.build/en/201/

rosecers commented 11 months ago

Works for me! Will review when it's ready.

agoscinski commented 11 months ago

Its ready