Package ai.djl.basicdataset.cv.classification

Class ImageFolder

java.lang.Object

ai.djl.training.dataset.RandomAccessDataset

ai.djl.basicdataset.cv.ImageDataset

ai.djl.basicdataset.cv.classification.ImageClassificationDataset

ai.djl.basicdataset.cv.classification.AbstractImageFolder

ai.djl.basicdataset.cv.classification.ImageFolder

All Implemented Interfaces:

ai.djl.training.dataset.Dataset

public final class ImageFolder
extends AbstractImageFolder

A dataset for loading image files stored in a folder structure.

  The image folder should be structured as follows:
       root/shoes/Aerobic Shoes1.png
       root/shoes/Aerobic Shose2.png
       ...
       root/boots/Black Boots.png
       root/boots/White Boots.png
       ...
       root/pumps/Red Pumps
       root/pumps/Pink Pumps
       ...
  here shoes, boots, pumps are your labels
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImageFolder.Builder	A builder for the ImageFolder.

Nested classes/interfaces inherited from class ai.djl.basicdataset.cv.classification.AbstractImageFolder

AbstractImageFolder.ImageFolderBuilder<T extends AbstractImageFolder.ImageFolderBuilder<T>>

Nested classes/interfaces inherited from class ai.djl.basicdataset.cv.ImageDataset

ImageDataset.BaseBuilder<T extends ImageDataset.BaseBuilder<T>>

Nested classes/interfaces inherited from interface ai.djl.training.dataset.Dataset

ai.djl.training.dataset.Dataset.Usage

Field Summary

Fields inherited from class ai.djl.basicdataset.cv.classification.AbstractImageFolder

items, mrl, prepared, synset

Fields inherited from class ai.djl.basicdataset.cv.ImageDataset

flag

Fields inherited from class ai.djl.training.dataset.RandomAccessDataset

dataBatchifier, device, labelBatchifier, limit, pipeline, prefetchNumber, sampler, targetPipeline

Method Summary

Modifier and Type	Method	Description
static ImageFolder.Builder	builder()	Creates a new builder to build a ImageFolder.
protected java.nio.file.Path	getImagePath(java.lang.String key)
void	prepare(ai.djl.util.Progress progress)

Methods inherited from class ai.djl.basicdataset.cv.classification.AbstractImageFolder

availableSize, getClasses, getClassNumber, getImage, getImageHeight, getImageWidth, getSynset, listImages

Methods inherited from class ai.djl.basicdataset.cv.classification.ImageClassificationDataset

get, makeTranslator

Methods inherited from class ai.djl.basicdataset.cv.ImageDataset

getImageChannels, getRecordImage

Methods inherited from class ai.djl.training.dataset.RandomAccessDataset

getData, getData, getData, getData, randomSplit, size, subDataset, toArray

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ai.djl.training.dataset.Dataset

prepare

Method Detail

builder

public static ImageFolder.Builder builder()

Creates a new builder to build a ImageFolder.

Returns:

a new builder

getImagePath

protected java.nio.file.Path getImagePath(java.lang.String key)

Specified by:

getImagePath in class AbstractImageFolder

prepare

public void prepare(ai.djl.util.Progress progress)
             throws java.io.IOException

Throws:

java.io.IOException