Skip to content
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.

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

Add code to measures module #25

Open
linuswagner opened this issue Sep 1, 2020 · 2 comments
Open

Add code to measures module #25

linuswagner opened this issue Sep 1, 2020 · 2 comments

Comments

@linuswagner
Copy link
Member

measures needs some docstrings to ease the understanding of the methods for someone that works with the measures the first time.
Besides the basic argument explanation it would be helpful to find a link or a short explanation for each measure to get a feeling for what it does.
At the moment one has to go through the code in order to understand or guess the functionality, which makes the library harder to use and might lead to reimplementations in own projects of already existing code.

@linuswagner
Copy link
Member Author

I'd assume, this is a task for @KonstantinWilleke or @sacadena (if others also see this as an issue. If not, feel free to close this issue)

@KonstantinWilleke
Copy link
Contributor

Thanks Linus, you are quite right. All of these measures need docstrings, it's on my to-do list. I'll assign the issue to myself. In the long (hopefully not too long) term, these measures will go to mlutils, with docstrings and all.
In the meantime, feel free to ask me anything about the code there!

kellirestivo referenced this issue in kellirestivo/nnvision Oct 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants