org.deeplearning4j.zoo.util

Class BaseLabels

java.lang.Object

org.deeplearning4j.zoo.util.BaseLabels

All Implemented Interfaces:

Labels

Direct Known Subclasses:

COCOLabels, DarknetLabels, ImageNetLabels, VOCLabels

public abstract class BaseLabels
extends Object
implements Labels

Base functionality for helper classes that return label descriptions.

Author:

saudet

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrayList<String>	labels

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseLabels() Override getLabels() when using this constructor.
protected	BaseLabels(String textResource) No need to override anything with this constructor.

Method Summary

Modifier and Type	Method and Description
List<List<ClassPrediction>>	decodePredictions(INDArray predictions, int n) Given predictions from the trained model this method will return a list of the top n matches and the respective probabilities.
String	getLabel(int n) Returns the description of the nth class from the classes of a dataset.
protected ArrayList<String>	getLabels() Override to return labels when not calling BaseLabels(String).
protected ArrayList<String>	getLabels(String textResource) Returns labels based on the text file resource.
protected File	getResourceFile() Download the resource at getURL() to the local resource directory, and return the local copy as a File
protected abstract URL	getURL()
protected abstract String	resourceMD5()
protected abstract String	resourceName()

Methods inherited from class java.lang.Object

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

Field Detail

labels

protected ArrayList<String> labels

Constructor Detail

BaseLabels

protected BaseLabels()
              throws IOException

Override getLabels() when using this constructor.

Throws:

IOException

BaseLabels

protected BaseLabels(String textResource)
              throws IOException

No need to override anything with this constructor.

Parameters:

textResource - name of a resource containing labels as a list in a text file.

Throws:

IOException

Method Detail

getLabels

protected ArrayList<String> getLabels()
                               throws IOException

Override to return labels when not calling BaseLabels(String).

Throws:

IOException

getLabels

protected ArrayList<String> getLabels(String textResource)
                               throws IOException

Returns labels based on the text file resource.

Throws:

IOException

getLabel

public String getLabel(int n)

Description copied from interface: Labels

Returns the description of the nth class from the classes of a dataset.

Specified by:

getLabel in interface Labels

Returns:

label description

decodePredictions

public List<List<ClassPrediction>> decodePredictions(INDArray predictions,
                                                     int n)

Description copied from interface: Labels

Given predictions from the trained model this method will return a list of the top n matches and the respective probabilities.

Specified by:

decodePredictions in interface Labels

Parameters:

predictions - raw

Returns:

decoded predictions

getURL

protected abstract URL getURL()

Returns:

URL of the resource to download

resourceName

protected abstract String resourceName()

Returns:

Name of the resource (used for inferring local storage parent directory)

resourceMD5

protected abstract String resourceMD5()

Returns:

MD5 of the resource at getURL()

getResourceFile

protected File getResourceFile()

Download the resource at getURL() to the local resource directory, and return the local copy as a File

Returns:

File of the local resource