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

Deprecate ram/vram configs for smoother migration path to dynamic limits #7526

Merged
merged 1 commit into from
Jan 7, 2025

Conversation

RyanJDick
Copy link
Collaborator

Summary

Changes:

  • Deprecate ram and vram configs. If these are set in invokeai.yaml, they will be ignored.
  • Create new max_cache_ram_gb and max_cache_vram_gb configs with the same definitions as the old configs.

The main motivation of this change is to make the migration path smoother for users who had previously added ram /vram to their config files. Now, these users will be automatically migrated into the new dynamic limit behavior (which is better in most cases). These users will have to manually re-add max_cache_ram_gb and max_cache_vram_gb to their configs if they wish to go back to specifying manual limits.

Related Issues / Discussions

See the release notes for RC v5.6.0rc1 for the old migration behavior that we are trying to improve: https://github.com/invoke-ai/InvokeAI/releases/tag/v5.6.0rc1

QA Instructions

  • Test that if ram or vram are present in a user's invokeai.yaml, these values are ignored.
  • Test that max_cache_ram_gb and max_cache_vram_gb are applied, if set.

Merge Plan

  • Don't forget to update the RC release notes accordingly.

Checklist

  • The PR has a short but descriptive title, suitable for a changelog
  • Tests added / updated (if applicable)
  • Documentation added / updated (if applicable)
  • Updated What's New copy (if doing a release after this PR)

memory limits smoother for users who had previously overriden these
values.
@github-actions github-actions bot added python PRs that change python files services PRs that change app services python-tests PRs that change python tests labels Jan 7, 2025
@RyanJDick RyanJDick merged commit 4df3d08 into main Jan 7, 2025
15 checks passed
@RyanJDick RyanJDick deleted the ryan/deprecate-ram-vram branch January 7, 2025 22:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
python PRs that change python files python-tests PRs that change python tests services PRs that change app services
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants