-
Notifications
You must be signed in to change notification settings - Fork 10
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
docs: add doc strings to the neural networks architectures #630
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Really nice that these functions have docstrings now.
I do think that these could be further improved, but not sure if we are willing to put the time in right now. Right now there is still no basis for a user to decide which network would be the most suitable for them.
Also, ideally, we would start adding the missing type annotations (for which the linting rules are currently suppressed in these modules). When I implemented ruff, I found that it was a lot of hassle to do so, and realize that this is still true. As above, not sure if it's worth spending more time figuring out what the types are for each element in each of these functions/classes.
I agree, but since we have not yet implemented these networks and many lack detailed references, providing more specific information might be challenging. The key aspect for the user is understanding whether a network is suitable for regression, classification, or both, and this information is there. Given the lack of a one-size-fits-all architecture, experimenting with different networks is often necessary (more detailed descriptions and prior applications can of course be useful but they don’t guarantee optimal performance anyway).
While this would be of course a nice improvement, I don’t think it’s worth investing more time in this at this stage. |
No description provided.