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

add advanced examples to rtd #2413

Merged
merged 2 commits into from
Oct 24, 2024
Merged

add advanced examples to rtd #2413

merged 2 commits into from
Oct 24, 2024

Conversation

quaquel
Copy link
Member

@quaquel quaquel commented Oct 24, 2024

This updates conf.py so the now cleaned examples are included in read the docs

Copy link

Performance benchmarks:

Model Size Init time [95% CI] Run time [95% CI]
BoltzmannWealth small 🔵 -0.4% [-0.8%, -0.0%] 🔵 -0.8% [-1.0%, -0.5%]
BoltzmannWealth large 🔵 -0.7% [-1.2%, -0.3%] 🔵 -0.3% [-0.9%, +0.3%]
Schelling small 🔵 +0.2% [-0.2%, +0.7%] 🔵 -1.0% [-1.4%, -0.6%]
Schelling large 🔵 +0.2% [-1.1%, +1.3%] 🔵 -0.6% [-1.5%, +0.3%]
WolfSheep small 🔵 -2.3% [-2.8%, -1.8%] 🔵 -0.5% [-0.8%, -0.1%]
WolfSheep large 🟢 -4.3% [-5.1%, -3.5%] 🟢 -10.6% [-11.5%, -9.7%]
BoidFlockers small 🔵 -2.5% [-3.0%, -1.9%] 🔵 +0.0% [-0.7%, +0.8%]
BoidFlockers large 🔵 -1.3% [-2.1%, -0.6%] 🔵 +0.9% [-0.1%, +1.8%]

Copy link
Member

@EwoutH EwoutH left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add subsections for the Basic and Advanced examples? Maybe with single-line explanations that basic examples only contain stable features, while the advanced ones also include experimental features.

image

@quaquel
Copy link
Member Author

quaquel commented Oct 24, 2024

Can we add subsections for the Basic and Advanced examples? Maybe with single-line explanations that basic examples only contain stable features, while the advanced ones also include experimental features.

I want to get on that next, ideally by included the root readme file as well but that will be its own pr

@quaquel quaquel merged commit c63ed4c into projectmesa:main Oct 24, 2024
11 of 12 checks passed
@EwoutH
Copy link
Member

EwoutH commented Oct 24, 2024

You do get the gist of atomic PRs!

@EwoutH EwoutH added the docs Release notes label label Oct 24, 2024
@quaquel quaquel deleted the docs branch October 25, 2024 06:02
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.

2 participants