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

Api docs #2298

Merged
merged 5 commits into from
Sep 18, 2024
Merged

Api docs #2298

merged 5 commits into from
Sep 18, 2024

Conversation

quaquel
Copy link
Member

@quaquel quaquel commented Sep 18, 2024

This PR reorganizes the API documentation.

It is a follow-up of #2294. The current structure of the API overview in readthedocs has become more messy partly due to explicitly using and parsing Google docstrings. Moreover, the API docs reflect a slightly outdated view of the core classes in MESA. This PR reorganizes the API docs in such a way that it is just a convenient way to get to the docs of all relevant classes. Tutorials and other docs are available to highlight how to use MESA. The API docs should be a straightforward reference manual and be easy to navigate.

@quaquel quaquel added docs Release notes label 2 - WIP labels Sep 18, 2024
Copy link

Performance benchmarks:

Model Size Init time [95% CI] Run time [95% CI]
BoltzmannWealth small 🔵 -0.5% [-1.3%, +0.3%] 🔵 -0.8% [-1.0%, -0.6%]
BoltzmannWealth large 🔵 +31.0% [+1.6%, +89.0%] 🟢 -7.1% [-11.5%, -3.4%]
Schelling small 🔵 -0.6% [-0.9%, -0.2%] 🔵 -1.1% [-1.4%, -0.8%]
Schelling large 🔵 -0.4% [-1.5%, +0.7%] 🟢 -5.5% [-6.9%, -4.0%]
WolfSheep small 🔵 -0.7% [-2.0%, +0.5%] 🔵 -0.7% [-1.1%, -0.4%]
WolfSheep large 🔵 -2.7% [-4.6%, -1.1%] 🟢 -7.3% [-9.0%, -5.8%]
BoidFlockers small 🔵 +1.6% [+1.0%, +2.1%] 🔵 +0.7% [-0.0%, +1.3%]
BoidFlockers large 🔵 +2.3% [+1.7%, +2.8%] 🔵 +0.1% [-0.3%, +0.6%]

@quaquel quaquel removed the 2 - WIP label Sep 18, 2024
@quaquel quaquel marked this pull request as ready for review September 18, 2024 09:12
Copy link

Performance benchmarks:

Model Size Init time [95% CI] Run time [95% CI]
BoltzmannWealth small 🟢 -5.7% [-6.4%, -5.1%] 🔵 -1.0% [-1.2%, -0.9%]
BoltzmannWealth large 🔵 -8.2% [-22.8%, -1.0%] 🟢 -9.6% [-10.9%, -8.2%]
Schelling small 🔵 -1.2% [-1.5%, -0.9%] 🔵 -1.5% [-1.8%, -1.2%]
Schelling large 🔵 +0.4% [-0.1%, +0.9%] 🔵 +3.7% [+2.6%, +4.8%]
WolfSheep small 🔵 -1.6% [-2.8%, -0.4%] 🔵 -0.3% [-0.6%, +0.1%]
WolfSheep large 🔵 -1.7% [-3.6%, -0.3%] 🔵 -2.2% [-4.3%, -0.5%]
BoidFlockers small 🔵 +3.1% [+2.6%, +3.5%] 🔵 -1.2% [-2.0%, -0.5%]
BoidFlockers large 🔵 +2.8% [+2.5%, +3.0%] 🔵 -2.0% [-2.8%, -1.2%]

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.

Diff looks good, new rendered docs also. Good to have the AgentSet in the API docs!

@quaquel quaquel closed this Sep 18, 2024
@quaquel quaquel reopened this Sep 18, 2024
@quaquel quaquel merged commit b95dd19 into projectmesa:main Sep 18, 2024
15 of 16 checks passed
@quaquel quaquel deleted the api_docs branch September 18, 2024 09:55
@EwoutH
Copy link
Member

EwoutH commented Sep 24, 2024

With hindsight, I liked the "Base Classes" concept. It separate the classes we expect users to subclass from other ones. Maybe we can structure it like this:

image

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