Skip to content

Rename 'agents' property to 'df' for AgentContainer #68

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.

Sign up for GitHub

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

Jump to bottom
Open
adamamer20 opened this issue Aug 19, 2024 · 1 comment
Open

Rename 'agents' property to 'df' for AgentContainer #68

adamamer20 opened this issue Aug 19, 2024 · 1 comment
Labels
enhancement Improvements to existing features or performance. good first issue Good for newcomers
Milestone
0.1.0-stable

Comments

@adamamer20
Copy link
Member

Current Behavior

To access the underlying dataframe of AgentSetDF or AgentsDF, we currently use:

AgentContainer.agents

This can lead to unclear syntax, especially when accessing it from the model:

model.agents.agents

Proposed Change

Rename the agents property to df for improved clarity.

Expected Behavior

After the change, accessing the dataframe would look like:

AgentContainer.df

And from the model:

model.agents.df

Benefits

  • Clearer API
  • Reduces confusion when dealing with nested 'agents' references
  • More intuitive naming convention (df clearly indicates a DataFrame)
@adamamer20 adamamer20 added feature New functionality added to the project. enhancement Improvements to existing features or performance. and removed feature New functionality added to the project. labels Mar 18, 2025
@adamamer20 adamamer20 added this to the 0.1.0-stable milestone Mar 18, 2025
@adamamer20 adamamer20 added the good first issue Good for newcomers label Mar 18, 2025
@reyan-singh
Copy link
Collaborator

@EwoutH @adamamer20 I have created pull request #148 for for issue "Rename 'agents' property to 'df' for AgentContainer #68"

adamamer20 added a commit to reyan-singh/mesa-frames that referenced this issue Apr 19, 2025
@adamamer20
Merge branch 'main' into Rename-'agents'-property-to-'df'-for-AgentCo…
4a24a40 
…ntainer-projectmesa#68
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement Improvements to existing features or performance. good first issue Good for newcomers
Projects
None yet
Milestone
0.1.0-stable
Development

No branches or pull requests
2 participants
@reyan-singh @adamamer20