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.

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

Concrete GridPandas #44

Merged
merged 46 commits into from
Aug 4, 2024
Merged

Concrete GridPandas #44

merged 46 commits into from
Aug 4, 2024

Conversation

adamamer20
Copy link
Collaborator

@adamamer20 adamamer20 commented Aug 1, 2024 •
edited
Loading

This PR adds the GridPandas class, a concrete Pandas-based implementation of GridDF, with unit-tests for all public methods and properties. The remaining capacity of cells is stored in a np.array where only vectorized operations are applied.

Key changes in this PR:

SpaceDF

  • Distinction between place_* and move_* methods for abstract SpaceDF. place methods raise a Warning if agents are already placed in the grid, move methods raise a Warning if agents are not placed in the grid.
  • Implementation of swap_agents directly in SpaceDF

DiscreteSpaceDF

  • Implementation of set_cells directly in DiscreteSpaceDF
  • Addition of remaining_capacity property in DiscreteSpaceDF
  • Added 'respect_capacity' parameter to 'sample_cells'. If with_replacement is True, the flag make sure to sample cells only the allowed total capacity number of times.

GridDF

  • Changed coordinate system for hexagonal grids. The coordinate system is axial. The axes (q and r) are at 60 degrees to each other. This allows for symmetric offsets across cells (more performant) and it's easier to think about.
  • Added 'get_neighborhood' implementation directly to GridDF. If the radiuses are different across positions/agents, neighborhoods are generated for the maximum radius for all positions / agents and are later dropped. This allows the use of vectorized operations (for time-efficiency) but may be space inefficient.
  • Added 'get_cells' implementation directly to GridDF. Each cell row contains exactly one agent, thus there may be multiple rows with the same cell and different agents. This is space inefficient but more time-efficient and intuitive (Series of lists are not easy to manipulate).

Requires merging #43.

@adamamer20
adding __repr__ and __str__ to DiscreteDF
24ce034
@adamamer20
implement random_pos in DiscreteSpaceDF
f3d5201
@adamamer20
Changing set_cells docstring
6e86635
@adamamer20
adding _df_columns to mixin
ff812c9
@adamamer20
add _df_column_names
8b049ee
@adamamer20
- move capacity to DiscreteSpaceDF
c2218c6 
- create set_cells at DiscreteSpaceDF level
@adamamer20
adding _contains to mixin, changed _add_columns to _with_columns
6436186
@adamamer20
- moved column names to SpaceDF
0777041 
- created concrete swap in SpaceDF
- update due to changes in mixin
@adamamer20
add _srs_range
3e3f457
@adamamer20
add _df_join to mixin
00a5e1a
@adamamer20
adding "cross" option to _df_join
dee33f5
@adamamer20
adding _df_filter_ to mixin
fe2abfb
@adamamer20
add _df_rename_columns to DataFrameMixin
e47742c
@adamamer20
adding get_neighborhood to GridDF
365b240
@adamamer20
- remove _place_agents_df and move it to move_agents
16dfd5d 
- add remaining capacity property
- branching _update_capacity in cells and agents
@adamamer20
fix move update capacity first
49e5617
@adamamer20
pandas implementation
de5aaf6
@adamamer20
move pandas, polars tests to their folders
6d185f4
@adamamer20
adding GridPandas to __init__
46500a7
@adamamer20
adding remaining capacity
12bae83
@adamamer20
reorder mixin
00cb4be
@adamamer20
adding mixin_test for pandas
71281cf
@adamamer20
fixes to abstract DataFrameMixin syntax
0363e67
@adamamer20
updates to types
d26404e
@adamamer20
renamed files for pytest
1794388
@adamamer20
adding typeguard to mixin
499e4e2
@adamamer20
added series concatenation to DataFrameMixin
3943365
@adamamer20
adding place_agents
fd1b5f1
@adamamer20
renaming test_agentsets (for pytest compatibility)
91bc4aa
@adamamer20
added index as abstract property and changed inactive_agents mismatch…
96307e6 
…ed return type
@adamamer20
- Distinction between place and move: the first raises Warning if age…
b43449c 
…nts are already present, the second if agents aren't already present

- Fixes to the logic of some methods of SpaceDF (random_agents, swap_agents),
DiscreteSpaceDF (__repr__, __str__)
GridDF (__init__, get_directions, get_distances, get_neighbors, get_neighborhood, get_cells, out_of_bounds, remove_agents, torus_adj, _compute_offsets, _get_df_coords)
@adamamer20
addition of the new methods to PolarsMixin according to the new abstr…
054ebf9 
…act DataFrameMixin
@adamamer20
- added index property to AgentsDF
7e5bca4
@adamamer20
- specified _copy_with_method attribute for fast copy through CopyMixin
e6e8f2a 
- added custom _empty_cell_condition
- fixed the logic of some methods (_generate_empty_grid, _sample_cells, _update_capacity_agents, remaining_capacity)
@adamamer20
added tests for GridPandas
2b181e7
@adamamer20
Merge branch 'main' of https://github.com/adamamer20/mesa-frames into…
34a6368 
… 34-concrete-gridpandas
@adamamer20
Merge branch 'main' of https://github.com/adamamer20/mesa-frames into…
2a2284e 
… 34-concrete-gridpandas
@adamamer20
Merge branch 'main' of https://github.com/adamamer20/mesa-frames into…
b166d66 
… 34-concrete-gridpandas
@adamamer20
test_mixin_pandas will be added with it's own PR
5106501
@adamamer20
moved test_space_pandas to pandas test folder and changed named to te…
e90cacd 
…st_grid_pandas
@adamamer20 adamamer20 linked an issue Aug 1, 2024 that may be closed by this pull request
Concrete GridPandas #34
Closed
@adamamer20 adamamer20 marked this pull request as draft August 1, 2024 19:37
@adamamer20 adamamer20 requested a review from rht August 1, 2024 19:37
@adamamer20 adamamer20 self-assigned this Aug 1, 2024
@adamamer20 adamamer20 added the enhancement Improvements to existing features or performance. label Aug 1, 2024
@adamamer20 adamamer20 added this to the 0.1.0 Alpha Release milestone Aug 1, 2024
@adamamer20 adamamer20 marked this pull request as ready for review August 2, 2024 08:08
@rht
Copy link
Contributor

rht commented Aug 4, 2024 •
edited
Loading

Sorry for the delay in reviewing. Hope it's not blocking the other issues.

@rht rht merged commit 69297a1 into main Aug 4, 2024
6 checks passed
@rht rht deleted the 34-concrete-gridpandas branch August 4, 2024 10:10
@rht
Copy link
Contributor

rht commented Aug 4, 2024

It looks like there is a test flake on the latest main CI.

@adamamer20
Copy link
Collaborator Author

Sorry for the delay in reviewing. Hope it's not blocking the other issues.

Do not worry, I was working on PolarsMixin and GridPolars.

It looks like there is a test flake on the latest main CI.

You're right, failure on ubuntu is related to the sampling operation. Should be an easy fix.
Windows on the other hand seems to have trouble building matplotlib(?). I need to dig deeper.

@adamamer20 adamamer20 linked an issue Aug 4, 2024 that may be closed by this pull request
Refactoring mesa.space #6
Open
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rht rht rht approved these changes

Assignees

@adamamer20 adamamer20

Labels
enhancement Improvements to existing features or performance.
Projects
None yet
Milestone
0.1.0 Alpha Release
Development

Successfully merging this pull request may close these issues.

Refactoring mesa.space Concrete GridPandas
2 participants
@adamamer20 @rht