org.bytedeco.pytorch

Class TransformerDecoderImpl

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.pytorch.Module

org.bytedeco.pytorch.TransformerDecoderImplCloneable

org.bytedeco.pytorch.TransformerDecoderImpl

All Implemented Interfaces:

AutoCloseable

@Namespace(value="torch::nn")
 @NoOffset
 @Properties(inherit=torch.class)
public class TransformerDecoderImpl
extends TransformerDecoderImplCloneable

TransformerDecoder is a stack of N decoder layers. See https://pytorch.org/docs/master/generated/torch.nn.TransformerDecoder.html to learn abouut the exact behavior of this decoder module See the documentation for torch::nn::TransformerDecoderOptions class to learn what constructor arguments are supported for this decoder module Example:

  TransformerDecoderLayer decoder_layer(TransformerDecoderLayerOptions(512,
  8).dropout(0.1)); TransformerDecoder
  transformer_decoder(TransformerDecoderOptions(decoder_layer,
  6).norm(LayerNorm(LayerNormOptions({2})))); const auto memory =
  torch::rand({10, 32, 512}); const auto tgt = torch::rand({20, 32, 512});
  auto out = transformer_decoder(tgt, memory);
  

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
TransformerDecoderImpl(Module pointer) Downcast constructor.
TransformerDecoderImpl(Pointer p) Pointer cast constructor.
TransformerDecoderImpl(TransformerDecoderOptions options_)

Method Summary

Modifier and Type	Method and Description
Tensor	forward(Tensor tgt, Tensor memory)
Tensor	forward(Tensor tgt, Tensor memory, Tensor tgt_mask, Tensor memory_mask, Tensor tgt_key_padding_mask, Tensor memory_key_padding_mask) Pass the inputs (and mask) through the decoder layer in turn.
AnyModule	norm() optional layer normalization module
TransformerDecoderImpl	norm(AnyModule setter)
TransformerDecoderOptions	options() The options used to configure this module.
TransformerDecoderImpl	options(TransformerDecoderOptions setter)
void	reset_parameters()
void	reset() reset() must perform initialization of all members with reference semantics, most importantly parameters, buffers and submodules.

Methods inherited from class org.bytedeco.pytorch.TransformerDecoderImplCloneable

asModule, asModule, clone, clone

Methods inherited from class org.bytedeco.pytorch.Module

apply, apply, apply, apply, apply, apply, apply, apply, buffers, buffers, children, eval, is_serializable, is_training, load, modules, modules, name, named_buffers, named_buffers, named_children, named_modules, named_modules, named_modules, named_parameters, named_parameters, parameters, parameters, pretty_print, register_buffer, register_buffer, register_module, register_module, register_parameter, register_parameter, register_parameter, register_parameter, save, shiftLeft, to, to, to, train, unregister_module, unregister_module, zero_grad

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TransformerDecoderImpl

public TransformerDecoderImpl(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

TransformerDecoderImpl

public TransformerDecoderImpl(Module pointer)

Downcast constructor.

TransformerDecoderImpl

public TransformerDecoderImpl(@ByVal
                              TransformerDecoderOptions options_)

Method Detail

reset

public void reset()

Description copied from class: TransformerDecoderImplCloneable

reset() must perform initialization of all members with reference semantics, most importantly parameters, buffers and submodules.

Overrides:

reset in class TransformerDecoderImplCloneable

reset_parameters

public void reset_parameters()

forward

@ByVal
public Tensor forward(@Const @ByRef
                             Tensor tgt,
                             @Const @ByRef
                             Tensor memory,
                             @Const @ByRef(nullValue="torch::Tensor{}")
                             Tensor tgt_mask,
                             @Const @ByRef(nullValue="torch::Tensor{}")
                             Tensor memory_mask,
                             @Const @ByRef(nullValue="torch::Tensor{}")
                             Tensor tgt_key_padding_mask,
                             @Const @ByRef(nullValue="torch::Tensor{}")
                             Tensor memory_key_padding_mask)

Pass the inputs (and mask) through the decoder layer in turn. Args: tgt: the sequence to the decoder layer (required). memory: the sequence from the last layer of the encoder (required). tgt_mask: the mask for the tgt sequence (optional). memory_mask: the mask for the memory sequence (optional). tgt_key_padding_mask: the mask for the tgt keys per batch (optional). memory_key_padding_mask: the mask for the memory keys per batch (optional).

forward

@ByVal
public Tensor forward(@Const @ByRef
                             Tensor tgt,
                             @Const @ByRef
                             Tensor memory)

options

@ByRef
public TransformerDecoderOptions options()

The options used to configure this module.

options

public TransformerDecoderImpl options(TransformerDecoderOptions setter)

norm

@ByRef
public AnyModule norm()

optional layer normalization module

norm

public TransformerDecoderImpl norm(AnyModule setter)