ai.djl.modality.Input Maven / Gradle / Ivy
/*
* Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance
* with the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0/
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
* OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package ai.djl.modality;
import ai.djl.ndarray.BytesSupplier;
import ai.djl.ndarray.NDArray;
import ai.djl.ndarray.NDList;
import ai.djl.ndarray.NDManager;
import ai.djl.util.Pair;
import ai.djl.util.PairList;
import java.io.ByteArrayOutputStream;
import java.io.DataInputStream;
import java.io.DataOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.nio.ByteBuffer;
import java.nio.charset.StandardCharsets;
import java.util.Map;
import java.util.Map.Entry;
import java.util.TreeMap;
/** A class stores the generic input data for inference. */
public class Input {
private static final long serialVersionUID = 1L;
protected Map properties;
protected PairList content;
/** Constructs a new {@code Input} instance. */
public Input() {
properties = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
content = new PairList<>();
}
/**
* Returns the properties of the input.
*
* @return the properties of the input
*/
public Map getProperties() {
return properties;
}
/**
* Sets the properties of the input.
*
* @param properties the properties of the input
*/
public void setProperties(Map properties) {
this.properties = properties;
}
/**
* Adds a property to the input.
*
* @param key key with which the specified value is to be added
* @param value value to be added with the specified key
*/
public void addProperty(String key, String value) {
properties.put(key, value);
}
/**
* Returns the value to which the specified key is mapped.
*
* @param key the key whose associated value is to be returned
* @param defaultValue the default mapping of the key
* @return the value to which the specified key is mapped
*/
public String getProperty(String key, String defaultValue) {
return properties.getOrDefault(key, defaultValue);
}
/**
* Returns the content of the input.
*
* A {@code Input} may contains multiple data.
*
* @return the content of the input
*/
public PairList getContent() {
return content;
}
/**
* Returns the content of the input as {@link ByteBuffer}s.
*
* A {@code Input} may contains multiple data.
*
* @return the content of the input as {@link ByteBuffer}s.
*/
public PairList getContentAsBuffers() {
PairList result = new PairList<>(content.size());
for (Pair c : content) {
result.add(c.getKey(), c.getValue().toByteBuffer());
}
return result;
}
/**
* Sets the content of the input.
*
* @param content the content of the input
*/
public void setContent(PairList content) {
this.content = content;
}
/**
* Appends an item at the end of the input.
*
* @param data data to be added
*/
public void add(byte[] data) {
add(BytesSupplier.wrap(data));
}
/**
* Appends an item at the end of the input.
*
* @param data data to be added
*/
public void add(String data) {
add(BytesSupplier.wrap(data.getBytes(StandardCharsets.UTF_8)));
}
/**
* Appends an item at the end of the input.
*
* @param data data to be added
*/
public void add(BytesSupplier data) {
add(null, data);
}
/**
* Adds a key/value pair to the input content.
*
* @param key key with which the specified data is to be added
* @param data data to be added with the specified key
*/
public void add(String key, byte[] data) {
add(key, BytesSupplier.wrap(data));
}
/**
* Adds a key/value pair to the input content.
*
* @param key key with which the specified data is to be added
* @param data data to be added with the specified key
*/
public void add(String key, String data) {
add(key, BytesSupplier.wrap(data));
}
/**
* Adds a key/value pair to the input content.
*
* @param key key with which the specified data is to be added
* @param data data to be added with the specified key
*/
public void add(String key, BytesSupplier data) {
content.add(key, data);
}
/**
* Inserts the specified element at the specified position in the input.
*
* @param index the index at which the specified element is to be inserted
* @param key key with which the specified data is to be added
* @param data data to be added with the specified key
*/
public void add(int index, String key, BytesSupplier data) {
content.add(index, key, data);
}
/**
* Returns the default data item.
*
* @return the default data item
*/
public BytesSupplier getData() {
if (content.isEmpty()) {
return null;
}
BytesSupplier data = get("data");
if (data == null) {
return get(0);
}
return data;
}
/**
* Returns the default data as {@code NDList}.
*
* @param manager {@link NDManager} used to create this {@code NDArray}
* @return the default data as {@code NDList}
*/
public NDList getDataAsNDList(NDManager manager) {
if (content.isEmpty()) {
return null; // NOPMD
}
int index = content.indexOf("data");
if (index < 0) {
index = 0;
}
return getAsNDList(manager, index);
}
/**
* Returns the element for the first key found in the {@code Input}.
*
* @param key the key of the element to get
* @return the element for the first key found in the {@code Input}
*/
public BytesSupplier get(String key) {
return content.get(key);
}
/**
* Returns the element at the specified position in the {@code Input}.
*
* @param index the index of the element to return
* @return the element at the specified position in the {@code Input}
*/
public BytesSupplier get(int index) {
return content.valueAt(index);
}
/**
* Returns the value as {@code byte[]} for the first key found in the {@code Input}.
*
* @param key the key of the element to get
* @return the value as {@code byte[]} for the first key found in the {@code Input}
*/
public byte[] getAsBytes(String key) {
BytesSupplier data = content.get(key);
if (data == null) {
return null; // NOPMD
}
return data.getAsBytes();
}
/**
* Returns the value as {@code byte[]} at the specified position in the {@code Input}.
*
* @param index the index of the element to return
* @return the value as {@code byte[]} at the specified position in the {@code Input}
*/
public byte[] getAsBytes(int index) {
return content.valueAt(index).getAsBytes();
}
/**
* Returns the value as {@code byte[]} for the first key found in the {@code Input}.
*
* @param key the key of the element to get
* @return the value as {@code byte[]} for the first key found in the {@code Input}
*/
public String getAsString(String key) {
BytesSupplier data = content.get(key);
if (data == null) {
return null;
}
return data.getAsString();
}
/**
* Returns the value as {@code byte[]} at the specified position in the {@code Input}.
*
* @param index the index of the element to return
* @return the value as {@code byte[]} at the specified position in the {@code Input}
*/
public String getAsString(int index) {
return content.valueAt(index).getAsString();
}
/**
* Returns the value as {@code NDArray} for the first key found in the {@code Input}.
*
* @param manager {@link NDManager} used to create this {@code NDArray}
* @param key the key of the element to get
* @return the value as {@code NDArray} for the first key found in the {@code Input}
*/
public NDArray getAsNDArray(NDManager manager, String key) {
int index = content.indexOf(key);
if (index < 0) {
return null;
}
return getAsNDArray(manager, index);
}
/**
* Returns the value as {@code NDArray} at the specified position in the {@code Input}.
*
* @param manager {@link NDManager} used to create this {@code NDArray}
* @param index the index of the element to return
* @return the value as {@code NDArray} at the specified position in the {@code Input}
*/
public NDArray getAsNDArray(NDManager manager, int index) {
BytesSupplier data = content.valueAt(index);
if (data instanceof NDArray) {
return (NDArray) data;
}
return NDArray.decode(manager, data.getAsBytes());
}
/**
* Returns the value as {@code NDList} for the first key found in the {@code Input}.
*
* @param manager {@link NDManager} used to create this {@code NDArray}
* @param key the key of the element to get
* @return the value as {@code NDList} for the first key found in the {@code Input}
*/
public NDList getAsNDList(NDManager manager, String key) {
int index = content.indexOf(key);
if (index < 0) {
return null; // NOPMD
}
return getAsNDList(manager, index);
}
/**
* Returns the value as {@code NDList} at the specified position in the {@code Input}.
*
* @param manager {@link NDManager} used to create this {@code NDArray}
* @param index the index of the element to return
* @return the value as {@code NDList} at the specified position in the {@code Input}
*/
public NDList getAsNDList(NDManager manager, int index) {
BytesSupplier data = content.valueAt(index);
if (data instanceof NDList) {
return (NDList) data;
} else if (data instanceof NDArray) {
return new NDList((NDArray) data);
}
return NDList.decode(manager, data.getAsBytes());
}
/**
* Encodes all data in the input to a binary form.
*
* @return the binary encoding
* @throws IOException if it fails to encode part of the data
*/
public byte[] encode() throws IOException {
try (ByteArrayOutputStream baos = new ByteArrayOutputStream()) {
DataOutputStream os = new DataOutputStream(baos);
os.writeLong(serialVersionUID);
encodeInputBase(os);
return baos.toByteArray();
}
}
protected void encodeInputBase(DataOutputStream os) throws IOException {
os.writeInt(properties.size());
for (Entry property : properties.entrySet()) {
os.writeUTF(property.getKey());
os.writeUTF(property.getValue());
}
os.writeInt(content.size());
for (Pair c : content) {
if (c.getKey() != null) {
os.writeBoolean(true);
os.writeUTF(c.getKey());
} else {
os.writeBoolean(false);
}
byte[] cVal = c.getValue().getAsBytes();
os.writeInt(cVal.length);
os.write(cVal);
}
}
/**
* Decodes the input from {@link #encode()}.
*
* @param is the data to decode from
* @return the decoded input
* @throws IOException if it fails to decode part of the input
*/
public static Input decode(InputStream is) throws IOException {
try (DataInputStream dis = new DataInputStream(is)) {
if (serialVersionUID != dis.readLong()) {
throw new IllegalArgumentException("Invalid Input version");
}
Input input = new Input();
decodeInputBase(dis, input);
return input;
}
}
protected static void decodeInputBase(DataInputStream dis, Input input) throws IOException {
int numProperties = dis.readInt();
for (int i = 0; i < numProperties; i++) {
String key = dis.readUTF();
String val = dis.readUTF();
input.addProperty(key, val);
}
int numContent = dis.readInt();
for (int i = 0; i < numContent; i++) {
boolean hasKey = dis.readBoolean();
String key = null;
if (hasKey) {
key = dis.readUTF();
}
int contentLength = dis.readInt();
byte[] contents = new byte[contentLength];
int contentRead = 0;
while (contentRead < contentLength) {
int newRead = dis.read(contents, contentRead, contentLength);
if (newRead < 0) {
throw new IOException("Failed to read Input or Output content");
}
contentRead += newRead;
}
input.add(key, contents);
}
}
/**
* Checks for deep equality with another input.
*
* @param o the other input.
* @return whether they and all properties, content, and data are equal
*/
public boolean deepEquals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Input input = (Input) o;
return properties.equals(input.properties)
&& getContentAsBuffers().equals(input.getContentAsBuffers());
}
/** {@inheritDoc} * */
@Override
public String toString() {
StringBuilder sb = new StringBuilder(1000);
sb.append("Input:\n");
for (Entry property : properties.entrySet()) {
sb.append("Property ")
.append(property.getKey())
.append(": ")
.append(property.getValue())
.append('\n');
}
for (Pair c : content) {
sb.append("Content ")
.append(c.getKey())
.append(": ")
.append(c.getValue().toString())
.append('\n');
}
sb.append('\n');
return sb.toString();
}
}