Add utility for Reload Transformers imports cache for development workflow #35508 #35858
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.
Problem Statement
When developing or modifying Transformers models, cached imports can prevent code changes from being picked up without manually restarting Python. This makes the development workflow more cumbersome, especially when making iterative changes to model implementations.
Fixes #35508
Root Cause Analysis
The issue stems from Python's module caching behavior in
sys.modules
. Additionally, Transformers uses a custom_LazyModule
system for imports that maintains its own object cache. Both these caches need to be cleared to fully reload modified code.Implementation
Added a
clear_import_cache()
utility function totransformers.utils.import_utils
that:sys.modules
_LazyModule
instancessys.modules
The implementation is minimally invasive and works with Transformers' existing module system.
Testing
Added a test case that verifies:
sys.modules
The test ensures the cache clearing is thorough while maintaining backward compatibility.
Screenshots
cc : @ArthurZucker @SunMarc @Rocketknight1 and anyone interested in development workflow improvements.