Implement EventQueueABM #917

Tortar · 2023-11-07T11:46:19Z

Fixes #902

Still very bad but the new example at least works :-)

codecov-commenter · 2023-11-07T15:01:57Z

Codecov Report

Attention: 54 lines in your changes are missing coverage. Please review.

Comparison is base (fa03585) 92.26% compared to head (23812ed) 90.51%.
Report is 3 commits behind head on main.

❗ Current head 23812ed differs from pull request most recent head cb0519b. Consider uploading reports for the commit cb0519b to get more accurate results

Files	Patch %	Lines
src/simulations/step.jl	0.00%	26 Missing ⚠️
src/core/model_event_queue.jl	34.48%	19 Missing ⚠️
src/core/model_validation.jl	89.36%	5 Missing ⚠️
src/submodules/schedulers.jl	50.00%	2 Missing ⚠️
src/core/model_abstract.jl	0.00%	1 Missing ⚠️
src/core/model_accessing_API.jl	95.23%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #917      +/-   ##
==========================================
- Coverage   92.26%   90.51%   -1.75%     
==========================================
  Files          33       36       +3     
  Lines        2274     2331      +57     
==========================================
+ Hits         2098     2110      +12     
- Misses        176      221      +45

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

Datseris · 2023-11-08T21:25:43Z

I am confused about the existence of model_step and agents_first, as the whole point of this event based system is that there is no model step and there cannot be "before" or "after" the step, as events happen on a continuous time line and hence don't have an end; they go on until exhaustion or hitting a user-provided time limit.

I would argue that if a user wants "agent steps" and "model steps" they should just go ahead and use the StandardABM and hence here we should focus on just the quing system and simplify everything.,

Tortar · 2023-11-08T21:53:23Z

I agree 👍

Tortar · 2023-11-12T18:10:10Z

src/simulations/step.jl

+    event_function! = abmevents(model)[agent_type][event_idx]
+    event_function!(agent, model)
+    !haskey(agent_container(model), id) && return
+    propensities = abmrates(agent, model) .* nagents(model)


It's not really clear to me why here we multiply by nagents(model), shouldn't it be the number of agents of the related agent type?

actually to me is not clear why applying a function such as nagents in general? shouldn't the user define his own rates? Given that we let choosing a function then every transformation of the propensities seems not useful. But it's not entirely clear to me how the algorithm should work, so I could be mistaken

@MA-Ramirez @Datseris I'd need some help on this if you can give some it would really appreciated :-)

If nobody has insights on this I will remove it, it is in any case possible to achieve through passing a function in abmrates

Sorry for the late reply. Yes, you should remove this part and if the user needs to they can call nagents in abmrates.

Datseris · 2023-11-13T09:11:53Z

docs/src/api.md

