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

Remove version specific docs #2636

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

EwoutH
Copy link
Member

@EwoutH EwoutH commented Jan 21, 2025

Update version references in docs to be more generic, avoiding the need to update them with each release.

Also, SolaraViz has been stable and well-tested through the Mesa 3.0.x series. Remove the experimental warnings and version-specific notes from documentation, as it is now a stable component of Mesa 3.1.

Update version references in docs
to be more generic, avoiding the need to update them with each release.

Also, SolaraViz has been stable and well-tested through the Mesa 3.0.x series. Remove
the experimental warnings and version-specific notes from documentation, as it
is now a stable component of Mesa 3.1.
@EwoutH EwoutH added docs Release notes label maintenance Release notes label ignore-for-release PRs that aren't included in the release notes labels Jan 21, 2025
@EwoutH EwoutH requested review from quaquel and tpike3 January 21, 2025 14:17
Copy link

Performance benchmarks:

Model Size Init time [95% CI] Run time [95% CI]
BoltzmannWealth small 🔵 +2.8% [+1.3%, +4.4%] 🔵 -0.8% [-1.0%, -0.5%]
BoltzmannWealth large 🔵 -1.4% [-4.2%, +0.3%] 🔵 +3.7% [+1.9%, +5.2%]
Schelling small 🔵 -1.0% [-1.3%, -0.8%] 🔵 -1.8% [-1.9%, -1.7%]
Schelling large 🔵 -0.5% [-0.8%, -0.2%] 🔵 -1.0% [-1.6%, -0.2%]
WolfSheep small 🔵 -1.8% [-2.0%, -1.6%] 🔵 -0.6% [-0.8%, -0.4%]
WolfSheep large 🔵 -0.4% [-1.1%, +0.2%] 🔵 +2.7% [+1.3%, +4.1%]
BoidFlockers small 🔵 +0.3% [-0.2%, +0.7%] 🔵 +0.5% [+0.3%, +0.7%]
BoidFlockers large 🔵 +0.1% [-0.5%, +0.7%] 🔵 +0.7% [+0.4%, +1.0%]

@@ -177,8 +177,6 @@ The results are returned as a list of dictionaries, which can be easily converte
### Visualization
Mesa now uses a new browser-based visualization system called SolaraViz. This allows for interactive, customizable visualizations of your models.

> **Note:** SolaraViz is experimental and still in active development for Mesa 3.0. While we attempt to minimize them, there might be API breaking changes between Mesa 3.0 and 3.1. There won't be breaking changes between Mesa 3.0.x patch releases.
Copy link
Member

Choose a reason for hiding this comment

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

I am not sure about this removal. Yes solara as basis is fine, but I am not convinced yet fully by the api side of things.

Copy link
Member Author

Choose a reason for hiding this comment

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

We can't keep it experimental forever right? Maybe we need to commit to the current API and move to 4.0 if we want to change / overhaul it again.

Copy link
Member

Choose a reason for hiding this comment

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

Nothing has changed fundamentally compared to where we were when releasing 3.0. So, all the reasons we had back then for keeping it experimental still stand. The passing of time alone is not a reason for making something suddenly stable.

In fact, the recent bugs we have found underline the immaturity of the code, further validating this original choice to keep it experimental.

Copy link
Member Author

Choose a reason for hiding this comment

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

Not sure if I fully align on the time passing statement, but in general sentiment I agree.

Shall we change the note to simply say 3.x?

Note: SolaraViz is experimental and still in active development in Mesa 3.x. While we attempt to minimize them, there might be API breaking changes in minor releases.

"""Solara based visualization for Mesa models.

.. note::
SolaraViz is experimental and still in active development for Mesa 3.0. While we attempt to minimize them, there might be API breaking changes between Mesa 3.0 and 3.1.
Copy link
Member

Choose a reason for hiding this comment

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

see my earlier comment

Copy link
Member

@quaquel quaquel left a comment

Choose a reason for hiding this comment

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

fine except the solara experimental stuff.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Release notes label ignore-for-release PRs that aren't included in the release notes maintenance Release notes label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants