[Enhancement] Rename core classes (ModelDF, AgentsDF, etc.) for clarity
#175
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Updated test_datacollector.py to replace ModelDF and AgentSetPolars with Model and AgentSet. - Modified ExampleModel and ExampleModelWithMultipleCollects to use AgentSetRegistry. - Adjusted fixtures to reflect changes in agent set classes. - Updated test_grid.py to use new Model and AgentSet classes, ensuring compatibility with the refactored code. - Changed test_modeldf.py to utilize the new Model class. - Updated dependencies in uv.lock to include mesa version 3.2.0.
- Updated import paths for AbstractAgentSet and AgentSetRegistry to reflect new module structure. - Created a new concrete implementation of AgentSetRegistry in `agentsetregistry.py`, providing a collection for managing agent sets with DataFrame-based storage. - Modified existing files to utilize the new AgentSetRegistry class, ensuring consistent usage across the codebase.
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #175 +/- ##
==========================================
+ Coverage 92.51% 92.54% +0.03%
==========================================
Files 13 14 +1
Lines 1709 1717 +8
==========================================
+ Hits 1581 1589 +8
Misses 128 128 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
for more information, see https://pre-commit.ci
…ctAgentSetRegistry
…-and-agentsetpolars-to-agentsetdf-for-clarity' of https://github.com/projectmesa/mesa-frames into 171-enhancement-rename-agentsetdf-to-abstractagentsetdf-and-agentsetpolars-to-agentsetdf-for-clarity
adamamer20
added
enhancement
…codebase for consistency and clarity
…Model for consistency across the codebase
for more information, see https://pre-commit.ci
…tagentsetdf-and-agentsetpolars-to-agentsetdf-for-clarity
Ben-geo
reviewed
Sep 5, 2025
Ben-geo
approved these changes
Sep 5, 2025
…andas and MoneyAgentDF to MoneyAgentsConcise and MoneyAgentsNative
…alth calculations
…o MesaMoneyModel and MoneyAgent to MesaMoneyAgent; update agent sets to MoneyAgentsConcise and MoneyAgentsNative.
…larsBase to AntDFBase for consistency
…rom AbstractAgentSet to AgentSet and adjust related documentation.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates class and property names to improve clarity and align with the upcoming refactor in #172.
Changes
ModelDF→ModelAgentsDF→AgentSetRegistryAgentContainer→AbstractAgentSetRegistryAgentSetPolars→AgentSetAgentSetDF(abstract) →AbstractAgentSetmodel.agents→model.setsReasoning
*DFsuffix was only added to distinguish from Mesa’s classes. This is no longer necessary, since end users typically don’t import both frameworks together.AgentSetDFandAgentSetsAccessorfor name/type/index lookup and container-aware keying #172, onlyAgentSetwill directly manage its DataFrame, while the container class (AgentSetRegistry, exposed onmodel.sets) is the single point of access to all agent sets.Scope