torchvision.ImageFolder type hint need update to include Path type
Open
Nobody has claimed this yet.
module: datasets
- Dominant language
- Python
- Stars
- 17.9k
- Forks
- 7.3k
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 13
Description
The type hint of root in ImageFolder in torchvion is str, but it also support pathlib.Path type, this will result in pyright warning, so seems we should update the type hint to root: str | Path?
def __init__(
self,
root: str,
transform: Optional[Callable] = None,
target_transform: Optional[Callable] = None,
loader: Callable[[str], Any] = default_loader,
is_valid_file: Optional[Callable[[str], bool]] = None,
):
cc @pmeier
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 at the ImageFolder.init entry point shown in the issue and inspect how the root parameter is annotated and used. Check the existing type-checking or test coverage around ImageFolder, then verify that pathlib.Path is accepted without the reported pyright warning. Done means the annotation reflects the supported inputs and relevant checks pass.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, pytorch
- Domain
- computer-vision
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100