-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Deprecate agent_portrayal and update Migration guide
#2872
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
@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? |
|
Performance benchmarks:
|
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. |
|
This is the version I could come up with without repeating myself too much, let me know if it need improvement. |
EwoutH
left a comment
There was a problem hiding this 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.
|
This is great @Sahil-Chhoker, thanks for doing this! |
|
|
||
| _This guide is a work in progress. The development of it is tracked in [Issue #2233](https://github.com/projectmesa/mesa/issues/2233)._ |
There was a problem hiding this comment.
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).
| _This guide is a work in progress. The development of it is tracked in [Issue #2233](https://github.com/projectmesa/mesa/issues/2233)._ |
agent_portrayal and update Migration guide
EwoutH
left a comment
There was a problem hiding this 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.
Updates the migration guide inline with the new visualization API. Also activates the deprecation warnings for portrayal components.
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.