org.bytedeco.pytorch

Class ModuleDictImpl

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.pytorch.Module

org.bytedeco.pytorch.ModuleDictImplCloneable

org.bytedeco.pytorch.ModuleDictImpl

All Implemented Interfaces:

AutoCloseable

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

An OrderedDict of Modules that registers its elements by their keys. \rst .. code-block:: cpp torch::OrderedDict> ordereddict = { {"linear", Linear(10, 3).ptr()}, {"conv", Conv2d(1, 2, 3).ptr()}, {"dropout", Dropout(0.5).ptr()}, }; torch::nn::ModuleDict dict1(ordereddict); for (const auto &module : *dict1) { module->pretty_print(std::cout); } std::vector>> list = { {"linear", Linear(10, 3).ptr()}, {"conv", Conv2d(1, 2, 3).ptr()}, {"dropout", Dropout(0.5).ptr()}, }; torch::nn::ModuleDict dict2(list); for (const auto &module : *dict2) { module->pretty_print(std::cout); } \endrst Why should you use ModuleDict instead of a simple map or OrderedDict? The value a ModuleDict provides over manually calling an ordered map of modules is that it allows treating the whole container *as a single module*, such that performing a transformation on the ModuleDict applies to each of the modules it stores (which are each a registered submodule of the ModuleDict). For example, calling .to(torch::kCUDA) on a ModuleDict will move each module in the map to CUDA memory. For example: \rst .. code-block:: cpp torch::OrderedDict> ordereddict = { {"linear", Linear(10, 3).ptr()}, {"conv", Conv2d(1, 2, 3).ptr()}, {"dropout", Dropout(0.5).ptr()}, }; torch::nn::ModuleDict dict(ordereddict); // Convert all modules to CUDA. dict->to(torch::kCUDA); \endrst Finally, ModuleDict provides a lightweight container API, such as allowing iteration over submodules, positional access, adding new modules from a vector of key-module pairs or an OrderedDict or another ModuleDict after construction via update.

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
ModuleDictImpl()
ModuleDictImpl(Module pointer) Downcast constructor.
ModuleDictImpl(Pointer p) Pointer cast constructor.
ModuleDictImpl(StringSharedModuleDict modules) Constructs the ModuleDict from an OrderedDict.
ModuleDictImpl(StringSharedModuleVector modules) Constructs the ModuleDict from a list of string-Module pairs.

Method Summary

Modifier and Type	Method and Description
StringSharedModuleDictItemVector.Iterator	begin() Return an iterator to the start of ModuleDict.
void	clear() Remove all items from the ModuleDict.
Module	clone()
Module	clone(DeviceOptional device) Special cloning function for ModuleDict because it does not use reset().
boolean	contains(BytePointer key) Check if the centain parameter with the key in the ModuleDict.
boolean	contains(String key)
boolean	empty() Return true if the ModuleDict is empty, otherwise return false.
StringSharedModuleDictItemVector.Iterator	end() Return an iterator to the end of ModuleDict.
Module	get(BytePointer key) Attempts to returns the Module associated with the given key.
Module	get(String key)
StringSharedModuleVector	items() Return the items in the ModuleDict.
StringVector	keys() Return the keys in the ModuleDict.
Module	pop(BytePointer key) Removes and returns the Module associated with the given key.
Module	pop(String key)
void	pretty_print(Pointer stream) Pretty prints the ModuleDict into the given stream.
void	reset() reset() is empty for ModuleDict, since it does not have parameters of its own.
long	size() Return the number of items currently stored in the ModuleDict.
void	update(StringSharedModuleVector modules) Updated the ModuleDict with a vector of key-module pairs.
SharedModuleVector	values() Return the values in the ModuleDict.

Methods inherited from class org.bytedeco.pytorch.ModuleDictImplCloneable

asModule, asModule

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

ModuleDictImpl

public ModuleDictImpl(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

ModuleDictImpl

public ModuleDictImpl(Module pointer)

Downcast constructor.

ModuleDictImpl

public ModuleDictImpl()

ModuleDictImpl

public ModuleDictImpl(@Const @ByRef
                      StringSharedModuleVector modules)

Constructs the ModuleDict from a list of string-Module pairs.

ModuleDictImpl

public ModuleDictImpl(@Const @ByRef
                      StringSharedModuleDict modules)

Constructs the ModuleDict from an OrderedDict.

Method Detail

items

@ByVal
public StringSharedModuleVector items()

Return the items in the ModuleDict.

keys

@ByVal
public StringVector keys()

Return the keys in the ModuleDict.

values

@ByVal
public SharedModuleVector values()

Return the values in the ModuleDict.

begin

@ByVal
 @Cast(value="torch::nn::ModuleDictImpl::Iterator*")
public StringSharedModuleDictItemVector.Iterator begin()

Return an iterator to the start of ModuleDict.

end

@ByVal
 @Cast(value="torch::nn::ModuleDictImpl::Iterator*")
public StringSharedModuleDictItemVector.Iterator end()

Return an iterator to the end of ModuleDict.

size

@Cast(value="size_t")
 @NoException(value=true)
public long size()

Return the number of items currently stored in the ModuleDict.

empty

@Cast(value="bool")
 @NoException(value=true)
public boolean empty()

Return true if the ModuleDict is empty, otherwise return false.

contains

@Cast(value="bool")
 @NoException(value=true)
public boolean contains(@StdString
                                                                      BytePointer key)

Check if the centain parameter with the key in the ModuleDict.

contains

@Cast(value="bool")
 @NoException(value=true)
public boolean contains(@StdString
                                                                      String key)

clear

public void clear()

Remove all items from the ModuleDict.

clone

@SharedPtr(value="torch::nn::Module")
 @ByVal
public Module clone(@Const @ByRef(nullValue="c10::optional<torch::Device>(c10::nullopt)")
                                                                  DeviceOptional device)

Special cloning function for ModuleDict because it does not use reset().

Overrides:

clone in class ModuleDictImplCloneable

clone

@SharedPtr(value="torch::nn::Module")
 @ByVal
public Module clone()

Overrides:

clone in class ModuleDictImplCloneable

reset

public void reset()

reset() is empty for ModuleDict, since it does not have parameters of its own.

Overrides:

reset in class ModuleDictImplCloneable

pretty_print

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

Pretty prints the ModuleDict into the given stream.

Overrides:

pretty_print in class Module

get

@SharedPtr(value="torch::nn::Module")
 @ByVal
 @Name(value="operator []")
public Module get(@StdString
                                                                                            BytePointer key)

Attempts to returns the Module associated with the given key. Throws an exception if no such key is stored in the ModuleDict. Check contains(key) before for a non-throwing way of access.

get

@SharedPtr(value="torch::nn::Module")
 @ByVal
 @Name(value="operator []")
public Module get(@StdString
                                                                                            String key)

pop

@SharedPtr(value="torch::nn::Module")
 @ByVal
public Module pop(@StdString
                                                                BytePointer key)

Removes and returns the Module associated with the given key. Throws an exception if no such key is stored in the ModuleDict. Check contains(key) before for a non-throwing way of access.

pop

@SharedPtr(value="torch::nn::Module")
 @ByVal
public Module pop(@StdString
                                                                String key)

update

public void update(@Const @ByRef
                   StringSharedModuleVector modules)

Updated the ModuleDict with a vector of key-module pairs.