pytorch/examples

ImageFolder doc should clarify 1. order that images returned in 2. that all classes are concatenated into a single list

Open

#400 opened on Aug 12, 2018

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (21,634 stars) (9,429 forks)batch import
good first issue

Description

ImageFolder doc should clarify:

  1. order that images returned in (it looks like it is alphabetical (which is what I want :) ), https://github.com/pytorch/vision/blob/d6c7900d06c3388bf814cecbe90f91a9afecbefb/torchvision/datasets/folder.py#L44-L45 )
  2. that images from all classes are concatenated into a single list, into which [] operator indexes

(Cool class by the way :) )

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Examine the docstring of ImageFolder in torchvision/datasets/folder.py, around line 45, as referenced in the issue. Clarify that images are returned in alphabetical order (sorted by their full path) and that all class subdirectories are concatenated into a single list that the `[]` operator indexes into. Update the documentation to explicitly state these two points.