[enhancement] Add basic info on model_weight units#823
Open
Conversation
maxbriel
changed the title
model_weight unitsmodel_weight units
sgossage
reviewed
Mar 18, 2026
| Parameters | ||
| ---------- | ||
| pop_data : dict | ||
| Dictionary containing the population data |
Contributor
There was a problem hiding this comment.
I think we should add details about what the dictionary is comprised of (similar for simulation_parameters and population_parameters below).
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This adds some essential information to the
model_weightdocstrings, such as its units.In the future, I think the model weights require a more extensive documentation page, especially showing which methods are supported and how one can reweight populations with different options.