tf.keras.preprocessing.image_dataset_from_directory
Generates a tf.data.Dataset
from image files in a directory.
tf.keras.preprocessing.image_dataset_from_directory( directory, labels='inferred', label_mode='int', class_names=None, color_mode='rgb', batch_size=32, image_size=(256, 256), shuffle=True, seed=None, validation_split=None, subset=None, interpolation='bilinear', follow_links=False )
If your directory structure is:
main_directory/ ...class_a/ ......a_image_1.jpg ......a_image_2.jpg ...class_b/ ......b_image_1.jpg ......b_image_2.jpg
Then calling image_dataset_from_directory(main_directory, labels='inferred')
will return a tf.data.Dataset
that yields batches of images from the subdirectories class_a
and class_b
, together with labels 0 and 1 (0 corresponding to class_a
and 1 corresponding to class_b
).
Supported image formats: jpeg, png, bmp, gif. Animated gifs are truncated to the first frame.
Arguments | |
---|---|
directory | Directory where the data is located. If labels is "inferred", it should contain subdirectories, each containing images for a class. Otherwise, the directory structure is ignored. |
labels | Either "inferred" (labels are generated from the directory structure), or a list/tuple of integer labels of the same size as the number of image files found in the directory. Labels should be sorted according to the alphanumeric order of the image file paths (obtained via os.walk(directory) in Python). |
label_mode |
|
class_names | Only valid if "labels" is "inferred". This is the explict list of class names (must match names of subdirectories). Used to control the order of the classes (otherwise alphanumerical order is used). |
color_mode | One of "grayscale", "rgb", "rgba". Default: "rgb". Whether the images will be converted to have 1, 3, or 4 channels. |
batch_size | Size of the batches of data. Default: 32. |
image_size | Size to resize images to after they are read from disk. Defaults to (256, 256) . Since the pipeline processes batches of images that must all have the same size, this must be provided. |
shuffle | Whether to shuffle the data. Default: True. If set to False, sorts the data in alphanumeric order. |
seed | Optional random seed for shuffling and transformations. |
validation_split | Optional float between 0 and 1, fraction of data to reserve for validation. |
subset | One of "training" or "validation". Only used if validation_split is set. |
interpolation | String, the interpolation method used when resizing images. Defaults to bilinear . Supports bilinear , nearest , bicubic , area , lanczos3 , lanczos5 , gaussian , mitchellcubic . |
follow_links | Whether to visits subdirectories pointed to by symlinks. Defaults to False. |
Returns | |
---|---|
A tf.data.Dataset object.
|
Rules regarding labels format:
- if
label_mode
isint
, the labels are anint32
tensor of shape(batch_size,)
. - if
label_mode
isbinary
, the labels are afloat32
tensor of 1s and 0s of shape(batch_size, 1)
. - if
label_mode
iscategorial
, the labels are afloat32
tensor of shape(batch_size, num_classes)
, representing a one-hot encoding of the class index.
Rules regarding number of channels in the yielded images:
- if
color_mode
isgrayscale
, there's 1 channel in the image tensors. - if
color_mode
isrgb
, there are 3 channel in the image tensors. - if
color_mode
isrgba
, there are 4 channel in the image tensors.
© 2020 The TensorFlow Authors. All rights reserved.
Licensed under the Creative Commons Attribution License 3.0.
Code samples licensed under the Apache 2.0 License.
https://www.tensorflow.org/versions/r2.4/api_docs/python/tf/keras/preprocessing/image_dataset_from_directory