ai.djl.basicdataset.cv.classification

Class ImageClassificationDataset

java.lang.Object

ai.djl.training.dataset.RandomAccessDataset

ai.djl.basicdataset.cv.classification.ImageClassificationDataset

All Implemented Interfaces:

ai.djl.training.dataset.Dataset

Direct Known Subclasses:

AbstractImageFolder

public abstract class ImageClassificationDataset
extends ai.djl.training.dataset.RandomAccessDataset

A helper to create Datasets for Application.CV.IMAGE_CLASSIFICATION.

Nested Class Summary

Nested Classes

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

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.training.dataset.RandomAccessDataset

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

Constructor Summary

Constructors

Constructor and Description
ImageClassificationDataset(ImageClassificationDataset.BaseBuilder<?> builder) Creates a new instance of RandomAccessDataset with the given necessary configurations.

Method Summary

Modifier and Type	Method and Description
ai.djl.training.dataset.Record	get(ai.djl.ndarray.NDManager manager, long index)
abstract java.util.List<java.lang.String>	getClasses() Returns the classes that the images in the dataset are classified into.
protected abstract long	getClassNumber(long index) Returns the class of the data item at the given index.
protected abstract ai.djl.modality.cv.Image	getImage(long index) Returns the image at the given index in the dataset.
int	getImageChannels() Returns the number of channels in the images in the dataset.
abstract java.util.Optional<java.lang.Integer>	getImageHeight() Returns the height of the images in the dataset.
abstract java.util.Optional<java.lang.Integer>	getImageWidth() Returns the width of the images in the dataset.
ai.djl.translate.Translator<ai.djl.modality.cv.Image,ai.djl.modality.Classifications>	makeTranslator() Returns the ImageClassificationTranslator matching the format of this dataset.

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

availableSize, 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, prepare

Constructor Detail

ImageClassificationDataset

public ImageClassificationDataset(ImageClassificationDataset.BaseBuilder<?> builder)

Creates a new instance of RandomAccessDataset with the given necessary configurations.

Parameters:

builder - a builder with the necessary configurations

Method Detail

getImage

protected abstract ai.djl.modality.cv.Image getImage(long index)
                                              throws java.io.IOException

Returns the image at the given index in the dataset.

Parameters:

index - the index (if the dataset is a list of data items)

Returns:

the image

Throws:

java.io.IOException - if the image could not be loaded

getClassNumber

protected abstract long getClassNumber(long index)
                                throws java.io.IOException

Returns the class of the data item at the given index.

Parameters:

index - the index (if the dataset is a list of data items)

Returns:

the class number or the index into the list of classes of the desired class name

Throws:

java.io.IOException - if the data could not be loaded

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

makeTranslator

public ai.djl.translate.Translator<ai.djl.modality.cv.Image,ai.djl.modality.Classifications> makeTranslator()

Returns the ImageClassificationTranslator matching the format of this dataset.

Returns:

the ImageClassificationTranslator matching the format of this dataset

getImageChannels

public int getImageChannels()

Returns the number of channels in the images in the dataset.

For example, RGB would be 3 channels while grayscale only uses 1 channel.

Returns:

the number of channels in the images in the dataset

getImageWidth

public abstract java.util.Optional<java.lang.Integer> getImageWidth()

Returns the width of the images in the dataset.

Returns:

the width of the images in the dataset

getImageHeight

public abstract java.util.Optional<java.lang.Integer> getImageHeight()

Returns the height of the images in the dataset.

Returns:

the height of the images in the dataset

getClasses

public abstract java.util.List<java.lang.String> getClasses()

Returns the classes that the images in the dataset are classified into.

Returns:

the classes that the images in the dataset are classified into