Skip to content

Commit

Permalink
Add note about behaviour of asserts in batch jobs (#1573)
Browse files Browse the repository at this point in the history
* Add note about behaviour of asserts in batch jobs

* Apply suggestions from code review

Co-authored-by: Asif Tamuri <[email protected]>

---------

Co-authored-by: Asif Tamuri <[email protected]>
  • Loading branch information
matt-graham and tamuri authored Jan 17, 2025
1 parent ed8a131 commit d500d75
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/azure_batch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,13 @@ Each of the subcommands of ``tlo`` has a ``--help`` flag for further information
*Submit scenario to Azure Batch*::

tlo batch-submit src/scripts/dev/tlo_q1_demo.py
.. note:: **Behaviour of assert statements**

Scenario runs submitted with ``tlo batch-submit`` will by default run with any assert statements disabled.
Typically, these are used for checking correctness of code in tests and local runs but as they add some overhead,
we can get a useful speed-up by disabling them on longer jobs.
To run jobs with assertions enabled pass the ``--asserts-on`` flag` to ``tlo batch-submit``.

*List jobs currently on Azure Batch where id contains "tamuri"*::

Expand Down

0 comments on commit d500d75

Please sign in to comment.