Networks docstrings: add summary/inference network indicator #462
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- From the table in the `bayesflow.networks` module overview, one cannot tell which network belongs to which group. This commit adds short labels to indicate inference networks (IN) and summary networks (SN)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
From the table in the
bayesflow.networksmodule overview, one cannot tell whether a network is a summary network, an inference network, or neither. This PR adds short labels to indicate inference networks (IN) and summary networks (SN), so one can easily identify them.The information is redundant, as the classes are also subclasses of InferenceNetwork/SummaryNetwork, but until now, this information isn't easily accessible to end users (you have to click on the class first to see the "Bases: ..." label). This is one possible fix. Do you like it this way or do you have different ideas on how to fix this?