org.bytedeco.pytorch

Class ParameterDictImpl

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.pytorch.Module

org.bytedeco.pytorch.ParameterDictImplCloneable

org.bytedeco.pytorch.ParameterDictImpl

All Implemented Interfaces:

AutoCloseable

@Namespace(value="torch::nn")
 @Properties(inherit=torch.class)
public class ParameterDictImpl
extends ParameterDictImplCloneable

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
ParameterDictImpl()
ParameterDictImpl(Module pointer) Downcast constructor.
ParameterDictImpl(Pointer p) Pointer cast constructor.
ParameterDictImpl(StringTensorDict params)

Method Summary

Modifier and Type	Method and Description
StringTensorDictItemVector.Iterator	begin() Return an iterator to the start of ParameterDict
void	clear() Remove all parameters in the ParameterDict
boolean	contains(BytePointer key) Check if the centain parameter with the key in the ParameterDict
boolean	contains(String key)
boolean	empty() Return true if the ParameterDict is empty, otherwise return false
StringTensorDictItemVector.Iterator	end() Return an iterator to the end of ParameterDict
Tensor	get(BytePointer key) Returns the value associated with the given key.
Tensor	get(String key)
Tensor	insert(BytePointer key, Tensor param) Insert the parameter along with the key into ParameterDict The parameter is set to be require grad by default
Tensor	insert(String key, Tensor param)
StringVector	keys() Return the keys in the dict
Tensor	pop(BytePointer key) Remove key from the ParameterDict and return its value, throw exception if the key is not contained.
Tensor	pop(String key)
void	pretty_print(Pointer stream) Pretty prints the ParameterDict module into the given stream.
void	reset() reset() is empty for ParameterDict, since it does not have parameters of its own.
long	size() Return the number of items currently stored in the ParameterDict
TensorVector	values() Return the Values in the dict

Methods inherited from class org.bytedeco.pytorch.ParameterDictImplCloneable

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

ParameterDictImpl

public ParameterDictImpl(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

ParameterDictImpl

public ParameterDictImpl(Module pointer)

Downcast constructor.

ParameterDictImpl

public ParameterDictImpl()

ParameterDictImpl

public ParameterDictImpl(@Const @ByRef
                         StringTensorDict params)

Method Detail

reset

public void reset()

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

Overrides:

reset in class ParameterDictImplCloneable

pretty_print

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

Pretty prints the ParameterDict module into the given stream.

Overrides:

pretty_print in class Module

insert

@ByRef
public Tensor insert(@StdString
                            BytePointer key,
                            @ByVal
                            Tensor param)

Insert the parameter along with the key into ParameterDict The parameter is set to be require grad by default

insert

@ByRef
public Tensor insert(@StdString
                            String key,
                            @ByVal
                            Tensor param)

pop

@ByVal
public Tensor pop(@StdString
                         BytePointer key)

Remove key from the ParameterDict and return its value, throw exception if the key is not contained. Please check contains(key) before for a non-throwing access.

pop

@ByVal
public Tensor pop(@StdString
                         String key)

keys

@ByVal
public StringVector keys()

Return the keys in the dict

values

@Cast(value={"","std::vector<torch::Tensor>"})
 @StdMove
public TensorVector values()

Return the Values in the dict

begin

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

Return an iterator to the start of ParameterDict

end

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

Return an iterator to the end of ParameterDict

size

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

Return the number of items currently stored in the ParameterDict

empty

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

Return true if the ParameterDict is empty, otherwise return false

clear

public void clear()

Remove all parameters in the ParameterDict

contains

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

Check if the centain parameter with the key in the ParameterDict

contains

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

get

@ByRef
public Tensor get(@StdString
                         BytePointer key)

Returns the value associated with the given key. Throws an exception if no such key is stored in the ParameterDict. Check contains(key) before for a non-throwing way of access

get

@ByRef
public Tensor get(@StdString
                         String key)