@@ -8,10 +8,11 @@ In this page we list the remaining API functions, which constitute the bulk of A
 Besides the generic interface of [`AgentBasedModel`](@ref), and the [`StandardABM`](@ref), highlighted in the tutorial, there is also:

 ```@docs
-UnremovableABM
+EventQueueABM


I think we should move AgentBasedModel here as well, and only expand the docstring of StandardABM in the tutorial. In the tutorial we just mention explicitly part of the interface by showing how it works in terms of examples. E.g., do something like model[2]. I can do this after this PR is merged.

jacobusmmsmit · 2023-11-22T17:15:00Z

src/core/model_abstract.jl

@@ -138,7 +138,7 @@ end
 # The first type parameter of any `ABM` subtype must be the space type.
 spacetype(::ABM{S}) where {S} = S

-agenttype(model::ABM) = notimplemented(model)
+tuple_agenttype(model::ABM) = getfield(model, :agents_types)


Why are we renaming agenttype? I think tuple_agenttype is a bit of a mouthful as a getter. I think we can just accept that agenttype can return either a type or a union, and if not we can have agenttypes for unions and agenttype using only to ensure a single return type.

src/core/model_event_queue.jl

Datseris · 2023-11-22T22:35:57Z

@Tortar what is remaining for this to be finished? It's the last PR before v6, right?

Tortar · 2023-11-23T11:24:54Z

Mainly some docstrings need to be finished and we need to add some more tests for the new model type. We agreed with @fbanning to put also #934 in the v6 milestone. I'm a bit overwhelmed by other tasks at the moment, I think I can work on this monday. But if someone else wants to help feel free to add your commits to the branch

jacobusmmsmit · 2023-11-23T11:39:59Z

Can I ask what happened with the ConcurrentSim implementation? Did anyone try doing a comparison? I looked into CS.jl and it was rather complicated. I think it raises the complexity barrier for contributers even if none of the internals are exposed.

Tortar · 2023-11-23T12:36:08Z

I think that we can add the CS.jl integration later, I'm not sure that internal with CS.jl will become too complicated, maybe it is so but it is worth trying in my opinion. I don't think it's a priority though

jacobusmmsmit · 2023-11-23T13:07:50Z

At one point we can make a performance comparison with "from scratch continuous abm", "Agents-v6 continuous abm", and a "CS Agents continuous abm" and see if it's worth it, and if so how much.

Datseris · 2023-11-24T20:57:06Z

I can take over this PR. I realized there are some things we need to improve. For example, if an agent is added to the model via e.g., replicate!, this agent will never get an event assigned to it. My proposal is that when an agent gets added to the model, we immediatelly trigger the event generatrion function for it. This also solves the "what's the starting event" problem. Because as soon as we populate the model with agents, there is also an event que.

I also want to do two more improvements: using the concept of probability mass to decide how events are chosen, and simplifying significantly the events. I will add a generic type AgentEvent that takes in an event function and the type of agent it applies over. In this way an event may be applicable to many agents by providing the AbstractAgent as the agent type, which will also be the deafult value.

Datseris · 2023-11-24T23:11:42Z

I have had great progress in the eventqueuv2 branch, but I am not finished yet. I take a break now but I will finish this soon!

The new code gives more power to the user (more possible configurations and flexibility) while requiring the user to input less information due to two default options!

Tortar · 2023-12-28T16:00:39Z

Closing in favor of #940

Implement EventQueueABM

95c4f0e

Tortar marked this pull request as draft November 7, 2023 11:46

Tortar added 14 commits November 7, 2023 12:46

Update model_abstract.jl

4e38b08

Create model_event_queue.jl

5bc665f

Update model_single_container.jl

780db59

Update model_single_container.jl

2fe4a17

Update model_single_container.jl

0ea8e8b

Update model_single_container.jl

397553b

Update model_single_container.jl

62a4acc

Update model_single_container.jl

3b604e8

Update model_event_queue.jl

ac19928

Update rock_paper_scissors.jl

cca3990

Update step.jl

b6fa1db

Update model_event_queue.jl

985e885

Update rock_paper_scissors.jl

46c7867

Update Agents.jl

82a81b7

improvements

aad2c5f

Tortar mentioned this pull request Nov 8, 2023

Design discussion for an Event-Based (Gillespie-like) agent based model in Agents.jl #902

Closed

Datseris self-requested a review November 8, 2023 21:15

Tortar and others added 8 commits November 8, 2023 22:55

remove steps

369182b

fix

9f1e6dd

dev

12af5dc

Merge branch 'main' into eventqueueabm

59853ac

1° test

b138d48

Update model_event_queue.jl

97f5c64

Update model_event_queue.jl

055a18a

dev

e62b127

Tortar added 2 commits November 12, 2023 19:03

fix

26ea4a9

fix2

23812ed

Tortar commented Nov 12, 2023

View reviewed changes

Datseris reviewed Nov 13, 2023

View reviewed changes

jacobusmmsmit reviewed Nov 22, 2023

View reviewed changes

src/core/model_event_queue.jl Outdated Show resolved Hide resolved

Correct small typo

cb0519b

Tortar added this to the v6.0 milestone Nov 23, 2023

Datseris mentioned this pull request Nov 25, 2023

EventQueue ABM v3 #940

Merged

Tortar closed this Dec 28, 2023

Tortar deleted the eventqueueabm branch January 25, 2024 17:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement EventQueueABM #917

Implement EventQueueABM #917

Tortar commented Nov 7, 2023 •

edited

Loading

codecov-commenter commented Nov 7, 2023 •

edited

Loading

Datseris commented Nov 8, 2023

Tortar commented Nov 8, 2023

Tortar Nov 12, 2023

Tortar Nov 12, 2023

Tortar Nov 12, 2023 •

edited

Loading

Tortar Nov 15, 2023 •

edited

Loading

Datseris Nov 18, 2023

Datseris Nov 13, 2023

jacobusmmsmit Nov 22, 2023

Datseris commented Nov 22, 2023

Tortar commented Nov 23, 2023

jacobusmmsmit commented Nov 23, 2023

Tortar commented Nov 23, 2023 •

edited

Loading

jacobusmmsmit commented Nov 23, 2023

Datseris commented Nov 24, 2023

Datseris commented Nov 24, 2023 •

edited

Loading

Tortar commented Dec 28, 2023

Implement EventQueueABM #917

Implement EventQueueABM #917

Conversation

Tortar commented Nov 7, 2023 • edited Loading

codecov-commenter commented Nov 7, 2023 • edited Loading

Codecov Report

Datseris commented Nov 8, 2023

Tortar commented Nov 8, 2023

Tortar Nov 12, 2023

Choose a reason for hiding this comment

Tortar Nov 12, 2023

Choose a reason for hiding this comment

Tortar Nov 12, 2023 • edited Loading

Choose a reason for hiding this comment

Tortar Nov 15, 2023 • edited Loading

Choose a reason for hiding this comment

Datseris Nov 18, 2023

Choose a reason for hiding this comment

Datseris Nov 13, 2023

Choose a reason for hiding this comment

jacobusmmsmit Nov 22, 2023

Choose a reason for hiding this comment

Datseris commented Nov 22, 2023

Tortar commented Nov 23, 2023

jacobusmmsmit commented Nov 23, 2023

Tortar commented Nov 23, 2023 • edited Loading

jacobusmmsmit commented Nov 23, 2023

Datseris commented Nov 24, 2023

Datseris commented Nov 24, 2023 • edited Loading

Tortar commented Dec 28, 2023

Tortar commented Nov 7, 2023 •

edited

Loading

codecov-commenter commented Nov 7, 2023 •

edited

Loading

Tortar Nov 12, 2023 •

edited

Loading

Tortar Nov 15, 2023 •

edited

Loading

Tortar commented Nov 23, 2023 •

edited

Loading

Datseris commented Nov 24, 2023 •

edited

Loading