[TVMScript][UX] Introduce decorator for deprecation #13941
Merged
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
|
Thanks for contributing to TVM! Please refer to the contributing guidelines https://tvm.apache.org/docs/contribute/ for useful information and tips. Please request code reviews from Reviewers by @-ing them in a comment. Generated by tvm-bot |
junrushao
force-pushed
the
feature/2023-02-08/deprecate-tir-legacy-behavior
branch
from
4011018 to
9b1846d
Compare
junrushao
changed the title
junrushao
force-pushed
the
feature/2023-02-08/deprecate-tir-legacy-behavior
branch
4 times, most recently
from
a129272 to
6e41cc5
Compare
spectrometerHBH
approved these changes
Feb 10, 2023
Hzfengsy
reviewed
Feb 10, 2023
This PR introduces a decorator `tvm.ir.base.deprecated`, which emits a deprecation warning if an outdated API is used, but preserves backward compatibility by still allowing the API to be used. For example, currently the preferred way of TIR buffer declaration in function signature is: ```python def example( A: T.Buffer(...), # legacy behavior is `T.Buffer[...]` ): ... ``` With this decorator, if a user writes `T.Buffer[...]`, the parser will still function properly, but emits a warning that guides the user to adopt `T.Buffer(...)` if possible. While there is no breaking change at all in this PR, we believe this is useful to help users upgrade before any breaking change eventually takes place.
junrushao
force-pushed
the
feature/2023-02-08/deprecate-tir-legacy-behavior
branch
from
6e41cc5 to
0b6bcb9
Compare
Hzfengsy
approved these changes
Feb 10, 2023
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.
This PR introduces a decorator
tvm.ir.base.deprecated, which emits adeprecation warning if an outdated API is used, but preserves backward
compatibility by still allowing the API to be used.
For example, currently the preferred way of TIR buffer declaration in
function signature is:
With this decorator, if a user writes
T.Buffer[...], the parser willstill function properly, but emits a warning that guides the user to
adopt
T.Buffer(...)if possible.While there is no breaking change at all in this PR, we believe this
is useful to help users upgrade before any breaking change eventually
takes place.