Removal schedule for legacy model builder API
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 17.9k
- Forks
- 7.3k
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 13
Description
Although our documentation is explicit
our runtime warnings are really vague:
- https://github.com/pytorch/vision/blob/ecbed7bd604a705d4b3709d97817598166b480ca/torchvision/models/_utils.py#L135-L139
- https://github.com/pytorch/vision/blob/ecbed7bd604a705d4b3709d97817598166b480ca/torchvision/models/_utils.py#L208-L211
- https://github.com/pytorch/vision/blob/ecbed7bd604a705d4b3709d97817598166b480ca/torchvision/models/_utils.py#L213-L217
Apart from not committing to an explicit removal date, we are not even committing to removing this in general, i.e.
may be removed
In https://github.com/pytorch/vision/pull/7176#discussion_r1098367538 we decided to not remove this functionality together with all other scheduled removals for 0.15.
However, we should decide on the future of this. Here are some options that I see:
- Make the date in the runtime warnings explicit and remove afterwards. Abiding by our own BC policy, we probably need to use 0.17 as removal date. At that point, users saw the warning for 4 releases and thus roughly 1 year, which gave them plenty time to migrate.
- Remove the documentation of the legacy API, but keep supporting it silently, i.e. no warnings. Going this route would mean that new users won't know about the legacy API, but old code doesn't need to be updated.
- Keep everything as is.
My order of preference is 1. > 2. > 3.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the legacy API documentation in docs/source/models.rst and the related warning paths in torchvision/models/_utils.py. Review the BC policy and the discussion in pull request 7176. Done means reaching a decision on the legacy API's future and updating the documented removal schedule and runtime warnings accordingly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- computer-vision
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100