org.apache.tika.dl.imagerec

Class DL4JInceptionV3Net

java.lang.Object

org.apache.tika.dl.imagerec.DL4JInceptionV3Net

All Implemented Interfaces:

Initializable, ObjectRecogniser

public class DL4JInceptionV3Net
extends Object
implements ObjectRecogniser

DL4JInceptionV3Net is an implementation of ObjectRecogniser. This object recogniser is powered by Deeplearning4j. This implementation is pre configured to use Google's InceptionV3 model pre trained on ImageNet corpus. The models references in default settings are originally trained and exported from Keras and imported using DL4J's importer tools.

Although this implementation is made to work out of the box without user attention, for advances users who are interested in tweaking the settings, the following fields are configurable:

• modelWeightsPath
• modelJsonPath
• labelFile
• labelLang
• cacheDir
• imgWidth
• imgHeight
• imgChannels
• minConfidence

Since:

Tika 1.15

See Also:

ObjectRecogniser, ObjectRecognitionParser, TensorflowImageRecParser, TensorflowRESTRecogniser

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEF_LABEL_MAPPING
static String	DEF_MODEL_JSON

Constructor Summary

Constructors

Constructor and Description
DL4JInceptionV3Net()

Method Summary

Modifier and Type	Method and Description
static File	cachedDownload(File cacheDir, URI uri)
void	checkInitialization(InitializableProblemHandler problemHandler)
Set<MediaType>	getSupportedMimes() The mimes supported by this recogniser
void	initialize(Map<String,Param> params) This is the hook for configuring the recogniser
boolean	isAvailable() Is this service available
Map<Integer,String>	loadClassIndex(InputStream stream) Loads the class to
org.nd4j.linalg.api.ndarray.INDArray	preProcessImage(org.nd4j.linalg.api.ndarray.INDArray input) Pre process image to reduce to make it feedable to inception network
List<RecognisedObject>	recognise(InputStream stream, ContentHandler handler, Metadata metadata, ParseContext context) Recognise the objects in the stream

Methods inherited from class java.lang.Object

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

Field Detail

DEF_MODEL_JSON

public static final String DEF_MODEL_JSON

See Also:

Constant Field Values

DEF_LABEL_MAPPING

public static final String DEF_LABEL_MAPPING

See Also:

Constant Field Values

Constructor Detail

DL4JInceptionV3Net

public DL4JInceptionV3Net()

Method Detail

getSupportedMimes

public Set<MediaType> getSupportedMimes()

Description copied from interface: ObjectRecogniser

The mimes supported by this recogniser

Specified by:

getSupportedMimes in interface ObjectRecogniser

Returns:

set of mediatypes

cachedDownload

public static File cachedDownload(File cacheDir,
                                  URI uri)
                           throws IOException

Throws:

IOException

initialize

public void initialize(Map<String,Param> params)
                throws TikaConfigException

Description copied from interface: ObjectRecogniser

This is the hook for configuring the recogniser

Specified by:

initialize in interface Initializable

Specified by:

initialize in interface ObjectRecogniser

Parameters:

params - configuration instance in the form of context

Throws:

TikaConfigException - when there is an issue with configuration

checkInitialization

public void checkInitialization(InitializableProblemHandler problemHandler)
                         throws TikaConfigException

Specified by:

checkInitialization in interface Initializable

Parameters:

problemHandler - if there is a problem and no custom initializableProblemHandler has been configured via Initializable parameters, this is called to respond.

Throws:

TikaConfigException

isAvailable

public boolean isAvailable()

Description copied from interface: ObjectRecogniser

Is this service available

Specified by:

isAvailable in interface ObjectRecogniser

Returns:

true when the service is available, false otherwise

preProcessImage

public org.nd4j.linalg.api.ndarray.INDArray preProcessImage(org.nd4j.linalg.api.ndarray.INDArray input)

Pre process image to reduce to make it feedable to inception network

Parameters:

input - Input image

Returns:

processed image

loadClassIndex

public Map<Integer,String> loadClassIndex(InputStream stream)
                                   throws IOException,
                                          org.json.simple.parser.ParseException

Loads the class to

Parameters:

stream - label index stream

Returns:

Map of integer -> label name

Throws:

IOException - when the stream breaks unexpectedly

org.json.simple.parser.ParseException - when the input doesn't contain a valid JSON map

recognise

public List<RecognisedObject> recognise(InputStream stream,
                                        ContentHandler handler,
                                        Metadata metadata,
                                        ParseContext context)
                                 throws IOException,
                                        SAXException,
                                        TikaException

Description copied from interface: ObjectRecogniser

Recognise the objects in the stream

Specified by:

recognise in interface ObjectRecogniser

Parameters:

stream - content stream

handler - tika's content handler

metadata - metadata instance

context - parser context

Returns:

List of RecognisedObjects

Throws:

IOException - when an I/O error occurs

SAXException - when an issue with XML occurs

TikaException - any generic error