Skip to content

Expose input and output types from Signature #182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 4, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,11 @@
*/
package org.tensorflow;

import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import org.tensorflow.ndarray.Shape;
import org.tensorflow.proto.framework.DataType;
import org.tensorflow.proto.framework.SignatureDef;
import org.tensorflow.proto.framework.TensorInfo;
import org.tensorflow.proto.framework.TensorShapeProto;
Expand All @@ -32,6 +34,16 @@ public class Signature {
/** The default signature key, when not provided */
public static final String DEFAULT_KEY = "serving_default";

public static class TensorDescription {
public final DataType dataType;
public final Shape shape;

public TensorDescription(DataType dataType, Shape shape) {
this.dataType = dataType;
this.shape = shape;
}
}

/**
* Builds a new function signature.
*/
Expand Down Expand Up @@ -174,6 +186,32 @@ public String toString() {
return strBuilder.toString();
}

private Map<String, TensorDescription> buildTensorDescriptionMap(Map<String, TensorInfo> dataMapIn) {
Map<String, TensorDescription> dataTypeMap = new HashMap<>();
dataMapIn.forEach((a, b) -> {
long[] tensorDims = b.getTensorShape().getDimList().stream().mapToLong(d -> d.getSize()).toArray();
Shape tensorShape = Shape.of(tensorDims);
dataTypeMap.put(a, new TensorDescription(b.getDtype(),
tensorShape));
});
return dataTypeMap;
}

/**
* Returns the names of the inputs in this signature mapped to their expected data type and shape
* @return
*/
public Map<String, TensorDescription> getInputs() {
return buildTensorDescriptionMap(signatureDef.getInputsMap());
}

/**
* Returns the names of the outputs in this signature mapped to their expected data type and shape
*/
public Map<String, TensorDescription> getOutputs() {
return buildTensorDescriptionMap(signatureDef.getOutputsMap());
}

Signature(String key, SignatureDef signatureDef) {
this.key = key;
this.signatureDef = signatureDef;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,14 @@
==============================================================================*/
package org.tensorflow;

import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertThrows;

import org.junit.jupiter.api.Test;
import org.tensorflow.Signature.TensorDescription;
import org.tensorflow.op.Ops;
import org.tensorflow.proto.framework.DataType;

import java.util.Map;

import static org.junit.jupiter.api.Assertions.*;

public class SignatureTest {

Expand All @@ -43,6 +46,29 @@ public void cannotDuplicateInputOutputNames() {
}
}

@Test
public void getInputsAndOutputs() {
Ops tf = Ops.create();
Signature builder = Signature.builder()
.input("x", tf.constant(10.0f))
.output("y", tf.constant(new float[][] {{10.0f, 30.0f}}))
.output("z", tf.constant(20.0f)).build();

Map<String, TensorDescription> inputs = builder.getInputs();
assertEquals(inputs.size(), 1);

Map<String, TensorDescription> outputs = builder.getOutputs();
assertEquals(outputs.size(), 2);

assertEquals(outputs.get("y").dataType, DataType.DT_FLOAT);
assertEquals(outputs.get("z").dataType, DataType.DT_FLOAT);
assertArrayEquals(outputs.get("y").shape.asArray(), new long [] {1,2});
assertArrayEquals(outputs.get("z").shape.asArray(), new long [] {});

Signature emptySignature = Signature.builder().build();
assertEquals(emptySignature.getInputs().size(), 0);
}

@Test
public void emptyMethodNameConvertedToNull() {
Signature signature = Signature.builder().key("f").build();
Expand Down