org.nd4j.imports.graphmapper.onnx

Class OnnxGraphMapper

java.lang.Object

org.nd4j.imports.graphmapper.BaseGraphMapper<Onnx.GraphProto,Onnx.NodeProto,Onnx.AttributeProto,Onnx.TypeProto.Tensor>

org.nd4j.imports.graphmapper.onnx.OnnxGraphMapper

All Implemented Interfaces:

GraphMapper<Onnx.GraphProto,Onnx.NodeProto,Onnx.AttributeProto,Onnx.TypeProto.Tensor>

public class OnnxGraphMapper
extends BaseGraphMapper<Onnx.GraphProto,Onnx.NodeProto,Onnx.AttributeProto,Onnx.TypeProto.Tensor>

A mapper for onnx graphs to SameDiff instances.

Author:

Adam Gibson

Constructor Summary

Constructors

Constructor and Description
OnnxGraphMapper()

Method Summary

Modifier and Type	Method and Description
protected void	addDummyTensor(String name, Map<String,Onnx.TypeProto.Tensor> to)
boolean	alreadySeen(Onnx.NodeProto nodeProto)
DataType	dataTypeForTensor(Onnx.TypeProto.Tensor tensorProto, int outputNum)
void	dumpBinaryProtoAsText(File inputFile, File outputFile) Dump a binary proto file representation as a plain string in to the target text file
void	dumpBinaryProtoAsText(InputStream inputFile, File outputFile) Dump a binary proto file representation as a plain string in to the target text file
INDArray	getArrayFrom(Onnx.NodeProto nodeProto, Onnx.GraphProto graph)
Map<String,Onnx.AttributeProto>	getAttrMap(Onnx.NodeProto nodeProto) Get the attribute map for given node
String	getAttrValueFromNode(Onnx.NodeProto nodeProto, String key)
List<String>	getControlDependencies(Onnx.NodeProto node) Get the list of control dependencies for the current node (or null if none exist)
String	getInputFromNode(Onnx.NodeProto node, int index) Get the input node for the given node
static OnnxGraphMapper	getInstance()
DifferentialFunction	getMappedOp(String name) Get the mapped op name for a given op relative to the type of node being mapped.
String	getName(Onnx.NodeProto nodeProto) Get the name of the node
INDArray	getNDArrayFromTensor(String tensorName, Onnx.TypeProto.Tensor tensorProto, Onnx.GraphProto graph)
org.nd4j.shade.protobuf.Message.Builder	getNewGraphBuilder() Returns a graph builder for initial definition and parsing.
List<Onnx.NodeProto>	getNodeList(Onnx.GraphProto graphProto)
Onnx.NodeProto	getNodeWithNameFromGraph(Onnx.GraphProto graph, String name) Get the node from the graph
String	getOpType(Onnx.NodeProto nodeProto)
long[]	getShape(Onnx.NodeProto nodeProto)
long[]	getShapeFromAttr(Onnx.AttributeProto attr) Get the shape of the attribute value
long[]	getShapeFromAttribute(Onnx.AttributeProto attributeProto)
long[]	getShapeFromTensor(Onnx.TensorProto tensorProto) Get the shape from a tensor proto.
long[]	getShapeFromTensor(Onnx.TypeProto.Tensor tensorProto) Get the shape for the given tensor type
String	getTargetMappingForOp(DifferentialFunction function, Onnx.NodeProto node) Get the target mapping key (usually based on the node name) for the given function
boolean	hasShape(Onnx.NodeProto nodeProto)
void	initFunctionFromProperties(String mappedTfName, DifferentialFunction on, Map<String,Onnx.AttributeProto> attributesForNode, Onnx.NodeProto node, Onnx.GraphProto graph) Init a function's attributes
boolean	isConstant(Onnx.TypeProto.Tensor nodeType) Returns true if the given node is a constant
boolean	isOpIgnoreException(Onnx.NodeProto node) Returns true if this node is a special case (maybe because of name or other scenarios) that should override GraphMapper.opsToIgnore() in certain circumstances
boolean	isPlaceHolder(Onnx.TypeProto.Tensor nodeType) Returns true if the given node is a place holder type (think a yet to be determined shape)_
boolean	isPlaceHolderNode(Onnx.TypeProto.Tensor node) Returns true if the given node is a place holder
boolean	isStringType(Onnx.TypeProto.Tensor tensor)
boolean	isVariableNode(Onnx.NodeProto nodeProto)
void	mapNodeType(Onnx.NodeProto tfNode, ImportState<Onnx.GraphProto,Onnx.TypeProto.Tensor> importState, OpImportOverride<Onnx.GraphProto,Onnx.NodeProto,Onnx.AttributeProto> opImportOverride, OpImportFilter<Onnx.GraphProto,Onnx.NodeProto,Onnx.AttributeProto> opFilter) Map a node in to the import state covering the SameDiff instance
void	mapProperty(String name, DifferentialFunction on, Onnx.NodeProto node, Onnx.GraphProto graph, SameDiff sameDiff, Map<String,Map<String,PropertyMapping>> propertyMappingsForFunction)
INDArray	mapTensorProto(Onnx.TensorProto tensor)
DataType	nd4jTypeFromOnnxType(Onnx.TensorProto.DataType dataType) Convert an onnx type to the proper nd4j type
int	numInputsFor(Onnx.NodeProto nodeProto) Get the number of inputs for a node.
Set<String>	opsToIgnore() Ops to ignore for mapping
Onnx.GraphProto	parseGraphFrom(byte[] inputStream) Parse a graph from an input stream
Onnx.GraphProto	parseGraphFrom(InputStream inputStream) Parse a graph from an input stream
boolean	shouldSkip(Onnx.NodeProto opType)
String	translateToSameDiffName(String name, Onnx.NodeProto node)
Map<String,Onnx.TypeProto.Tensor>	variablesForGraph(Onnx.GraphProto graphProto) Get the variables for the given graph

