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

Mark SolaraViz as experimental for Mesa 3.0 #2459

Merged
merged 1 commit into from
Nov 6, 2024

Conversation

EwoutH
Copy link
Member

@EwoutH EwoutH commented Nov 5, 2024

As discussed in today's meeting, this PR adds a note at four places that marks SolaraViz as experimental in Mesa 3.0.

Add a note at four places that marks SolaraViz as experimental in Mesa 3.0
@EwoutH EwoutH added docs Release notes label experimental Release notes label labels Nov 5, 2024
Copy link

github-actions bot commented Nov 5, 2024

Performance benchmarks:

Model Size Init time [95% CI] Run time [95% CI]
BoltzmannWealth small 🔴 +6.8% [+5.1%, +8.5%] 🔵 +0.1% [-0.2%, +0.4%]
BoltzmannWealth large 🔵 +1.1% [+0.6%, +1.6%] 🔵 +2.7% [+1.0%, +4.6%]
Schelling small 🔵 +1.2% [+0.7%, +1.8%] 🔵 +1.7% [+1.4%, +1.9%]
Schelling large 🔵 +1.6% [+0.4%, +2.7%] 🔵 +0.0% [-1.2%, +1.4%]
WolfSheep small 🔵 +1.4% [+1.0%, +1.8%] 🔴 +4.1% [+3.4%, +4.8%]
WolfSheep large 🔵 +0.7% [-0.9%, +2.3%] 🔵 -1.1% [-3.4%, +1.2%]
BoidFlockers small 🔵 +3.5% [+2.8%, +4.1%] 🔵 +2.1% [+0.9%, +3.2%]
BoidFlockers large 🔴 +4.1% [+3.1%, +5.1%] 🔵 +3.3% [+2.6%, +4.0%]

@wang-boyu
Copy link
Member

Sorry that I missed many meetings recently due to my work and class schedule. Here we're marking SolaraViz as experimental without moving it into the experimental namespace right?

@EwoutH
Copy link
Member Author

EwoutH commented Nov 6, 2024

Yes, we won’t want to break namespaces again.

We will attempt not to break API, but since it’s such active development we want to give ourselves a bit of room. We also don9t want to delay 3.0 much further.

To be honest, I also don’t like it, because this means shipping Mesa 3.0 without formally stable visualization, but I do feel this is the better long term option.

@Corvince
Copy link
Contributor

Corvince commented Nov 6, 2024

I share this concern. "Experimental" sounds quite unstable to me. What about the idea of just declaring the components experimental? That would mean we ship a stable SolaraViz (which API I think is indeed stable, I don't know that we should change about it in a breaking way). We just say that creating the components is a bit up to the user, but we provide these experimental functions users can use and will likely not break, but might. (Again, I don't think the API of make_space_component needs to change in a backwards-incompatible way, but I am fine with declaring it experimental for now). So, to be super safe users could just code up their own components and have a stable frontend.

But yeah, also sorry that I wasn't at the meeting.

One last point: we always wanted to rename SolaraViz to ???. Is this still a thing (by now we should at least alias it to SolaraViz, but we could still do a rename)

@EwoutH
Copy link
Member Author

EwoutH commented Nov 6, 2024

I’ve a really conflicted opinion here, so I’m not the one to argue for this. I’m okay with any consensus that’s reached.

The only thing I find really important that we release Mesa 3.0 this week.

@Corvince
Copy link
Contributor

Corvince commented Nov 6, 2024

Yes, this is the most important thing. Agree, if there already is an agreement we should probably just go with it.

@quaquel
Copy link
Member

quaquel commented Nov 6, 2024

I suggest we just call it experimental and revisit that decision for 3.1. This gives us ample time to pick up various outstanding issues as well as ideas we individually might have about future development. If we can solve the open issues and implement some of these ideas without braking the existing API by 3.1. We can declare it stable. However, for it to be called stable, I really want to have proper test code coverage again for all of it.

@EwoutH
Copy link
Member Author

EwoutH commented Nov 6, 2024

If there are no further objections I will merge in an hour or so, an then release the Mesa 3.0 Release candidate.

@EwoutH EwoutH merged commit 5cdec7e into projectmesa:main Nov 6, 2024
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Release notes label experimental Release notes label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants