ai.djl.basicdataset

Class AbstractImageFolder

java.lang.Object

ai.djl.training.dataset.RandomAccessDataset

ai.djl.basicdataset.AbstractImageFolder

All Implemented Interfaces:

ai.djl.repository.dataset.PreparedDataset, ai.djl.training.dataset.Dataset, java.util.RandomAccess

Direct Known Subclasses:

ImageFolder, ImageNet

public abstract class AbstractImageFolder
extends ai.djl.training.dataset.RandomAccessDataset
implements ai.djl.repository.dataset.PreparedDataset

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractImageFolder.ImageFolderBuilder<T extends AbstractImageFolder.ImageFolderBuilder> Used to build an AbstractImageFolder.

Nested classes/interfaces inherited from class ai.djl.training.dataset.RandomAccessDataset

ai.djl.training.dataset.RandomAccessDataset.BaseBuilder<T extends ai.djl.training.dataset.RandomAccessDataset.BaseBuilder>

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

ai.djl.training.dataset.Dataset.Usage

Field Summary

Fields

Modifier and Type	Field and Description
protected ai.djl.modality.cv.util.NDImageUtils.Flag	flag
protected ai.djl.util.PairList<java.lang.String,java.lang.Integer>	items
protected ai.djl.repository.Repository	repository
protected java.util.List<java.lang.String>	synset

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

batchifier, device, executor, limit, pipeline, prefetchNumber, sampler, targetPipeline

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractImageFolder(AbstractImageFolder.ImageFolderBuilder<?> builder)

Method Summary

Modifier and Type	Method and Description
protected long	availableSize()
ai.djl.training.dataset.Record	get(ai.djl.ndarray.NDManager manager, long index)
protected abstract java.nio.file.Path	getImagePath(java.lang.String key)
java.util.List<java.lang.String>	getSynset() Returns the synsets of the ImageFolder dataset.
protected void	listImages(java.io.File root, java.util.List<java.lang.String> classes)

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

getData, getData, randomSplit, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.djl.repository.dataset.PreparedDataset

prepare, prepare

Field Detail

repository

protected ai.djl.repository.Repository repository

flag

protected ai.djl.modality.cv.util.NDImageUtils.Flag flag

synset

protected java.util.List<java.lang.String> synset

items

protected ai.djl.util.PairList<java.lang.String,java.lang.Integer> items

Constructor Detail

AbstractImageFolder

protected AbstractImageFolder(AbstractImageFolder.ImageFolderBuilder<?> builder)

Method Detail

get

public ai.djl.training.dataset.Record get(ai.djl.ndarray.NDManager manager,
                                          long index)
                                   throws java.io.IOException

Specified by:

get in class ai.djl.training.dataset.RandomAccessDataset

Throws:

java.io.IOException

availableSize

protected long availableSize()

Specified by:

availableSize in class ai.djl.training.dataset.RandomAccessDataset

getSynset

public java.util.List<java.lang.String> getSynset()

Returns the synsets of the ImageFolder dataset.

Returns:

a list that contains synsets

listImages

protected void listImages(java.io.File root,
                          java.util.List<java.lang.String> classes)

getImagePath

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