Stardew Valley: Improve generation performance by around 11% by moving calculating from rule evaluation to collect #4231
+42
−56
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… recounting everytime rules are evaluated # Conflicts: # worlds/stardew_valley/__init__.py # worlds/stardew_valley/stardew_rule/state.py # worlds/stardew_valley/test/rules/TestShipping.py
github-actions
bot
added
the
waiting-on: peer-review
Jouramie
changed the title
agilbert1412
added
the
is: enhancement
agilbert1412
approved these changes
Nov 23, 2024
|
For the record, I also tried keeping the calculation of the total item received in the rule itself, but with caching and staling when an item is collected. It seems to improve performances as the multi world gets larger, but really does not compare with the current implementation where the calculation is made directly when collecting.
|
Jouramie
changed the title
|
I updated the numbers with python 3.12 and recent merges. The improvements are much higher than previously observed! |
Exempt-Medic
reviewed
Dec 6, 2024
Exempt-Medic
reviewed
Dec 8, 2024
Exempt-Medic
approved these changes
Dec 8, 2024
agilbert1412
approved these changes
Dec 8, 2024
Exempt-Medic
added
waiting-on: core-review
|
@Exempt-Medic I got two peer reviews here, any chance you can do the core review? |
Jouramie
added a commit
to agilbert1412/Archipelago
that referenced
this pull request
Dec 17, 2024
…g calculating from rule evaluation to collect (ArchipelagoMW#4231)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is this fixing or adding?
This improves the generation speed of all stardew worlds, by around 11%, but more noticeably for allsanity worlds by around 19%. It moves the calculation of the total percentage of received items from the evaluation of the rule to the
collect/removemethods. The total is counted once every time the collection state change, instead of every time aHasProgressionPercentis evaluated. This was discovered while discussing of #4230 with @Exempt-Medic, thanks for the inspiration.Now the
HasProgressionPercentrule can simply extendReceived, and checks for an event that represent directly the percentage of progression item received. No longer need to calculate the total amount of received item in the collection state.I had to fix the shipsanity tests, because they were removing the bin two times in every subtest, which would in the long run unbalance the progression item count, and eventually make some of the tests fail.
This also fixes the same Golden Walnuts bug fixed in #4230, since we no longer need to count the total amount of item in the collection state.
How was this tested?
Unit tests, plus performance tests.
If this makes graphical changes, please attach screenshots.
N/A