Generate structural change warnings and log_once functionality #2801
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 adds two new functions to Ludwig:
warn_structure_refactor
creates a warning (once per module) to let users know that the location of a module has changed from location A to location B, and that they should update their imports.log_once
enables logging a warning just once based on the key passed in, which is very useful for things like warnings, failed image/data processing reads, etc.The motivation to add this functionality to help create neat deprecation warnings for module/structural level changes in the future (such as moving automl utils into the automl top level directory).