Adds move_to_optimal function in DiscreteSpaceDF class #118

suryanshgargbpgc · 2025-03-17T22:26:09Z

Added the move_to function to allow agent movement based on specified attributes and ranking orders. The function considers neighborhood radius, sorting preferences, and optional shuffling for random movement. It ensures conflict resolution using priority-based selection, optimizing movement allocation.

Added the move_to function to allow agent movement based on specified attributes and ranking orders. The function considers neighborhood radius, sorting preferences, and optional shuffling for random movement. It ensures conflict resolution using priority-based selection, optimizing movement allocation. This enhances the agent-based model's flexibility and realism.

codecov · 2025-03-17T22:27:16Z

Codecov Report

Attention: Patch coverage is 83.21060% with 114 lines in your changes missing coverage. Please review.

Please upload report for BASE (main@d7756a5). Learn more about missing BASE report.

Files with missing lines	Patch %	Lines
mesa_frames/abstract/space.py	56.63%	49 Missing ⚠️
mesa_frames/concrete/pandas/agentset.py	88.49%	26 Missing ⚠️
mesa_frames/concrete/pandas/mixin.py	89.80%	21 Missing ⚠️
mesa_frames/concrete/polars/agentset.py	20.00%	8 Missing ⚠️
mesa_frames/abstract/agents.py	37.50%	5 Missing ⚠️
mesa_frames/concrete/agents.py	20.00%	4 Missing ⚠️
mesa_frames/types_.py	94.11%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #118   +/-   ##
=======================================
  Coverage        ?   89.24%           
=======================================
  Files           ?       14           
  Lines           ?     2344           
  Branches        ?        0           
=======================================
  Hits            ?     2092           
  Misses          ?      252           
  Partials        ?        0

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

This reverts commit df26a23.

suryanshgargbpgc · 2025-03-18T10:41:16Z

Hi, @adamamer20 I have added the move_to method in the DiscreteSpaceDF class, It is more generalized version of get_best_moves. I hope it works well

adamamer20

The implementation seems good!

There are 3 main points I'd like you to address before we merge:

Add proper docstrings (NumPy style)
Include unit tests in tests\polars\test_grid_polars.py
Consider adding an interface for this functionality to the AgentContainer classes (AgentSetDF and AgentsDF)

I'll benchmark soon to check if performance remains solid with the numba UDF approach, especially using lazyframes. If performance scales badly, we might need to iterate over columns directly or explore another solution.

mesa_frames/abstract/space.py

adamamer20 · 2025-03-18T17:47:31Z

mesa_frames/abstract/space.py

+            raise ValueError("attr_names and rank_order must have the same length")
+        if radius is None:
+            if "vision" in agents.columns:
+                radius = agents["vision"]


This is a good idea but make sure to mention it in the docstring as it's a strong assumption.

1.move_to function is renamed as move_to_optimize 2. Docstrings added 3. unit tests added to tests/polars/test_grid_polars 4. Interface for move_to_optimize added to AgentContainer, AgentsDF, AgentSetDF

for more information, see https://pre-commit.ci

…c/mesa-frames into optimizefunction

for more information, see https://pre-commit.ci

suryanshgargbpgc · 2025-03-22T06:01:29Z

Hi @adamamer20,
I have implemented all the changes you mentioned earlier, however for the unit tests,
I'm getting a SchemaError in the tests that says the "agent_id" column should be a Struct, but it's coming through as an integer. the move_to_optimal function, so I'm wondering if I need to change my implementation to convert agent_id into a struct, or if the test should be updated instead. Could you please advise on the best approach?

Unit tests for move_to_optimal method added updated move_to_optimal method and the docstring

This reverts commit 3d28340.

adamamer20 · 2025-03-24T07:33:44Z

Hi @adamamer20,

I have implemented all the changes you mentioned earlier, however for the unit tests,

I'm getting a SchemaError in the tests that says the "agent_id" column should be a Struct, but it's coming through as an integer. the move_to_optimal function, so I'm wondering if I need to change my implementation to convert agent_id into a struct, or if the test should be updated instead. Could you please advise on the best approach?

