ai.djl.repository.dataset

Interface ZooDataset

All Superinterfaces:

ai.djl.training.dataset.Dataset, PreparedDataset

public interface ZooDataset
extends ai.djl.training.dataset.Dataset, PreparedDataset

A Dataset whose data is found in the dataset zoo of a Repository.

The ZooDatasets are all PreparedDatasets.

Nested Class Summary

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

ai.djl.training.dataset.Dataset.Usage

Method Summary

Modifier and Type	Method and Description
Artifact	getArtifact() Returns the Artifact the dataset is found in.
MRL	getMrl() Returns the MRL of the dataset.
Repository	getRepository() Returns the Repository the dataset is found in.
ai.djl.training.dataset.Dataset.Usage	getUsage() Returns the Dataset.Usage of the dataset.
boolean	isPrepared() Returns whether the dataset has been prepared.
default void	prepare(ai.djl.util.Progress progress) Prepares the dataset for use with tracked progress.
void	prepareData(ai.djl.training.dataset.Dataset.Usage usage) Prepares the ZooDataset with the dataset specific behavior.
void	setPrepared(boolean prepared) Sets if the dataset has been prepared.
void	useDefaultArtifact() Sets the artifact to the default one.

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

getData

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

prepare

Method Detail

getMrl

MRL getMrl()

Returns the MRL of the dataset.

Returns:

the MRL of the dataset

getRepository

Repository getRepository()

Returns the Repository the dataset is found in.

Returns:

the Repository the dataset is found in

getArtifact

Artifact getArtifact()

Returns the Artifact the dataset is found in.

Returns:

the Artifact the dataset is found in

getUsage

ai.djl.training.dataset.Dataset.Usage getUsage()

Returns the Dataset.Usage of the dataset.

Returns:

the Dataset.Usage of the dataset

isPrepared

boolean isPrepared()

Returns whether the dataset has been prepared.

Returns:

true if the dataset has been prepared

setPrepared

void setPrepared(boolean prepared)

Sets if the dataset has been prepared.

Parameters:

prepared - true if the dataset has been prepared

useDefaultArtifact

void useDefaultArtifact()
                 throws java.io.IOException

Sets the artifact to the default one.

The default artifact is usually found by searching within the repository with a default mrl, version, and filter.

Throws:

java.io.IOException - for various exceptions depending on the specific dataset

prepareData

void prepareData(ai.djl.training.dataset.Dataset.Usage usage)
          throws java.io.IOException

Prepares the ZooDataset with the dataset specific behavior.

This method is called only when the dataset is not prepared, has an artifact set, and the repository artifact has already been prepared. setPrepared(boolean) does not need to be called within this method and will be called after.

Parameters:

usage - the usage to prepare

Throws:

java.io.IOException - for various exceptions depending on the specific dataset

prepare

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

Prepares the dataset for use with tracked progress.

Specified by:

prepare in interface PreparedDataset

Parameters:

progress - the progress tracker

Throws:

java.io.IOException - for various exceptions depending on the dataset