Include option to use emulator in RTI module #1756

marghe-molaro · 2025-11-20T11:21:55Z

This PR offers users the option to use an emulated version of the RTI module. It will require #1758 to run.

@tamuri, a couple of "conceptual" issues:

One of the advantages of using an emulator is the need for much fewer module-specific properties in the population dataframe. However, because properties are declared before parameters are initialised, it is not possible for the module to know a priori whether the user will opt to use the emulator or not, and hence how many properties to declare. Do you have any suggestions? Could I initially declare all properties and then remove redundant ones if parameter 'use_RTI_emulator' is initialised to True? (Not very elegant)
As discussed yesterday, I wanted to include a one-time warning for the user if the emulator is being used under the "wrong" HealthSystem assumptions. This would however require knowing how the HealthSystem parameters have been initialised, but this would require relying on a known order of parameter initialisation. Where can I issue this warning while avoid issuing this repeatedly during runtime?
There is some RTI-specific logic in the HealthSystem; in the future I think we would instead iterate over all modules to check if the use_{module}_emulator parameter is set to True for any of them. But is this ok for now?

Many thanks,
Margherita

…rience the incident at the time of the polling, ensure that the end of the episode is calculated from the stored incident time in case this is updated in the future.

…ess outputs and generate data

tamuri

Thanks, Marghertia. We could tidy this up by having a new EmulatedRTI class that is separate from the RTI class. If there are things that need to be shared, you could make a base class (e.g. BaseRTI) and have both RTI and EmulatedRTI inherit that. But you may not need to because most of the code is not run in the EmulatedRTI.

Each on these classes could have their own polling event class or, if they too share code (looks like it does) the common bits could be extracted into a shared helper function or, similarly, make a BaseRTIPollingEvent and have the simulated and emulated event class use/inherit.

This would avoid the long if-else blocks and keeps the emulated RTI stuff together and separate. You might not need the 'use_emulated' in the end because a different module will be registered at simulation start.

tamuri · 2025-11-21T09:34:29Z

src/tlo/methods/demography.py

@@ -1,3 +1,4 @@
+0


tamuri · 2025-11-21T09:35:23Z

src/tlo/methods/demography.py

                'age_years', 'sex', 'prob_of_dying_before_next_poll']].copy()
-
+
+        # Artificially increase risk for men under 50 by 50


This should probably be removed for the merge...?

tamuri · 2025-11-21T09:37:33Z

src/tlo/methods/healthsystem.py

            self._write_hsi_event_counts_to_log_and_reset()
            self._write_never_ran_hsi_event_counts_to_log_and_reset()

+


Remove extraneous newline

tamuri · 2025-11-21T09:37:44Z

src/tlo/methods/healthsystem.py

    def write_to_log_and_reset_counters(self):
        """Log summary statistics reset the data structures. This usually occurs at the end of the year."""

+


Remove newline

tamuri · 2025-11-21T09:39:45Z

src/tlo/methods/rti.py

        df.loc[DALYweightunderlimit, 'rt_disability'] = 0
        assert (df.loc[injured_index, 'rt_disability'] > 0).all()

+


Remove newline

tamuri · 2025-11-21T09:45:10Z

src/tlo/simulation.py


    def run_simulation_to(self, *, to_date: Date) -> None:
        """Run simulation up to a specified date.
-


Rollback both changes in this file

tamuri · 2025-11-21T09:52:42Z

src/tlo/methods/rti.py

            Types.INT,
            "limit on the number of times an HSI event can run"
+        ),
+        'use_RTI_emulator': Parameter(


Rename this to use_emulator - you're already in RTI

tamuri · 2025-11-21T11:37:37Z

Also need to add some tests for emulated RTI.

marghe-molaro added 26 commits December 9, 2024 14:51

Start modifying RTI module to include NN option

9a54cd7

Add emulated HSI count to normal HS logger

0abcdb5

Although currently all people selected for an rti are assumed to expe…

84717cb

…rience the incident at the time of the polling, ensure that the end of the episode is calculated from the stored incident time in case this is updated in the future.

Style fixes

2a622d1

Don't scheduled some of the regular events if using the emulator

f6d684a

Include CTGAN emulator and time duration of sim

563c030

Use Gaussian emulator and print duration of run to file

76548ff

Time duration

1b2d8f6

Remove severity of accident from variables stored

240ddc5

Add alternative genAI option [skip ci]

e5df08b

Include option of conditionality

737e1eb

Increase mortality of other causes of death

7bba772

Fix scenario file

a37eab5

Check double counting

2579dd9

Turn off services and use conditional NN

9902292

Descriptive modification [skip ci]

ac47db7

Update extract data file

1b0e6ae

Make timing process based, add label to file output and create scenarios

fbc100d

Consider x250 other causes of mortality and track unique file to proc…

94ac5a4

…ess outputs and generate data

Add the dalys by sex and age plot

c341cc5

Rescale y axes

c59a159

Remove mention of RTI from simulation.py

31218bb

Merge master

d47e927

Make use of emulator an RTI parameter

2fa4970

Add and track RTI_emulator

a09fcbf

Final changes to healthsystem and rti

e1cc300

marghe-molaro requested review from tamuri and tbhallett November 20, 2025 11:21

tamuri requested changes Nov 21, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Include option to use emulator in RTI module #1756

Include option to use emulator in RTI module #1756

Uh oh!

marghe-molaro commented Nov 20, 2025 •

edited

Loading

Uh oh!

tamuri left a comment •

edited

Loading

Uh oh!

tamuri Nov 21, 2025

Uh oh!

tamuri Nov 21, 2025

Uh oh!

tamuri Nov 21, 2025

Uh oh!

tamuri Nov 21, 2025

Uh oh!

tamuri Nov 21, 2025

Uh oh!

tamuri Nov 21, 2025

Uh oh!

tamuri Nov 21, 2025

Uh oh!

tamuri commented Nov 21, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		'age_years', 'sex', 'prob_of_dying_before_next_poll']].copy()


		# Artificially increase risk for men under 50 by 50

		self._write_hsi_event_counts_to_log_and_reset()
		self._write_never_ran_hsi_event_counts_to_log_and_reset()

		def write_to_log_and_reset_counters(self):
		"""Log summary statistics reset the data structures. This usually occurs at the end of the year."""

		df.loc[DALYweightunderlimit, 'rt_disability'] = 0
		assert (df.loc[injured_index, 'rt_disability'] > 0).all()


		def run_simulation_to(self, *, to_date: Date) -> None:
		"""Run simulation up to a specified date.

Include option to use emulator in RTI module #1756

Are you sure you want to change the base?

Include option to use emulator in RTI module #1756

Uh oh!

Conversation

marghe-molaro commented Nov 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tamuri left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tamuri Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

tamuri Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

tamuri Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

tamuri Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

tamuri Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

tamuri Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

tamuri Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

tamuri commented Nov 21, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

marghe-molaro commented Nov 20, 2025 •

edited

Loading

tamuri left a comment •

edited

Loading