-
Notifications
You must be signed in to change notification settings - Fork 56
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
Improved API reference structure for probnum.problems
#461
Improved API reference structure for probnum.problems
#461
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.
Thanks for doing these tedious bits. I like the re-arrangement of the problems docs. Just one comment on where the linalg utils should go.
@@ -0,0 +1,6 @@ | |||
probnum.utils.linalg |
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.
Souldn't these go under linalg API? I.e., probnum.linalg.utils
instead of probnum.utils.linalg
? It does't seem right to move sth specific to a general package.
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.
Possibly yes. This should be a separate refactoring issue however. Since this is up in the air, I removed the utils
part of the refactoring.
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.
Sure, we can discuss that later as well. It might be easier then to leave the utils part in this PR since it is easy to see which util function belong to linalg
. and we can still see later if we want to move it. Does that make sense?
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.
The idea behind moving the Cholesky updates to (the thereby created) utils.linalg
instead of linalg.utils
was (a) Cholesky updates are a linear algebra tool for PN algorithms, and not a probabilistic linear solver, and (b) they are needed in e.g. statespace
, and a linalg dependency for this small thing would've been a bit weird in my opinion. If you have stronger reasons to move it there, though, I am happy to discuss :)
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.
I see, then simply the namespace is confusing as is may imply that the utils.linalg
are only required by linalg
subpackage. If the utils are used by multiple subpackages they should stay where they are (perhaps with a different namespace.) Thanks for the explanation @pnkraemer !
This reverts commit 97197d7.
In a Nutshell
Changes the API reference structure for the
probnum.problems
andprobnum.utils
subpackage to make the hierarchy immediately understandable and closer to the actual package hierarchy.Detailed Description
Improves and stratifies the sidebar menu for
probnum.problems
in the API reference, like so:Related Issues
This implements #450 for
probnum.problems
.