Replace RandomActivation and SimultaneousActivation schedulers with AgentSet functionality by EwoutH · Pull Request #161 · mesa/mesa-examples

EwoutH · 2024-08-17T20:04:47Z

This PR replace all the RandomActivation and SimultaneousActivation schedulers used in the example models with AgentSet functionality. This simplifies models and allows for easier and more flexible modification of these models. It algins the examples with the current best practices in Mesa.

RandomActivation (`b7f67c7`)

The RandomActivation schedulers were removed, and in the Model.step() function the schedule step was replaced with an AgentSet operation, like:

-        self.schedule.step()
+        self.agents.shuffle().do("step")

The following RandomActivation schedulers were removed:

bank_reserves
boid_flockers
boltzmann_wealth_model
boltzmann_wealth_model_experimental
boltzmann_wealth_model_network
caching_and_replay
charts
el_farol
epstein_civil_violence
forest_fire
hotelling_law
schelling
shape_example
virus_on_network

SimultaneousActivation (`7e396fe`)

To remove the SimultaneousActivation schedulers, the Agent methods were renamed from step() and advance() to more descriptive functions. The model step was updated accordingly:

-        self.schedule.step()
+        self.agents.do("determine_state")
+        self.agents.do("assume_state")

The following SimultaneousActivation schedulers were removed:

hex_snowflake
color_patches
conways_game_of_life

Relevant tickets

EwoutH · 2024-08-17T20:52:04Z

And believe it or not, the final error is the DataCollector that tries to gather attributes from agents that don't have said attributes.

Replace all usages of model.schedule.agents with the use of the model.agents AgentSet in all examples.

Replace the old RandomActivation scheduler with AgentSet functionality. self.agents.shuffle.do("step") is equivalent and self.schedule.step() with an RandomActivation scheduler, and model behavior should not change.

The SimultaneousActivation scheduler used a "step" and "advanced" function in the Agent. These have been renamed for each model to be more descriptive (like "determine_state" and "assume_state"), and then the model step was replace by something like: self.agents.do("determine_state") self.agents.do("assume_state") Docstring was also updated accordingly.

Schedulers don't exist anymore, so we don't need to add agents anymore. Agents are automatically added to model.agents on Agent initialisation.

These models use complex schedulers which warrant an separate PR.

It doesn't have a step function and there is only one, so it shouldn't be an Agent, just an Python object.

EwoutH · 2024-08-17T21:29:44Z

I updated the PR description and title and cleaned up the commit history as far as feasible.

Looking forward to reviews!

examples/bank_reserves/bank_reserves/agents.py

examples/charts/charts/agents.py

rht · 2024-08-18T08:09:41Z

Other than the 2 comments, everything else LGTM. Feel free to rebase and merge after they had been addressed.

EwoutH · 2024-08-19T08:06:46Z

With rht’s approval I’m going to merge this.

@jackiekazil and @tpike3 I would still love your take, if you have any feedback let me know.

This commit reverts PR mesa#161 mesa#161 That PR assumed that time advancement would be done automatically, like proposed in mesa/mesa#2223 We encountered some underlying issues with time, which we couldn't resolve in time.

This commit reverts PR #161 #161 That PR assumed that time advancement would be done automatically, like proposed in mesa/mesa#2223 We encountered some underlying issues with time, which we couldn't resolve in time.

…mesa#170)" This reinstates PR mesa#161 after the previous revert.

This reinstates PR mesa#161 after the previous revert.

This commit reverts PR #161 mesa/mesa-examples#161 That PR assumed that time advancement would be done automatically, like proposed in #2223 We encountered some underlying issues with time, which we couldn't resolve in time.

…esa#170) This commit reverts PR mesa#161 mesa/mesa-examples#161 That PR assumed that time advancement would be done automatically, like proposed in mesa#2223 We encountered some underlying issues with time, which we couldn't resolve in time.

…esa#170) This commit reverts PR mesa#161 mesa#161 That PR assumed that time advancement would be done automatically, like proposed in mesa/mesa#2223 We encountered some underlying issues with time, which we couldn't resolve in time.

This reinstates PR mesa#161 after the previous revert.

EwoutH force-pushed the replace_schedulers branch from 0f572c8 to 3d94b69 Compare August 17, 2024 21:08

EwoutH added 8 commits August 17, 2024 23:11

Replace model.schedule.agents with model.agents AgentSet

96da4e3

Replace all usages of model.schedule.agents with the use of the model.agents AgentSet in all examples.

Replace RandomActivation scheduler with AgentSet

b7f67c7

Replace the old RandomActivation scheduler with AgentSet functionality. self.agents.shuffle.do("step") is equivalent and self.schedule.step() with an RandomActivation scheduler, and model behavior should not change.

Remove adding agents to schedulers

cdc81b7

Schedulers don't exist anymore, so we don't need to add agents anymore. Agents are automatically added to model.agents on Agent initialisation.

