Skip to content
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

Migration Guide: Add Model initialization requirement and automatic Agent.unique_id assignment #2302

Merged
merged 3 commits into from
Sep 20, 2024

Conversation

EwoutH
Copy link
Member

@EwoutH EwoutH commented Sep 19, 2024

Two additions to the migration guide:

  • docs: Add Model initialization requirement to Migration Guide
  • docs: Add automatic Agent.unique_id assignment to Migration Guide

Edit: Rendered version of this guide in read the docs here.

@EwoutH EwoutH added the docs Release notes label label Sep 19, 2024
Explain new requirement to call super().__init__() in Model classes
- Explain the change from manual to automatic unique_id assignment
- Provide migration steps for updating agent initialization
- Include example of old vs new agent creation syntax
- Note deprecation of Model.next_id() method
- Mention the change in ID numbering starting from 0
@EwoutH
Copy link
Member Author

EwoutH commented Sep 20, 2024

(rebased now that #2297 is merged)

@EwoutH EwoutH force-pushed the migration_guide_stuff branch 2 times, most recently from 5ba3519 to 00adb19 Compare September 20, 2024 11:14
@EwoutH
Copy link
Member Author

EwoutH commented Sep 20, 2024

I made a mistake in writing the unique_id part largely on #2226, instead of on #2260. Commit 078fe54 fixes that.

Rendered version of this guide in read the docs here.

@EwoutH EwoutH force-pushed the migration_guide_stuff branch 2 times, most recently from b130a87 to 078fe54 Compare September 20, 2024 11:30
@EwoutH EwoutH merged commit 655e221 into main Sep 20, 2024
2 checks passed
EwoutH added a commit to EwoutH/mesa that referenced this pull request Sep 24, 2024
…jectmesa#2302)

Two additions to the migration guide:
- docs: Add Model initialization requirement to Migration guide
- docs: Add automatic Agent.unique_id assignment to Migration guide
@quaquel quaquel deleted the migration_guide_stuff branch October 30, 2024 16:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Release notes label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants