org.deeplearning4j.nn.modelimport.keras

Class Hdf5Archive

java.lang.Object

org.deeplearning4j.nn.modelimport.keras.Hdf5Archive

All Implemented Interfaces:

Closeable, AutoCloseable

public class Hdf5Archive
extends Object
implements Closeable

Class for reading ND4J arrays and JSON strings from HDF5 archive files. HDF5 is really sensitive about the order its resources are deallocated in. Make sure to ALWAYS call close() explicitly or with try-with-resources, or it might decide to crash the JVM.

Author:

[email protected]

Constructor Summary

Constructors

Constructor and Description
Hdf5Archive(String archiveFilename)

Method Summary

Modifier and Type	Method and Description
void	close()
List<String>	getDataSets(String... groups) Get list of data sets from group path.
List<String>	getGroups(String... groups) Get list of groups from group path.
boolean	hasAttribute(String attributeName, String... groups) Check whether group path contains string attribute.
String	readAttributeAsFixedLengthString(String attributeName, int bufferSize) Read string attribute from group path.
String	readAttributeAsJson(String attributeName, String... groups) Read JSON-formatted string attribute from group path.
String	readAttributeAsString(String attributeName, String... groups) Read string attribute from group path.
org.nd4j.linalg.api.ndarray.INDArray	readDataSet(String datasetName, String... groups) Read data set as ND4J array from group path.

Methods inherited from class java.lang.Object

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

Constructor Detail

Hdf5Archive

public Hdf5Archive(String archiveFilename)

Method Detail

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

readDataSet

public org.nd4j.linalg.api.ndarray.INDArray readDataSet(String datasetName,
                                                        String... groups)
                                                 throws UnsupportedKerasConfigurationException

Read data set as ND4J array from group path.

Parameters:

datasetName - Name of data set

groups - Array of zero or more ancestor groups from root to parent.

Returns:

INDArray of HDF5 group data

Throws:

UnsupportedKerasConfigurationException - Unsupported Keras config

readAttributeAsJson

public String readAttributeAsJson(String attributeName,
                                  String... groups)
                           throws UnsupportedKerasConfigurationException

Read JSON-formatted string attribute from group path.

Parameters:

attributeName - Name of attribute

groups - Array of zero or more ancestor groups from root to parent.

Returns:

HDF5 attribute as JSON

Throws:

UnsupportedKerasConfigurationException - Unsupported Keras config

readAttributeAsString

public String readAttributeAsString(String attributeName,
                                    String... groups)
                             throws UnsupportedKerasConfigurationException

Read string attribute from group path.

Parameters:

attributeName - Name of attribute

groups - Array of zero or more ancestor groups from root to parent.

Returns:

HDF5 attribute as String

Throws:

UnsupportedKerasConfigurationException - Unsupported Keras config

hasAttribute

public boolean hasAttribute(String attributeName,
                            String... groups)

Check whether group path contains string attribute.

Parameters:

attributeName - Name of attribute

groups - Array of zero or more ancestor groups from root to parent.

Returns:

Boolean indicating whether attribute exists in group path.

getDataSets

public List<String> getDataSets(String... groups)

Get list of data sets from group path.

Parameters:

groups - Array of zero or more ancestor groups from root to parent.

Returns:

List of HDF5 data set names

getGroups

public List<String> getGroups(String... groups)

Get list of groups from group path.

Parameters:

groups - Array of zero or more ancestor groups from root to parent.

Returns:

List of HDF5 groups

readAttributeAsFixedLengthString

public String readAttributeAsFixedLengthString(String attributeName,
                                               int bufferSize)
                                        throws UnsupportedKerasConfigurationException

Read string attribute from group path.

Parameters:

attributeName - Name of attribute

bufferSize - buffer size to read

Returns:

Fixed-length string read from HDF5 attribute name

Throws:

UnsupportedKerasConfigurationException - Unsupported Keras config