ai.djl.modality.nlp.Encoder Maven / Gradle / Ivy
/*
* Copyright 2019 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.nlp;
import ai.djl.MalformedModelException;
import ai.djl.ndarray.NDList;
import ai.djl.ndarray.NDManager;
import ai.djl.ndarray.types.DataType;
import ai.djl.ndarray.types.Shape;
import ai.djl.nn.AbstractBlock;
import ai.djl.nn.Block;
import ai.djl.training.ParameterStore;
import ai.djl.util.PairList;
import java.io.DataInputStream;
import java.io.DataOutputStream;
import java.io.IOException;
/**
* {@code Encoder} is an abstract block that be can used as encoder in encoder-decoder architecture.
* This abstraction, along with {@link Decoder}, comes into play in the {@link EncoderDecoder}
* class, and facilitate implementing encoder-decoder models for different tasks and inputs.
*/
public abstract class Encoder extends AbstractBlock {
protected Block block;
/**
* Constructs a new instance of {@code Encoder} with the given block.
*
* @param version the version to use for parameter and metadata serialization
* @param block the encoder block
*/
public Encoder(byte version, Block block) {
super(version);
this.block = addChildBlock("Block", block);
}
/**
* Gets the state of the encoder from the given encoder output.
*
* @param encoderOutput an {@link NDList} that contains the encoder output
* @return the state of the encoder
*/
public abstract NDList getStates(NDList encoderOutput);
/** {@inheritDoc} */
@Override
protected NDList forwardInternal(
ParameterStore parameterStore,
NDList inputs,
boolean training,
PairList params) {
return block.forward(parameterStore, inputs, training, params);
}
@Override
protected NDList forwardInternal(
ParameterStore parameterStore,
NDList data,
NDList labels,
PairList params) {
return super.forwardInternal(parameterStore, data, labels, params);
}
/** {@inheritDoc} */
@Override
public void initializeChildBlocks(NDManager manager, DataType dataType, Shape... inputShapes) {
block.initialize(manager, dataType, inputShapes);
}
/** {@inheritDoc} */
@Override
public Shape[] getOutputShapes(Shape[] inputShapes) {
return block.getOutputShapes(inputShapes);
}
/** {@inheritDoc} */
@Override
public void saveParameters(DataOutputStream os) throws IOException {
block.saveParameters(os);
}
/** {@inheritDoc} */
@Override
public void loadParameters(NDManager manager, DataInputStream is)
throws IOException, MalformedModelException {
block.loadParameters(manager, is);
}
}