Open
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This PR clarifies the semantics of percentage-based values for the budgets parameter in the README.
Previously, the documentation stated that a string value represents a “percentage of the total VRAM”, but it was not explicit whether this referred to a real percentage (e.g. 2% = 0.02 * VRAM) or a raw multiplier. This ambiguity could easily lead to misinterpretation and incorrect configuration.
The README now explicitly states that percentage strings represent real percentages of total available VRAM (for example, "2%" means 2% of total VRAM).
If anyone relied on a different interpretation of percentage values in the past, this clarification may reveal a behavior change or a mismatch with existing configurations. For this reason, this could be considered a breaking change from a user perspective, depending on how % budgets were previously understood and used.
I am not fully certain whether this warrants a major version bump (e.g. to 4.0.0), as this PR only updates documentation, but I wanted to explicitly call out the potential compatibility implications.