unique_id should be an integer. can you clarify where you are getting this error? if it's a test you created yourself, then correct it please.

suryanshgargbpgc · 2025-03-24T08:50:18Z

@adamamer20 I have fixed the test
However I have not implemented the auto unique id feature for the move_to_optimal function and for the tests unique id is defined explicitly, should I add that feature or is it fine?

adamamer20 · 2025-03-29T21:28:01Z

mesa_frames/abstract/agents.py

+        obj = self._get_obj(inplace)
+
+        # Apply move_to_optimal to each agent set in the container
+        for agent_set in obj.agent_sets.values():


obj does not have the agent_sets attribute. Here in the abstract file we define only the interface.

suryanshgargbpgc · 2025-03-30T01:23:47Z

@adamamer20 is it fine now ?

adamamer20 · 2025-04-09T14:49:36Z

mesa_frames/abstract/agents.py

+        for agent_set in obj:
+            agent_set.move_to_optimal(
+                attr_names=attr_names,
+                rank_order=rank_order,
+                radius=radius,
+                include_center=include_center,
+                shuffle=shuffle,
+                inplace=True,
+            )
+
+        return obj


again, no actual implementation should go here becuase it's an abstract interface. remove it completely. For the AgentSet you should do the implementation for AgentSetPolars.

adamamer20 · 2025-04-09T15:02:36Z

mesa_frames/abstract/agents.py