Methods inherited from class org.nd4j.imports.graphmapper.BaseGraphMapper

importGraph, importGraph, importGraph, importGraph, importGraph, importGraph, initOutputVariables, mapProperties, nameIndexForGraph, nodesByName, opTypeForNode, readGraph, validateGraphStructure, validTensorDataType

Methods inherited from class java.lang.Object

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

Constructor Detail

OnnxGraphMapper

public OnnxGraphMapper()

Method Detail

getInstance

public static OnnxGraphMapper getInstance()

dumpBinaryProtoAsText

public void dumpBinaryProtoAsText(InputStream inputFile,
                                  File outputFile)

Description copied from interface: GraphMapper

Dump a binary proto file representation as a plain string in to the target text file

initFunctionFromProperties

public void initFunctionFromProperties(String mappedTfName,
                                       DifferentialFunction on,
                                       Map<String,Onnx.AttributeProto> attributesForNode,
                                       Onnx.NodeProto node,
                                       Onnx.GraphProto graph)

Init a function's attributes

Parameters:

mappedTfName - the onnx name to pick (sometimes ops have multiple names

on - the function to map

attributesForNode - the attributes for the node

node -

graph -

isOpIgnoreException

public boolean isOpIgnoreException(Onnx.NodeProto node)

Description copied from interface: GraphMapper

Returns true if this node is a special case (maybe because of name or other scenarios) that should override GraphMapper.opsToIgnore() in certain circumstances

Parameters:

node - the node to check

Returns:

true if this node is an exception false otherwise

getTargetMappingForOp

public String getTargetMappingForOp(DifferentialFunction function,
                                    Onnx.NodeProto node)

Description copied from interface: GraphMapper

Get the target mapping key (usually based on the node name) for the given function

Parameters:

function - the function

node - the node to derive the target mapping from

Returns:

mapProperty

public void mapProperty(String name,
                        DifferentialFunction on,
                        Onnx.NodeProto node,
                        Onnx.GraphProto graph,
                        SameDiff sameDiff,
                        Map<String,Map<String,PropertyMapping>> propertyMappingsForFunction)

getNodeWithNameFromGraph

public Onnx.NodeProto getNodeWithNameFromGraph(Onnx.GraphProto graph,
                                               String name)

Description copied from interface: GraphMapper

Get the node from the graph

Parameters:

graph - the graph to get the node from

name - the name of the node to get from the graph

Returns:

isPlaceHolderNode

public boolean isPlaceHolderNode(Onnx.TypeProto.Tensor node)

Description copied from interface: GraphMapper

Returns true if the given node is a place holder

Parameters:

node - the node to check

Returns:

true if the node is a place holder or not

getControlDependencies

public List<String> getControlDependencies(Onnx.NodeProto node)

Description copied from interface: GraphMapper

Get the list of control dependencies for the current node (or null if none exist)

Parameters:

node - Node to get the control dependencies (if any) for

Returns:

dumpBinaryProtoAsText

public void dumpBinaryProtoAsText(File inputFile,
                                  File outputFile)

Description copied from interface: GraphMapper

Dump a binary proto file representation as a plain string in to the target text file

getMappedOp

public DifferentialFunction getMappedOp(String name)

Description copied from interface: GraphMapper

Get the mapped op name for a given op relative to the type of node being mapped. The input name should be based on a tensorflow type or onnx type, not the nd4j name

Parameters:

name - the tensorflow or onnx name

Returns:

variablesForGraph

public Map<String,Onnx.TypeProto.Tensor> variablesForGraph(Onnx.GraphProto graphProto)

Description copied from interface: GraphMapper

Get the variables for the given graph

Parameters:

graphProto - the graph to get the variables for

Returns:

a map of variable name to tensor

translateToSameDiffName

public String translateToSameDiffName(String name,
                                      Onnx.NodeProto node)

Returns:

addDummyTensor

protected void addDummyTensor(String name,
                              Map<String,Onnx.TypeProto.Tensor> to)

getNewGraphBuilder

public org.nd4j.shade.protobuf.Message.Builder getNewGraphBuilder()

Description copied from interface: GraphMapper

Returns a graph builder for initial definition and parsing.

Returns:

parseGraphFrom

public Onnx.GraphProto parseGraphFrom(byte[] inputStream)
                               throws IOException

Description copied from interface: GraphMapper

Parse a graph from an input stream

Parameters:

inputStream - the input stream to load from

Returns:

Throws:

IOException

parseGraphFrom

public Onnx.GraphProto parseGraphFrom(InputStream inputStream)
                               throws IOException

Description copied from interface: GraphMapper

Parse a graph from an input stream

Parameters:

inputStream - the input stream to load from

Returns:

Throws:

IOException

mapNodeType

public void mapNodeType(Onnx.NodeProto tfNode,
                        ImportState<Onnx.GraphProto,Onnx.TypeProto.Tensor> importState,
                        OpImportOverride<Onnx.GraphProto,Onnx.NodeProto,Onnx.AttributeProto> opImportOverride,
                        OpImportFilter<Onnx.GraphProto,Onnx.NodeProto,Onnx.AttributeProto> opFilter)

Description copied from interface: GraphMapper

Map a node in to the import state covering the SameDiff instance

Parameters:

tfNode - the node to map

importState - the current import state

opFilter - Optional filter for skipping operations

dataTypeForTensor

public DataType dataTypeForTensor(Onnx.TypeProto.Tensor tensorProto,
                                  int outputNum)

Returns:

isStringType

public boolean isStringType(Onnx.TypeProto.Tensor tensor)

nd4jTypeFromOnnxType

public DataType nd4jTypeFromOnnxType(Onnx.TensorProto.DataType dataType)

Convert an onnx type to the proper nd4j type

Parameters:

dataType - the data type to convert

Returns:

the nd4j type for the onnx type

getAttrValueFromNode

public String getAttrValueFromNode(Onnx.NodeProto nodeProto,
                                   String key)

Returns:

getShapeFromAttribute

public long[] getShapeFromAttribute(Onnx.AttributeProto attributeProto)

Returns:

isPlaceHolder

public boolean isPlaceHolder(Onnx.TypeProto.Tensor nodeType)

Description copied from interface: GraphMapper

Returns true if the given node is a place holder type (think a yet to be determined shape)_

Returns:

isConstant

public boolean isConstant(Onnx.TypeProto.Tensor nodeType)

Description copied from interface: GraphMapper

Returns true if the given node is a constant

Returns:

getNDArrayFromTensor

public INDArray getNDArrayFromTensor(String tensorName,
                                     Onnx.TypeProto.Tensor tensorProto,
                                     Onnx.GraphProto graph)

Returns:

mapTensorProto

public INDArray mapTensorProto(Onnx.TensorProto tensor)

getShapeFromTensor

public long[] getShapeFromTensor(Onnx.TypeProto.Tensor tensorProto)

Description copied from interface: GraphMapper

Get the shape for the given tensor type

Returns:

getShapeFromTensor

public long[] getShapeFromTensor(Onnx.TensorProto tensorProto)

Get the shape from a tensor proto. Note that this is different from getShapeFromTensor(Onnx.TensorProto)

Parameters:

tensorProto - the tensor to get the shape from

Returns:

opsToIgnore

public Set<String> opsToIgnore()

Description copied from interface: GraphMapper

Ops to ignore for mapping

Returns:

getInputFromNode

public String getInputFromNode(Onnx.NodeProto node,
                               int index)

Description copied from interface: GraphMapper

Get the input node for the given node

Parameters:

node - the node

index - hte index

Returns:

numInputsFor

public int numInputsFor(Onnx.NodeProto nodeProto)

Description copied from interface: GraphMapper

Get the number of inputs for a node.

Parameters:

nodeProto - the node to get the number of inputs for

Returns:

getShapeFromAttr

public long[] getShapeFromAttr(Onnx.AttributeProto attr)

Description copied from interface: GraphMapper

Get the shape of the attribute value

Parameters:

attr - the attribute value

Returns:

the shape of the attribute if any or null

getAttrMap

public Map<String,Onnx.AttributeProto> getAttrMap(Onnx.NodeProto nodeProto)

Description copied from interface: GraphMapper

Get the attribute map for given node

Parameters:

nodeProto - the node

Returns:

the attribute map for the attribute

getName

public String getName(Onnx.NodeProto nodeProto)

Description copied from interface: GraphMapper

Get the name of the node

Parameters:

nodeProto - the node to get the name for

Returns:

alreadySeen

public boolean alreadySeen(Onnx.NodeProto nodeProto)

Returns:

isVariableNode

public boolean isVariableNode(Onnx.NodeProto nodeProto)

Returns:

shouldSkip

public boolean shouldSkip(Onnx.NodeProto opType)

Returns:

hasShape

public boolean hasShape(Onnx.NodeProto nodeProto)

Returns:

getShape

public long[] getShape(Onnx.NodeProto nodeProto)

Returns:

getArrayFrom

public INDArray getArrayFrom(Onnx.NodeProto nodeProto,
                             Onnx.GraphProto graph)

Returns:

getOpType

public String getOpType(Onnx.NodeProto nodeProto)

getNodeList

public List<Onnx.NodeProto> getNodeList(Onnx.GraphProto graphProto)

Returns: