Package ai.djl.modality.cv.translator

Class ImageClassificationTranslator

java.lang.Object

ai.djl.modality.cv.translator.BaseImageTranslator<Classifications>

ai.djl.modality.cv.translator.ImageClassificationTranslator

All Implemented Interfaces:

PostProcessor<Classifications>, PreProcessor<Image>, Translator<Image,Classifications>

public class ImageClassificationTranslator
extends BaseImageTranslator<Classifications>

A generic Translator for Image Classification tasks.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImageClassificationTranslator.Builder	A Builder to construct a ImageClassificationTranslator.

Nested classes/interfaces inherited from class ai.djl.modality.cv.translator.BaseImageTranslator

BaseImageTranslator.BaseBuilder<T extends BaseImageTranslator.BaseBuilder>, BaseImageTranslator.ClassificationBuilder<T extends BaseImageTranslator.BaseBuilder>, BaseImageTranslator.SynsetLoader

Field Summary

Fields inherited from class ai.djl.modality.cv.translator.BaseImageTranslator

pipeline

Constructor Summary

Constructors

Constructor	Description
ImageClassificationTranslator(ImageClassificationTranslator.Builder builder)	Constructs an Image Classification using ImageClassificationTranslator.Builder.

Method Summary

Modifier and Type	Method	Description
static ImageClassificationTranslator.Builder	builder()	Creates a builder to build a ImageClassificationTranslator.
static ImageClassificationTranslator.Builder	builder(java.util.Map<java.lang.String,?> arguments)	Creates a builder to build a ImageClassificationTranslator with specified arguments.
TranslatorOptions	getExpansions()	Returns possible TranslatorOptions that can be built using this Translator.
void	prepare(TranslatorContext ctx)	Prepares the translator with the manager and model to use.
Classifications	processOutput(TranslatorContext ctx, NDList list)	Processes the output NDList to the corresponding output object.

Methods inherited from class ai.djl.modality.cv.translator.BaseImageTranslator

getBatchifier, processInput

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.djl.translate.Translator

toBatchTranslator, toBatchTranslator

Constructor Detail

ImageClassificationTranslator

public ImageClassificationTranslator(ImageClassificationTranslator.Builder builder)

Constructs an Image Classification using ImageClassificationTranslator.Builder.

Parameters:

builder - the data to build with

Method Detail

prepare

public void prepare(TranslatorContext ctx)
             throws java.io.IOException

Prepares the translator with the manager and model to use.

Parameters:

ctx - the context for the Predictor.

Throws:

java.io.IOException

processOutput

public Classifications processOutput(TranslatorContext ctx,
                                     NDList list)

Processes the output NDList to the corresponding output object.

Parameters:

ctx - the toolkit used for post-processing

list - the output NDList after inference, usually immutable in engines like PyTorch. @see Issue 1774

Returns:

the output object of expected type

getExpansions

public TranslatorOptions getExpansions()

Returns possible TranslatorOptions that can be built using this Translator.

Returns:

possible options or null if not defined

builder

public static ImageClassificationTranslator.Builder builder()

Creates a builder to build a ImageClassificationTranslator.

Returns:

a new builder

builder

public static ImageClassificationTranslator.Builder builder(java.util.Map<java.lang.String,?> arguments)

Creates a builder to build a ImageClassificationTranslator with specified arguments.

Parameters:

arguments - arguments to specify builder options

Returns:

a new builder