@@ -616,6 +616,19 @@ def __str__(self) -> str:
        """
        ...

+    @abstractmethod
+    def move_to_optimal(


Create a complete docstring like you did for GridPolars

coderabbitai · 2025-04-15T06:04:33Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

This reverts commit 90351ba, reversing changes made to f437548.

suryanshgargbpgc added 2 commits March 11, 2025 15:03

test commit

df26a23

suryanshgargbpgc added 2 commits March 18, 2025 03:59

Merge branch 'main' into optimizefunction

Loading
Loading status checks…

1d75987

Revert "test commit"

Loading
Loading status checks…

d26561e

This reverts commit df26a23.

adamamer20 self-requested a review March 18, 2025 17:39

adamamer20 requested changes Mar 18, 2025

View reviewed changes

suryanshgargbpgc force-pushed the optimizefunction branch from 2ebec10 to df26a23 Compare March 19, 2025 10:47

adamamer20 and others added 14 commits March 19, 2025 22:31

moving type hint to types_ module

Loading
Loading status checks…

94daca7

tests for move_to function

Loading
Loading status checks…

4bd0533

1.move_to function is renamed as move_to_optimize 2. Docstrings added 3. unit tests added to tests/polars/test_grid_polars 4. Interface for move_to_optimize added to AgentContainer, AgentsDF, AgentSetDF

[pre-commit.ci] auto fixes from pre-commit.com hooks

Loading
Loading status checks…

25e3baf

for more information, see https://pre-commit.ci

Update test_grid_polars.py

Loading
Loading status checks…

4859e2c

[pre-commit.ci] auto fixes from pre-commit.com hooks

Loading
Loading status checks…

a9d9e8f

for more information, see https://pre-commit.ci

Update test_grid_polars.py

Loading
Loading status checks…

06ac4eb

[pre-commit.ci] auto fixes from pre-commit.com hooks

Loading
Loading status checks…

ab6f845

for more information, see https://pre-commit.ci

Update space.py

fc6be7c

Merge branch 'optimizefunction' of https://github.com/suryanshgargbpg…

Loading
Loading status checks…

3f7c26d

…c/mesa-frames into optimizefunction

Update space.py

Loading
Loading status checks…

002a5d9

Update agents.py

Loading
Loading status checks…

08c927d

adds blank line

Loading
Loading status checks…

ec10744

Update test_grid_polars.py

Loading
Loading status checks…

0747f98

[pre-commit.ci] auto fixes from pre-commit.com hooks

Loading
Loading status checks…

8cd426b

for more information, see https://pre-commit.ci

suryanshgargbpgc added 3 commits March 23, 2025 20:04

adds tests for move_to_optimal

Loading
Loading status checks…

5b8f8db

Unit tests for move_to_optimal method added updated move_to_optimal method and the docstring

Update test_grid_polars.py

Loading
Loading status checks…

3d28340

Revert "Update test_grid_polars.py"

Loading
Loading status checks…

20b3968

This reverts commit 3d28340.

suryanshgargbpgc changed the title ~~Adds move_to function in DiscreteSpaceDF class~~ Adds move_to_optimal function in DiscreteSpaceDF class Mar 23, 2025

suryanshgargbpgc added 2 commits March 24, 2025 01:59

update test_grid_polars

Loading
Loading status checks…

3a2dc16

resolve conflicts

Loading
Loading status checks…

891f296

suryanshgargbpgc added 3 commits March 24, 2025 13:57

Fix whitespace in AgentSetPandas docstring

Loading
Loading status checks…

04246e8

Fix docstring conflict in _prepare_cells method with proper format

Loading
Loading status checks…

f278e56

Merge branch 'main' into optimizefunction

Loading
Loading status checks…

56fdabc

Merge branch 'main' into optimizefunction

Loading
Loading status checks…

efc65e7

adamamer20 reviewed Mar 29, 2025

View reviewed changes

update agenets.py

Loading
Loading status checks…

f437548

adamamer20 self-requested a review April 9, 2025 15:04

adamamer20 requested changes Apr 9, 2025

View reviewed changes

Merge upstream changes and resolve conflicts

Loading
Loading status checks…

90351ba

Revert "Merge upstream changes and resolve conflicts"

Loading
Loading status checks…

02e49c2

This reverts commit 90351ba, reversing changes made to f437548.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds move_to_optimal function in DiscreteSpaceDF class #118

Adds move_to_optimal function in DiscreteSpaceDF class #118

suryanshgargbpgc commented Mar 17, 2025 •

edited

Loading

codecov bot commented Mar 17, 2025 •

edited

Loading

suryanshgargbpgc commented Mar 18, 2025

adamamer20 left a comment

adamamer20 Mar 18, 2025

suryanshgargbpgc commented Mar 22, 2025

adamamer20 commented Mar 24, 2025

suryanshgargbpgc commented Mar 24, 2025 •

edited

Loading

adamamer20 Mar 29, 2025 •

edited

Loading

suryanshgargbpgc commented Mar 30, 2025

adamamer20 Apr 9, 2025

adamamer20 Apr 9, 2025

coderabbitai bot commented Apr 15, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Adds move_to_optimal function in DiscreteSpaceDF class #118

Are you sure you want to change the base?

Adds move_to_optimal function in DiscreteSpaceDF class #118

Conversation

suryanshgargbpgc commented Mar 17, 2025 • edited Loading

codecov bot commented Mar 17, 2025 • edited Loading

Codecov Report

suryanshgargbpgc commented Mar 18, 2025

adamamer20 left a comment

Choose a reason for hiding this comment

adamamer20 Mar 18, 2025

Choose a reason for hiding this comment

suryanshgargbpgc commented Mar 22, 2025

adamamer20 commented Mar 24, 2025

suryanshgargbpgc commented Mar 24, 2025 • edited Loading

adamamer20 Mar 29, 2025 • edited Loading

Choose a reason for hiding this comment

suryanshgargbpgc commented Mar 30, 2025

adamamer20 Apr 9, 2025

Choose a reason for hiding this comment

adamamer20 Apr 9, 2025

Choose a reason for hiding this comment

coderabbitai bot commented Apr 15, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

suryanshgargbpgc commented Mar 17, 2025 •

edited

Loading

codecov bot commented Mar 17, 2025 •

edited

Loading

suryanshgargbpgc commented Mar 24, 2025 •

edited

Loading

adamamer20 Mar 29, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)