Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This pull request integrates small example data into the main branch, replacing the SF Bay example as the default configuration for new users. The changes make the project more accessible by providing a smaller, faster-running example dataset for users getting started with DEMOS.
Changes:
- Updates documentation (README.md and intro.md) to point to the new small example configuration file instead of the SF Bay example
- Improves calibration documentation by clarifying how to skip calibration procedures
- Adds max_iter safeguard to the kids_moving calibration loop to prevent infinite iterations
- Adds comprehensive small example data files including observed calibration values and pre-calibrated model coefficients
- Removes SF Bay example observed calibration data files (keeping only the main dataset)
- Updates configuration to use the small example data with adjusted calibration parameters
Reviewed changes
Copilot reviewed 25 out of 37 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/source/pages/intro.md | Updated curl command to download small example config instead of SF Bay config |
| docs/source/pages/advanced_configuration.md | Improved documentation on skipping calibration with better formatting and clearer instructions |
| demos/models/kids_moving.py | Added max_iter check to calibration loop to prevent infinite iterations |
| demos/config.py | Added max_iter field to KidsMovingModuleConfig with default value of 100 |
| data/small_example/* | Added comprehensive small example data including relational mapping, observed calibration values, and pre-calibrated model coefficients |
| data/sf_bay_example/observed_calibration_values/* | Removed observed calibration CSV files (main dataset files remain) |
| data/.gitignore | Added small_example directory to whitelist for version control |
| configuration/demos_config_small_example.toml | Updated paths and parameters for small example dataset |
| README.md | Updated curl command to download small example config instead of SF Bay config |
Comments suppressed due to low confidence (3)
configuration/demos_config_small_example.toml:36
- The inline comment listing alternative file paths (custom_mpo_06197001_model_data_small.h5, minihh.h5, etc.) could be confusing for users. These alternative paths may be outdated or not exist, and could mislead users into thinking they need to use one of these files. Consider removing these comments or clearly marking them as "examples" or "deprecated options" if they serve a documentation purpose.
configuration/demos_config_small_example.toml:42 - Similar to line 36, the inline comment listing alternative file paths could be confusing for users. Consider removing or clarifying these comments to avoid confusion about which file should actually be used.
configuration/demos_config_small_example.toml:133 - The calibration_tolerance value of 0.01 is 10 times larger than the default value of 0.001 defined in config.py. While this might be intentional for the small example dataset to achieve faster convergence, it results in less precise calibration. Consider adding a comment explaining why a larger tolerance is acceptable for this example, or verify that this increased tolerance is appropriate for the small example data.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
data/small_example/observed_calibration_values/mortalities_over_time_obs_county2.csv
Show resolved
Hide resolved
data/small_example/observed_calibration_values/employment_obs_county.csv
Show resolved
Hide resolved
data/small_example/observed_calibration_values/hsize_ct_06197001_4155.csv
Show resolved
Hide resolved
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
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.
Integrate the work of small example data into the main branch