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

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

Open
adamamer20 opened this issue Aug 19, 2024 · 0 comments
Open

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

adamamer20 opened this issue Aug 19, 2024 · 0 comments

Comments

@adamamer20
Copy link
Collaborator

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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant