Skip to content

[Enhancement]: Rename AgentSetDF to AbstractAgentSetDF and AgentSetPolars to AgentSetDF for clarity #171

@adamamer20

Description

@adamamer20

🤔 Problem Description

The current naming of agent set classes is confusing for new users:

  • AgentSetDF is actually an abstract class, but its name suggests it is concrete.
  • AgentSetPolars is the concrete implementation, but its name suggests a backend-specific detail rather than the default user-facing API.
  • Similarly, AgentContainer is an abstract base but does not indicate this in its name.

This inconsistency makes it harder for users (especially newcomers) to understand the intended API.

💡 Proposed Solution

  • Rename AgentSetDFAbstractAgentSetDF
  • Rename AgentSetPolarsAgentSetDF
  • Optionally Rename AgentContainerAbstractAgentContainer for consistency

This way, abstract vs. concrete roles are explicit and easier to follow.

🔄 Alternatives Considered

No response

➕ Additional Context

  • This will be a breaking change since imports will need updating.
  • We should implement this before publishing 0.1.0 stable, to avoid renaming pain for users later.

Metadata

Metadata

Assignees

Labels

enhancementImprovements to existing features or performance.

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions