Skip to content

Removing Deprecations Warnings from agent_portrayal and propertylayer_portrayal until next release.#2797

Merged
EwoutH merged 2 commits intomesa:mainfrom
Sahil-Chhoker:remove-deprectations
May 27, 2025
Merged

Removing Deprecations Warnings from agent_portrayal and propertylayer_portrayal until next release.#2797
EwoutH merged 2 commits intomesa:mainfrom
Sahil-Chhoker:remove-deprectations

Conversation

@Sahil-Chhoker
Copy link
Copy Markdown
Collaborator

Summary

Removes Deprecations Warnings from agent_portrayal and propertylayer_portrayal, linked comment.

@github-actions
Copy link
Copy Markdown

Performance benchmarks:

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

Copy link
Copy Markdown
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.

Perfect!

We can revert this commit after a few releases.

@EwoutH
Copy link
Copy Markdown
Member

EwoutH commented May 27, 2025

Wait, actually, I think you can just change it to a PendingDeprecationWarning instead of removing it.

@Sahil-Chhoker
Copy link
Copy Markdown
Collaborator Author

I didn't know such thing existed, makes more sense in this case.

@EwoutH EwoutH merged commit ed91ba6 into mesa:main May 27, 2025
12 checks passed
@EwoutH
Copy link
Copy Markdown
Member

EwoutH commented May 27, 2025

It's quite a niche thing I happened to know by accident.

Thanks!

@EwoutH EwoutH added the maintenance Release notes label label May 27, 2025
Holzhauer pushed a commit to UniK-INES/mesa that referenced this pull request May 28, 2025
@EwoutH
Copy link
Copy Markdown
Member

EwoutH commented Oct 29, 2025

I think we can update these to full DepreciationWarnings again.

We do have to pick a version when to deprecate. Following full SemVer is needs to be 4.0, but I think we made an exception for the visualization, so we can also do 3.5 for example.

We should also add a few lines to the migration guide.

@Sahil-Chhoker
Copy link
Copy Markdown
Collaborator Author

I actually have no idea how versions and migration guide works. But I think we'll need to update the migration guide with the new visualization changes because it changed a lot with the introduction of portrayal components and space renderer.

@EwoutH
Copy link
Copy Markdown
Member

EwoutH commented Oct 31, 2025

@Sahil-Chhoker we follow https://semver.org/. It basically comes down to only make breaking changes between major releases (x.0.0). Minor releases (x.y.0) are for new features and patch releases (x.y.z.) is for fixing bugs, updating docs, maintenance, etc.

For visualisation we have made an exception, we don't apply SemVer strictly to keep development speed up.

If we plan to make a breaking change, we normally deprecate it at least one minor release before removing it (which would be a major release). We do that by adding notes to the docs and release notes, making sure it isn't used in any examples anymore, making sure the replacement is fully ready and stable, etc. We also add notes to the migration guide.

So here we plan to remove something, and the replacement is already ready, examples are updated, so we can deprecate it. I think everything is already done for that, except adding a note to the migration guide on how to update and actually updating to the full DepreciationWarnings.

Does this help?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

maintenance Release notes label

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants