org.bytedeco.pytorch

Class TransformerEncoderImpl

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.pytorch.Module

org.bytedeco.pytorch.TransformerEncoderImplCloneable

org.bytedeco.pytorch.TransformerEncoderImpl

All Implemented Interfaces:

AutoCloseable

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

TransformerEncoder module. See https://pytorch.org/docs/master/generated/torch.nn.TransformerEncoder.html to learn abouut the exact behavior of this encoder layer module. See the documentation for torch::nn::TransformerEncoder class to learn what constructor arguments are supported for this encoder module. Example:

  TransformerEncoderLayer encoderLayer(TransformerEncoderLayerOptions(512,
  8).dropout(0.1)); TransformerEncoder
  encoder(TransformerEncoderOptions(encoderLayer,
  6).norm(LayerNorm(LayerNormOptions({2}))));
  

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
TransformerEncoderImpl(Module pointer) Downcast constructor.
TransformerEncoderImpl(Pointer p) Pointer cast constructor.
TransformerEncoderImpl(TransformerEncoderOptions options_)

Method Summary

Modifier and Type	Method and Description
Tensor	forward(Tensor src)
Tensor	forward(Tensor src, Tensor src_mask, Tensor src_key_padding_mask)
AnyModule	norm() optional normalization module
TransformerEncoderImpl	norm(AnyModule setter)
TransformerEncoderOptions	options() options with which this TransformerEncoder was constructed
TransformerEncoderImpl	options(TransformerEncoderOptions 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.TransformerEncoderImplCloneable

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

TransformerEncoderImpl

public TransformerEncoderImpl(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

TransformerEncoderImpl

public TransformerEncoderImpl(Module pointer)

Downcast constructor.

TransformerEncoderImpl

public TransformerEncoderImpl(@ByVal
                              TransformerEncoderOptions options_)

Method Detail

forward

@ByVal
public Tensor forward(@Const @ByRef
                             Tensor src,
                             @Const @ByRef(nullValue="torch::Tensor{}")
                             Tensor src_mask,
                             @Const @ByRef(nullValue="torch::Tensor{}")
                             Tensor src_key_padding_mask)

forward

@ByVal
public Tensor forward(@Const @ByRef
                             Tensor src)

reset

public void reset()

Description copied from class: TransformerEncoderImplCloneable

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

Overrides:

reset in class TransformerEncoderImplCloneable

reset_parameters

public void reset_parameters()

options

@ByRef
public TransformerEncoderOptions options()

options with which this TransformerEncoder was constructed

options

public TransformerEncoderImpl options(TransformerEncoderOptions setter)

norm

@ByRef
public AnyModule norm()

optional normalization module

norm

public TransformerEncoderImpl norm(AnyModule setter)