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.

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

[JOSS] docs: Improve batch_run documentation for parallel processing #2707

Merged
merged 1 commit into from
Mar 8, 2025

Conversation

EwoutH
Copy link
Member

@EwoutH EwoutH commented Mar 6, 2025

This PR enhances the documentation for Mesa's batch_run function by:

  1. Adding explicit mention of the number_processes parameter in the getting started guide
  2. Including an explanation of why parallel processing should be avoided in Jupyter notebooks
  3. Adding a more detailed explanation in the batchrunner module docstring about multiprocessing limitations

Part of #2666, based on feedback from @martibosch.

- Add explanation of number_processes parameter in getting started guide
- Clarify why parallel processing should be avoided in Jupyter notebooks
@EwoutH EwoutH added the docs Release notes label label Mar 6, 2025
@EwoutH EwoutH requested review from jackiekazil, quaquel and jofmi March 6, 2025 21:29
@EwoutH EwoutH mentioned this pull request Mar 6, 2025
41 tasks
Copy link

github-actions bot commented Mar 6, 2025

Performance benchmarks:

Model Size Init time [95% CI] Run time [95% CI]
BoltzmannWealth small 🔵 -1.4% [-2.3%, -0.5%] 🔵 +0.1% [-0.0%, +0.3%]
BoltzmannWealth large 🔵 -0.5% [-1.1%, -0.0%] 🔵 -0.1% [-0.5%, +0.3%]
Schelling small 🔵 -0.4% [-0.5%, -0.2%] 🔵 +0.1% [-0.0%, +0.2%]
Schelling large 🔵 -0.6% [-0.8%, -0.3%] 🔵 -0.5% [-1.8%, +0.8%]
WolfSheep small 🔵 -0.4% [-0.6%, -0.2%] 🔵 -0.8% [-1.0%, -0.7%]
WolfSheep large 🔵 -0.5% [-0.7%, -0.2%] 🔵 -0.9% [-1.4%, -0.5%]
BoidFlockers small 🔵 -1.0% [-1.8%, -0.1%] 🔵 -0.7% [-0.9%, -0.5%]
BoidFlockers large 🔵 -0.6% [-1.1%, -0.1%] 🔵 -0.6% [-0.8%, -0.4%]

@EwoutH EwoutH merged commit 033facc into main Mar 8, 2025
13 checks passed
@EwoutH EwoutH deleted the batch_run_feedback branch March 8, 2025 06:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Release notes label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants