org.bytedeco.pytorch

Class EmbeddingBagImpl

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.pytorch.Module

org.bytedeco.pytorch.EmbeddingBagImplCloneable

org.bytedeco.pytorch.EmbeddingBagImpl

All Implemented Interfaces:

AutoCloseable

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

Computes sums or means of 'bags' of embeddings, without instantiating the intermediate embeddings. See https://pytorch.org/docs/master/nn.html#torch.nn.EmbeddingBag to learn about the exact behavior of this module. See the documentation for torch::nn::EmbeddingBagOptions class to learn what constructor arguments are supported for this module. Example:

  EmbeddingBag model(EmbeddingBagOptions(10,
  2).max_norm(2).norm_type(2.5).scale_grad_by_freq(true).sparse(true).mode(torch::kSum).padding_idx(1));
  

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
EmbeddingBagImpl(EmbeddingBagOptions options_)
EmbeddingBagImpl(long num_embeddings, long embedding_dim)
EmbeddingBagImpl(Module pointer) Downcast constructor.
EmbeddingBagImpl(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Tensor	forward(Tensor input)
Tensor	forward(Tensor input, Tensor offsets, Tensor per_sample_weights)
EmbeddingBagOptions	options() The Options used to configure this EmbeddingBag module.
EmbeddingBagImpl	options(EmbeddingBagOptions setter)
void	pretty_print(Pointer stream) Pretty prints the EmbeddingBag module into the given stream.
void	reset_parameters()
void	reset() reset() must perform initialization of all members with reference semantics, most importantly parameters, buffers and submodules.
Tensor	weight() The embedding table.
EmbeddingBagImpl	weight(Tensor setter)

Methods inherited from class org.bytedeco.pytorch.EmbeddingBagImplCloneable

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, 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

EmbeddingBagImpl

public EmbeddingBagImpl(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

EmbeddingBagImpl

public EmbeddingBagImpl(Module pointer)

Downcast constructor.

EmbeddingBagImpl

public EmbeddingBagImpl(@Cast(value="int64_t")
                        long num_embeddings,
                        @Cast(value="int64_t")
                        long embedding_dim)

EmbeddingBagImpl

public EmbeddingBagImpl(@ByVal
                        EmbeddingBagOptions options_)

Method Detail

reset

public void reset()

Description copied from class: EmbeddingBagImplCloneable

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

Overrides:

reset in class EmbeddingBagImplCloneable

reset_parameters

public void reset_parameters()

pretty_print

public void pretty_print(@Cast(value="std::ostream*") @ByRef
                         Pointer stream)

Pretty prints the EmbeddingBag module into the given stream.

Overrides:

pretty_print in class Module

options

@ByRef
public EmbeddingBagOptions options()

The Options used to configure this EmbeddingBag module.

options

public EmbeddingBagImpl options(EmbeddingBagOptions setter)

weight

@ByRef
public Tensor weight()

The embedding table.

weight

public EmbeddingBagImpl weight(Tensor setter)

forward

@ByVal
public Tensor forward(@Const @ByRef
                             Tensor input,
                             @Const @ByRef(nullValue="torch::Tensor{}")
                             Tensor offsets,
                             @Const @ByRef(nullValue="torch::Tensor{}")
                             Tensor per_sample_weights)

forward

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