New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Reformat doc section relative to OOD methods #83

Open

y-prudent opened this issue Nov 7, 2023 · 0 comments

Member

y-prudent commented Nov 7, 2023

OOD methods documentation: https://deel-ai.github.io/oodeel/api/methods/

The API documentation of OOD methods is messy and difficult to read. Some suggestions:

Do not display irrelevant private methods.
Find a way to make the fit method appear in the docstring. It would also be nice to have a personalized fit docstring per method.
Create one markdown page per method to add some examples and guidelines.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment