Deprecate Time module and all its Schedulers #2306
Merged
Conversation
This file contains 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
Add a warning message that all the whole time module and all its schedulers are deprecated
This commit adds a new section to the migration guide explaining how to replace the deprecated schedulers from the Time module with AgentSet functionality. It covers: - Replacements for BaseScheduler, RandomActivation, SimultaneousActivation, StagedActivation, and RandomActivationByType - General notes on related changes, such as agent counting and management - Examples of how to adapt code using the old scheduler methods
EwoutH
force-pushed
the
deprecate_schedulers
branch
from
0bcbc29
to
3deab7e
Compare
rht
reviewed
Sep 21, 2024
|
Updated the migration guide, so this PR is ready for review. A rendered version of the migration guide can be viewed here. |
quaquel
approved these changes
Sep 21, 2024
rht
reviewed
Sep 21, 2024
|
Moved the DepreciationWarning, and also added a nice visible warning to the docstring.
Merging, will work on updating the examples next. |
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.
View the migration guide on how to replace the deprecated Schedulers with AgentSet functionality.
As concluded in #2231, this PR deprecates the whole Time module and all its Schedulers. This change aims to provide more flexibility and control in agent activation and time management, inspired by the NetLogo framework.
Changes
mesa.timemodule.mesa.time.tests/test_time.pyfile as it's no longer relevant.Migration Guide
The migration guide has been updated to include detailed instructions on how to replace each scheduler with AgentSet functionality. This includes examples for:
The guide also includes general notes on changes to related functionality, such as the automatic incrementing of
Model.stepsand the replacement of scheduler-specific methods with AgentSet methods.For this PR, a rendered version of the migration guide can be viewed here.
Benefits
As discussed extensively in #1912 and #2231, replacing the time module with AgentSet functionality has several benefits. A short summary:
References
.shuffle().do(): #2283PR checklist
.shuffle().do()(see #2283)Next Steps