DefaultTensorFlowService (ImageJ2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.AbstractContextual
- - org.scijava.plugin.AbstractRichPlugin
  - - org.scijava.service.AbstractService
    - - net.imagej.tensorflow.DefaultTensorFlowService

All Implemented Interfaces:

Comparable<Prioritized>, ImageJService, TensorFlowService, Contextual, Disposable, Identifiable, Initializable, Locatable, Logged, HasPluginInfo, RichPlugin, SciJavaPlugin, Prioritized, Service, Versioned
```
public class DefaultTensorFlowService
extends AbstractService
implements TensorFlowService
```
Default implementation of TensorFlowService.

Author:

Curtis Rueden

Constructor Summary

Constructors
Constructor and Description

DefaultTensorFlowService()

Constructors
Constructor and Description
`DefaultTensorFlowService()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`dispose()`
`TensorFlowLibraryStatus`	`getStatus()`
`TensorFlowVersion`	`getTensorFlowVersion()`
`CachedModelBundle`	`loadCachedModel(Location source, String modelName, String... tags)` Extracts a persisted model from the given location.
`File`	`loadFile(Location source, String modelName, String filePath)` Extracts a file from the given location.
`org.tensorflow.Graph`	`loadGraph(Location source, String modelName, String graphPath)` Extracts a graph from the given location.
`List<String>`	`loadLabels(Location source, String modelName, String labelsPath)` Extracts labels from the given location.
`void`	`loadLibrary()` Loads the TensorFlow library.
`org.tensorflow.SavedModelBundle`	`loadModel(Location source, String modelName, String... tags)` Deprecated.

Methods inherited from class org.scijava.service.AbstractService
getContext, setContext, toString

Methods inherited from class org.scijava.plugin.AbstractRichPlugin
getInfo, getPriority, setInfo, setPriority

Methods inherited from class org.scijava.AbstractContextual
context

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.scijava.service.Service
initialize, registerEventHandlers

Methods inherited from interface org.scijava.plugin.RichPlugin
getIdentifier, log

Methods inherited from interface org.scijava.Contextual
context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized
compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.HasPluginInfo
getInfo, setInfo

Methods inherited from interface org.scijava.Locatable
getLocation

Methods inherited from interface org.scijava.Versioned
getVersion

- Constructor Detail
  - DefaultTensorFlowService
```
public DefaultTensorFlowService()
```
- Method Detail
  - loadModel
```
@Deprecated
public org.tensorflow.SavedModelBundle loadModel(Location source,
                                                             String modelName,
                                                             String... tags)
                                                      throws IOException
```
    Deprecated.
    
    Description copied from interface: TensorFlowService
    
    Extracts a persisted model from the given location.
    
    Specified by:
    
    loadModel in interface TensorFlowService
    
    Parameters:
    
    source - The location of the model, which must be structured as a ZIP archive.
    
    modelName - The name of the model by which the source should be unpacked and cached as needed.
    
    tags - Optional list of tags passed to SavedModelBundle.load(String, String...).
    
    Returns:
    
    The extracted TensorFlow SavedModelBundle object.
    
    Throws:
    
    IOException - If something goes wrong reading or unpacking the archive. Deprecated - use TensorFlowService.loadCachedModel(Location, String, String...) instead.
  - loadCachedModel
```
public CachedModelBundle loadCachedModel(Location source,
                                         String modelName,
                                         String... tags)
                                  throws IOException
```
    Description copied from interface: TensorFlowService
    
    Extracts a persisted model from the given location. Returns it from cache in case it was already loaded.
    
    Specified by:
    
    loadCachedModel in interface TensorFlowService
    
    Parameters:
    
    source - The location of the model, which must be structured as a ZIP archive.
    
    modelName - The name of the model by which the source should be unpacked and cached as needed.
    
    tags - Optional list of tags passed to SavedModelBundle.load(String, String...).
    
    Returns:
    
    The extracted TensorFlow SavedModelBundle object wrapped by a CachedModelBundle.
    
    Throws:
    
    IOException - If something goes wrong reading or unpacking the archive.
  - loadGraph
```
public org.tensorflow.Graph loadGraph(Location source,
                                      String modelName,
                                      String graphPath)
                               throws IOException
```
    Description copied from interface: TensorFlowService
    
    Extracts a graph from the given location.
    
    Specified by:
    
    loadGraph in interface TensorFlowService
    
    Parameters:
    
    source - The location of the graph, which must be structured as a ZIP archive.
    
    modelName - The name of the model by which the source should be unpacked and cached as needed.
    
    graphPath - The name of the .pb file inside the ZIP archive containing the graph.
    
    Returns:
    
    The extracted TensorFlow Graph object.
    
    Throws:
    
    IOException - If something goes wrong reading or unpacking the archive.
  - loadLabels
```
public List<String> loadLabels(Location source,
                               String modelName,
                               String labelsPath)
                        throws IOException
```
    Description copied from interface: TensorFlowService
    
    Extracts labels from the given location.
    
    Specified by:
    
    loadLabels in interface TensorFlowService
    
    Parameters:
    
    source - The location of the labels, which must be structured as a ZIP archive.
    
    modelName - The name of the model by which the source should be unpacked and cached as needed.
    
    labelsPath - The name of the .txt file inside the ZIP archive containing the labels.
    
    Returns:
    
    The extracted TensorFlow Graph object.
    
    Throws:
    
    IOException - If something goes wrong reading or unpacking the archive.
  - loadLibrary
```
public void loadLibrary()
```
    Loads the TensorFlow library.
    
    Specified by:
    
    loadLibrary in interface TensorFlowService
  - getTensorFlowVersion
```
public TensorFlowVersion getTensorFlowVersion()
```
    Specified by:
    
    getTensorFlowVersion in interface TensorFlowService
    
    Returns:
    
    the TensorFlow version which is currently loaded. null if no version is loaded.
  - getStatus
```
public TensorFlowLibraryStatus getStatus()
```
    Specified by:
    
    getStatus in interface TensorFlowService
    
    Returns:
    
    Status information about the TensorFlow library (e.g. whether it crashed the application)
  - loadFile
```
public File loadFile(Location source,
                     String modelName,
                     String filePath)
              throws IOException
```
    Description copied from interface: TensorFlowService
    
    Extracts a file from the given location.
    
    Specified by:
    
    loadFile in interface TensorFlowService
    
    Parameters:
    
    source - The location of the ZIP archive.
    
    modelName - The name of the model by which the source should be unpacked and cached as needed.
    
    filePath - The name of the file inside the ZIP archive.
    
    Returns:
    
    A File object.
    
    Throws:
    
    IOException - If something goes wrong reading or unpacking the archive.
  - dispose
```
public void dispose()
```
    Specified by:
    
    dispose in interface Disposable

Class DefaultTensorFlowService

Constructor Summary

Method Summary

Methods inherited from class org.scijava.service.AbstractService

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

Methods inherited from class org.scijava.AbstractContextual

Methods inherited from class java.lang.Object

Methods inherited from interface org.scijava.service.Service

Methods inherited from interface org.scijava.plugin.RichPlugin

Methods inherited from interface org.scijava.Contextual

Methods inherited from interface org.scijava.Prioritized

Methods inherited from interface org.scijava.plugin.HasPluginInfo

Methods inherited from interface org.scijava.Locatable

Methods inherited from interface org.scijava.Versioned

Constructor Detail

DefaultTensorFlowService

Method Detail

loadModel

loadCachedModel

loadGraph

loadLabels

loadLibrary

getTensorFlowVersion

getStatus

loadFile

dispose