Custom schedule replacements

622188a

Restore Sugerscape and Wolf-sheep schedulers

1ce44f7

These models use complex schedulers which warrant an separate PR.

Final fixes

3627820

bank_reserves/charts: Don't make Bank an Agent

bd60c41

It doesn't have a step function and there is only one, so it shouldn't be an Agent, just an Python object.

EwoutH force-pushed the replace_schedulers branch from f1cf42b to bd60c41 Compare August 17, 2024 21:14

EwoutH marked this pull request as ready for review August 17, 2024 21:14

EwoutH changed the title ~~Replace schedulers with AgentSet functionality~~ Replace RandomActivation and SimultaneousActivation schedulers with AgentSet functionality Aug 17, 2024

rht reviewed Aug 18, 2024

View reviewed changes

examples/bank_reserves/bank_reserves/agents.py Show resolved Hide resolved

rht reviewed Aug 18, 2024

View reviewed changes

examples/charts/charts/agents.py Show resolved Hide resolved

Add docstring note that Bank is a regular class, not an Agent

ffa0958

EwoutH force-pushed the replace_schedulers branch from fa1aee4 to ffa0958 Compare August 18, 2024 08:39

rht approved these changes Aug 18, 2024

View reviewed changes

EwoutH mentioned this pull request Aug 18, 2024

model: Automatically increase steps counter mesa/mesa#2223

Merged

9 tasks

EwoutH merged commit 0ebc4d1 into mesa:main Aug 19, 2024

This was referenced Aug 21, 2024

Write Mesa 3.0 migration guide mesa/mesa#2233

Closed

Fix [issue #168] virus_on_network not updating #169

Closed

EwoutH mentioned this pull request Aug 22, 2024

Revert PR #161: Replace schedulers with AgentSet functionality #170

Merged

EwoutH mentioned this pull request Aug 22, 2024

virus_on_network new visualization doesn't update while running model. #168

Closed

EwoutH added a commit to EwoutH/mesa-examples that referenced this pull request Aug 30, 2024

Reinstate PR mesa#161: Replace schedulers with AgentSet functionality (…

f72d843

…mesa#170)" This reinstates PR mesa#161 after the previous revert.

EwoutH added a commit to EwoutH/mesa-examples that referenced this pull request Aug 30, 2024

Reinstate PR mesa#161: Replace schedulers with AgentSet functionality

a7c89e3

This reinstates PR mesa#161 after the previous revert.

EwoutH mentioned this pull request Aug 30, 2024

Reinstate PR #161: Replace schedulers with AgentSet functionality #183

Merged

EwoutH added a commit to EwoutH/mesa-examples that referenced this pull request Aug 30, 2024

Reinstate PR mesa#161: Replace schedulers with AgentSet functionality

b771804

This reinstates PR mesa#161 after the previous revert.

EwoutH added a commit to EwoutH/mesa-examples that referenced this pull request Aug 30, 2024

Reinstate PR mesa#161: Replace schedulers with AgentSet functionality

0fd7f82

This reinstates PR mesa#161 after the previous revert.

EwoutH added a commit to EwoutH/mesa-examples that referenced this pull request Sep 20, 2024

Reinstate PR mesa#161: Replace schedulers with AgentSet functionality

f635c2f

This reinstates PR mesa#161 after the previous revert.

adamamer20 mentioned this pull request Mar 14, 2025

[Feature]: Automatic increase of step counter mesa/mesa-frames#116

Closed

Harshini2411 pushed a commit to Harshini2411/mesa-examples that referenced this pull request Mar 16, 2026

Reinstate PR mesa#161: Replace schedulers with AgentSet functionality

0e406b4

This reinstates PR mesa#161 after the previous revert.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Replace RandomActivation and SimultaneousActivation schedulers with AgentSet functionality#161

Replace RandomActivation and SimultaneousActivation schedulers with AgentSet functionality#161
EwoutH merged 9 commits intomesa:mainfrom
EwoutH:replace_schedulers

EwoutH commented Aug 17, 2024 •

edited

Loading

Uh oh!

EwoutH commented Aug 17, 2024

Uh oh!

EwoutH commented Aug 17, 2024

Uh oh!

Uh oh!

Uh oh!

rht commented Aug 18, 2024

Uh oh!

EwoutH commented Aug 19, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

EwoutH commented Aug 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

RandomActivation (b7f67c7)

SimultaneousActivation (7e396fe)

Uh oh!

EwoutH commented Aug 17, 2024

Uh oh!

EwoutH commented Aug 17, 2024

Uh oh!

Uh oh!

Uh oh!

rht commented Aug 18, 2024

Uh oh!

EwoutH commented Aug 19, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

EwoutH commented Aug 17, 2024 •

edited

Loading

RandomActivation (`b7f67c7`)

SimultaneousActivation (`7e396fe`)