Skip to content

Conversation

@Sahil-Chhoker
Copy link
Collaborator

Summary

Updates the migration guide inline with the new visualization API. Also activates the deprecation warnings for portrayal components.

Motive

Updating the migration guide to help users upgrade to the latest Mesa version.

Implementation

Documented API changes with a comparison between the old and new versions.

@Sahil-Chhoker
Copy link
Collaborator Author

Sahil-Chhoker commented Nov 2, 2025

@EwoutH, I've updated the migration guide for the portrayal components as I just had to add a new section there, but how do I go about updating the space visualization as it already contains a block, should we separate the changes according to the mesa versions?

@github-actions
Copy link

github-actions bot commented Nov 2, 2025

Performance benchmarks:

Model Size Init time [95% CI] Run time [95% CI]
BoltzmannWealth small 🔵 +3.0% [+1.8%, +4.1%] 🔵 +0.5% [+0.3%, +0.6%]
BoltzmannWealth large 🔵 -0.3% [-1.2%, +0.7%] 🔵 -2.8% [-5.6%, +0.2%]
Schelling small 🔵 -0.6% [-0.9%, -0.3%] 🔵 -0.2% [-0.5%, +0.1%]
Schelling large 🔵 -0.2% [-0.5%, +0.1%] 🔵 +1.3% [-0.3%, +2.8%]
WolfSheep small 🔵 -0.6% [-0.9%, -0.3%] 🔵 -0.4% [-0.6%, -0.2%]
WolfSheep large 🔵 +0.7% [-0.5%, +2.2%] 🔵 -2.8% [-3.9%, -1.4%]
BoidFlockers small 🔵 -0.5% [-1.0%, +0.0%] 🔵 -0.4% [-0.6%, -0.1%]
BoidFlockers large 🔵 -0.4% [-0.7%, -0.1%] 🔵 -0.5% [-0.8%, -0.3%]

@EwoutH
Copy link
Member

EwoutH commented Nov 2, 2025

but how do I go about updating the space visualization as it already contains a block, should we separate the changes according to the mesa versions?

Yes, this document just keeps on growing. So add it under the first version that the new things works and users can (should) use it.

@Sahil-Chhoker
Copy link
Collaborator Author

This is the version I could come up with without repeating myself too much, let me know if it need improvement.

Copy link
Member

@EwoutH EwoutH left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great start, thanks. A few comments.

@Sahil-Chhoker Sahil-Chhoker requested a review from EwoutH November 3, 2025 09:13
@Sahil-Chhoker Sahil-Chhoker requested a review from EwoutH November 3, 2025 13:05
@tpike3
Copy link
Member

tpike3 commented Nov 3, 2025

This is great @Sahil-Chhoker, thanks for doing this!

Comment on lines 11 to 12

_This guide is a work in progress. The development of it is tracked in [Issue #2233](https://github.com/projectmesa/mesa/issues/2233)._
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can remove this line, since it no longer applies (the guide is done).

Suggested change
_This guide is a work in progress. The development of it is tracked in [Issue #2233](https://github.com/projectmesa/mesa/issues/2233)._

@EwoutH EwoutH changed the title Updating Migration Guide and Deprecation warnings Deprecate agent_portrayal and update Migration guide Nov 3, 2025
Copy link
Member

@EwoutH EwoutH left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great, thanks!

Once you're ready, I can believe you can now merge yourself :)
(highly recommend squashing while merging)

We shouldn't forget to include this deprecation clearly in the release notes on the next release.

@EwoutH EwoutH added docs Release notes label deprecation When a new deprecation is introduced labels Nov 3, 2025
@EwoutH EwoutH merged commit f35c4d0 into projectmesa:main Nov 5, 2025
13 checks passed
dhiraj-143r pushed a commit to dhiraj-143r/mesa that referenced this pull request Nov 6, 2025
)

Updates the migration guide inline with the new visualization API. Also activates the deprecation warnings for portrayal components.
EwoutH pushed a commit that referenced this pull request Nov 7, 2025
Updates the migration guide inline with the new visualization API. Also activates the deprecation warnings for portrayal components.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

deprecation When a new deprecation is introduced docs Release notes label

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants