morpheus.models.dfencoder.ae_module.AEModule
- class AEModule(verbose, encoder_layers=None, decoder_layers=None, encoder_dropout=None, decoder_dropout=None, encoder_activations=None, decoder_activations=None, activation='relu', device=None, *args, **kwargs)[source]
Bases:
torch.nn.modules.module.Module
Auto Encoder Pytorch Module.
Methods
<a href="#morpheus.models.dfencoder.ae_module.AEModule.add_module">add_module</a>
(name, module)Adds a child module to the current module.
<a href="#morpheus.models.dfencoder.ae_module.AEModule.apply">apply</a>
(fn)Applies
fn
recursively to every submodule (as returned by.children()
) as well as self.<a href="#morpheus.models.dfencoder.ae_module.AEModule.bfloat16">bfloat16</a>
()Casts all floating point parameters and buffers to
bfloat16
datatype.<a href="#morpheus.models.dfencoder.ae_module.AEModule.buffers">buffers</a>
([recurse])Returns an iterator over module buffers.
<a href="#morpheus.models.dfencoder.ae_module.AEModule.build">build</a>
(numeric_fts, binary_fts, categorical_fts)Constructs the autoencoder model.
<a href="#morpheus.models.dfencoder.ae_module.AEModule.children">children</a>
()Returns an iterator over immediate children modules.
<a href="#morpheus.models.dfencoder.ae_module.AEModule.cpu">cpu</a>
()Moves all model parameters and buffers to the CPU.
<a href="#morpheus.models.dfencoder.ae_module.AEModule.cuda">cuda</a>
([device])Moves all model parameters and buffers to the GPU.
<a href="#morpheus.models.dfencoder.ae_module.AEModule.decode">decode</a>
(x[, layers])Decodes the input using the decoder layers and computes the outputs.
<a href="#morpheus.models.dfencoder.ae_module.AEModule.double">double</a>
()Casts all floating point parameters and buffers to
double
datatype.<a href="#morpheus.models.dfencoder.ae_module.AEModule.encode">encode</a>
(x[, layers])Encodes the input using the encoder layers.
<a href="#morpheus.models.dfencoder.ae_module.AEModule.eval">eval</a>
()Sets the module in evaluation mode.
<a href="#morpheus.models.dfencoder.ae_module.AEModule.extra_repr">extra_repr</a>
()Set the extra representation of the module
<a href="#morpheus.models.dfencoder.ae_module.AEModule.float">float</a>
()Casts all floating point parameters and buffers to
float
datatype.<a href="#morpheus.models.dfencoder.ae_module.AEModule.forward">forward</a>
(input)Passes the input through the model and returns the outputs.
<a href="#morpheus.models.dfencoder.ae_module.AEModule.get_buffer">get_buffer</a>
(target)Returns the buffer given by
target
if it exists, otherwise throws an error.<a href="#morpheus.models.dfencoder.ae_module.AEModule.get_extra_state">get_extra_state</a>
()Returns any extra state to include in the module's state_dict.
<a href="#morpheus.models.dfencoder.ae_module.AEModule.get_parameter">get_parameter</a>
(target)Returns the parameter given by
target
if it exists, otherwise throws an error.<a href="#morpheus.models.dfencoder.ae_module.AEModule.get_submodule">get_submodule</a>
(target)Returns the submodule given by
target
if it exists, otherwise throws an error.<a href="#morpheus.models.dfencoder.ae_module.AEModule.half">half</a>
()Casts all floating point parameters and buffers to
half
datatype.<a href="#morpheus.models.dfencoder.ae_module.AEModule.ipu">ipu</a>
([device])Moves all model parameters and buffers to the IPU.
<a href="#morpheus.models.dfencoder.ae_module.AEModule.load_state_dict">load_state_dict</a>
(state_dict[, strict])Copies parameters and buffers from
<a href="#morpheus.models.dfencoder.ae_module.AEModule.state_dict">state_dict</a>
into this module and its descendants.<a href="#morpheus.models.dfencoder.ae_module.AEModule.modules">modules</a>
()Returns an iterator over all modules in the network.
<a href="#morpheus.models.dfencoder.ae_module.AEModule.named_buffers">named_buffers</a>
([prefix, recurse])Returns an iterator over module buffers, yielding both the name of the buffer as well as the buffer itself.
<a href="#morpheus.models.dfencoder.ae_module.AEModule.named_children">named_children</a>
()Returns an iterator over immediate children modules, yielding both the name of the module as well as the module itself.
<a href="#morpheus.models.dfencoder.ae_module.AEModule.named_modules">named_modules</a>
([memo, prefix, remove_duplicate])Returns an iterator over all modules in the network, yielding both the name of the module as well as the module itself.
<a href="#morpheus.models.dfencoder.ae_module.AEModule.named_parameters">named_parameters</a>
([prefix, recurse])Returns an iterator over module parameters, yielding both the name of the parameter as well as the parameter itself.
<a href="#morpheus.models.dfencoder.ae_module.AEModule.parameters">parameters</a>
([recurse])Returns an iterator over module parameters.
<a href="#morpheus.models.dfencoder.ae_module.AEModule.register_backward_hook">register_backward_hook</a>
(hook)Registers a backward hook on the module.
<a href="#morpheus.models.dfencoder.ae_module.AEModule.register_buffer">register_buffer</a>
(name, tensor[, persistent])Adds a buffer to the module.
<a href="#morpheus.models.dfencoder.ae_module.AEModule.register_forward_hook">register_forward_hook</a>
(hook)Registers a forward hook on the module.
<a href="#morpheus.models.dfencoder.ae_module.AEModule.register_forward_pre_hook">register_forward_pre_hook</a>
(hook)Registers a forward pre-hook on the module.
<a href="#morpheus.models.dfencoder.ae_module.AEModule.register_full_backward_hook">register_full_backward_hook</a>
(hook)Registers a backward hook on the module.
<a href="#morpheus.models.dfencoder.ae_module.AEModule.register_load_state_dict_post_hook">register_load_state_dict_post_hook</a>
(hook)Registers a post hook to be run after module's
load_state_dict
is called.<a href="#morpheus.models.dfencoder.ae_module.AEModule.register_module">register_module</a>
(name, module)Alias for
<a href="#morpheus.models.dfencoder.ae_module.AEModule.add_module">add_module()</a>
.<a href="#morpheus.models.dfencoder.ae_module.AEModule.register_parameter">register_parameter</a>
(name, param)Adds a parameter to the module.
<a href="#morpheus.models.dfencoder.ae_module.AEModule.requires_grad_">requires_grad_</a>
([requires_grad])Change if autograd should record operations on parameters in this module.
<a href="#morpheus.models.dfencoder.ae_module.AEModule.set_extra_state">set_extra_state</a>
(state)This function is called from
<a href="#morpheus.models.dfencoder.ae_module.AEModule.load_state_dict">load_state_dict()</a>
to handle any extra state found within the<a href="#morpheus.models.dfencoder.ae_module.AEModule.state_dict">state_dict</a>
.<a href="#morpheus.models.dfencoder.ae_module.AEModule.share_memory">share_memory</a>
()See
torch.Tensor.share_memory_()
<a href="#morpheus.models.dfencoder.ae_module.AEModule.state_dict">state_dict</a>
(*args[, destination, prefix, ...])Returns a dictionary containing references to the whole state of the module.
<a href="#morpheus.models.dfencoder.ae_module.AEModule.to">to</a>
(*args, **kwargs)Moves and/or casts the parameters and buffers.
<a href="#morpheus.models.dfencoder.ae_module.AEModule.to_empty">to_empty</a>
(*, device)Moves the parameters and buffers to the specified device without copying storage.
<a href="#morpheus.models.dfencoder.ae_module.AEModule.train">train</a>
([mode])Sets the module in training mode.
<a href="#morpheus.models.dfencoder.ae_module.AEModule.type">type</a>
(dst_type)Casts all parameters and buffers to
dst_type
.<a href="#morpheus.models.dfencoder.ae_module.AEModule.xpu">xpu</a>
([device])Moves all model parameters and buffers to the XPU.
<a href="#morpheus.models.dfencoder.ae_module.AEModule.zero_grad">zero_grad</a>
([set_to_none])Sets gradients of all model parameters to zero.
__call__
- add_module(name, module)[source]
Adds a child module to the current module.
The module can be accessed as an attribute using the given name.
- Args:
- name (str): name of the child module. The child module can be
accessed from this module using the given name
module (Module): child module to be added to the module.
- apply(fn)[source]
Applies
fn
recursively to every submodule (as returned by.children()
) as well as self. Typical use includes initializing the parameters of a model (see also nn-init-doc).- Args:
- Returns:
fn (
Module
-> None): function to be applied to each submoduleModule: self
Example:
>>> @torch.no_grad() >>> def init_weights(m): >>> print(m) >>> if type(m) == nn.Linear: >>> m.weight.fill_(1.0) >>> print(m.weight) >>> net = nn.Sequential(nn.Linear(2, 2), nn.Linear(2, 2)) >>> net.apply(init_weights) Linear(in_features=2, out_features=2, bias=True) Parameter containing: tensor([[1., 1.], [1., 1.]], requires_grad=True) Linear(in_features=2, out_features=2, bias=True) Parameter containing: tensor([[1., 1.], [1., 1.]], requires_grad=True) Sequential( (0): Linear(in_features=2, out_features=2, bias=True) (1): Linear(in_features=2, out_features=2, bias=True) )
- bfloat16()[source]
Casts all floating point parameters and buffers to
bfloat16
datatype.NoteThis method modifies the module in-place.
- Returns:
Module: self
- buffers(recurse=True)[source]
Returns an iterator over module buffers.
- Args:
- recurse (bool): if True, then yields buffers of this module
and all submodules. Otherwise, yields only buffers that are direct members of this module.
- Yields:
torch.Tensor: module buffer
Example:
>>> # xdoctest: +SKIP("undefined vars") >>> for buf in model.buffers(): >>> print(type(buf), buf.size()) <class 'torch.Tensor'> (20L,) <class 'torch.Tensor'> (20L, 1L, 5L, 5L)
- build(numeric_fts, binary_fts, categorical_fts)[source]
Constructs the autoencoder model.
- Parameters
- numeric_ftsList[str]
- binary_ftsList[str]
- categorical_ftsDict[str, Dict[str, List[str]]]
The names of the numeric features.
The names of the binary features.
The dictionary mapping categorical feature names to dictionaries containing the categories of the feature.
- children()[source]
Returns an iterator over immediate children modules.
- Yields:
Module: a child module
- cpu()[source]
Moves all model parameters and buffers to the CPU.
NoteThis method modifies the module in-place.
- Returns:
Module: self
- cuda(device=None)[source]
Moves all model parameters and buffers to the GPU.
This also makes associated parameters and buffers different objects. So it should be called before constructing optimizer if the module will live on GPU while being optimized.
NoteThis method modifies the module in-place.
- Args:
- device (int, optional): if specified, all parameters will be
copied to that device
- Returns:
Module: self
- decode(x, layers=None)[source]
Decodes the input using the decoder layers and computes the outputs.
- Parameters
- xtorch.Tensor
- layersint, optional
The encoded input tensor to decode.
The number of layers to use for decoding. Defaults to None, will use all decoder layers.
- Returns
- tuple of Union[torch.Tensor, List[torch.Tensor]]
A tuple containing the numeric (Tensor), binary (Tensor), and categorical outputs (List[torch.Tensor]) of the model.
- double()[source]
Casts all floating point parameters and buffers to
double
datatype.NoteThis method modifies the module in-place.
- Returns:
Module: self
- encode(x, layers=None)[source]
Encodes the input using the encoder layers.
- Parameters
- xtorch.Tensor
- layersint, optional
The input tensor to encode.
The number of layers to use for encoding. Defaults to None, will use all encoder layers.
- Returns
- torch.Tensor
The encoded output tensor.
- eval()[source]
Sets the module in evaluation mode.
This has any effect only on certain modules. See documentations of particular modules for details of their behaviors in training/evaluation mode, if they are affected, e.g.
Dropout
,BatchNorm
, etc.This is equivalent with
self.train(False)
.See locally-disable-grad-doc for a comparison between
<a href="#morpheus.models.dfencoder.ae_module.AEModule.eval">eval()</a>
and several similar mechanisms that may be confused with it.- Returns:
Module: self
- extra_repr()[source]
Set the extra representation of the module
To print customized extra information, you should re-implement this method in your own modules. Both single-line and multi-line strings are acceptable.
- float()[source]
Casts all floating point parameters and buffers to
float
datatype.NoteThis method modifies the module in-place.
- Returns:
Module: self
- forward(input)[source]
Passes the input through the model and returns the outputs.
- Parameters
- inputtorch.Tensor
The input tensor.
- Returns
- tuple of Union[torch.Tensor, List[torch.Tensor]]
A tuple containing the numeric (Tensor), binary (Tensor), and categorical outputs (List[torch.Tensor]) of the model.
- get_buffer(target)[source]
Returns the buffer given by
target
if it exists, otherwise throws an error.See the docstring for
get_submodule
for a more detailed explanation of this method’s functionality as well as how to correctly specifytarget
.- Args:
- target: The fully-qualified string name of the buffer
to look for. (See
get_submodule
for how to specify a fully-qualified string.)- Returns:
- Raises:
- AttributeError: If the target string references an invalid
path or resolves to something that is not a buffer
torch.Tensor: The buffer referenced by
target
- get_extra_state()[source]
Returns any extra state to include in the module’s state_dict. Implement this and a corresponding
<a href="#morpheus.models.dfencoder.ae_module.AEModule.set_extra_state">set_extra_state()</a>
for your module if you need to store extra state. This function is called when building the module’s<a href="#morpheus.models.dfencoder.ae_module.AEModule.state_dict">state_dict()</a>
.Note that extra state should be pickleable to ensure working serialization of the state_dict. We only provide provide backwards compatibility guarantees for serializing Tensors; other objects may break backwards compatibility if their serialized pickled form changes.
- Returns:
object: Any extra state to store in the module’s state_dict
- get_parameter(target)[source]
Returns the parameter given by
target
if it exists, otherwise throws an error.See the docstring for
get_submodule
for a more detailed explanation of this method’s functionality as well as how to correctly specifytarget
.- Args:
- target: The fully-qualified string name of the Parameter
to look for. (See
get_submodule
for how to specify a fully-qualified string.)- Returns:
- Raises:
- AttributeError: If the target string references an invalid
path or resolves to something that is not an
nn.Parameter
torch.nn.Parameter: The Parameter referenced by
target
- get_submodule(target)[source]
Returns the submodule given by
target
if it exists, otherwise throws an error.For example, let’s say you have an
nn.Module
A
that looks like this:A( (net_b): Module( (net_c): Module( (conv): Conv2d(16, 33, kernel_size=(3, 3), stride=(2, 2)) ) (linear): Linear(in_features=100, out_features=200, bias=True) ) )
(The diagram shows an
nn.Module
A
.A
has a nested submodulenet_b
, which itself has two submodulesnet_c
andlinear
.net_c
then has a submoduleconv
.)To check whether or not we have the
linear
submodule, we would callget_submodule("net_b.linear")
. To check whether we have theconv
submodule, we would callget_submodule("net_b.net_c.conv")
.The runtime of
get_submodule
is bounded by the degree of module nesting intarget
. A query againstnamed_modules
achieves the same result, but it is O(N) in the number of transitive modules. So, for a simple check to see if some submodule exists,get_submodule
should always be used.- Args:
- target: The fully-qualified string name of the submodule
to look for. (See above example for how to specify a fully-qualified string.)
- Returns:
- Raises:
- AttributeError: If the target string references an invalid
path or resolves to something that is not an
nn.Module
torch.nn.Module: The submodule referenced by
target
- half()[source]
Casts all floating point parameters and buffers to
half
datatype.NoteThis method modifies the module in-place.
- Returns:
Module: self
- ipu(device=None)[source]
Moves all model parameters and buffers to the IPU.
This also makes associated parameters and buffers different objects. So it should be called before constructing optimizer if the module will live on IPU while being optimized.
NoteThis method modifies the module in-place.
- Arguments:
- device (int, optional): if specified, all parameters will be
copied to that device
- Returns:
Module: self
- load_state_dict(state_dict, strict=True)[source]
Copies parameters and buffers from
<a href="#morpheus.models.dfencoder.ae_module.AEModule.state_dict">state_dict</a>
into this module and its descendants. Ifstrict
isTrue
, then the keys of<a href="#morpheus.models.dfencoder.ae_module.AEModule.state_dict">state_dict</a>
must exactly match the keys returned by this module’sstate_dict()
function.- Args:
- state_dict (dict): a dict containing parameters and
- strict (bool, optional): whether to strictly enforce that the keys
persistent buffers.
in
<a href="#morpheus.models.dfencoder.ae_module.AEModule.state_dict">state_dict</a>
match the keys returned by this module’sstate_dict()
function. Default:True
- Returns:
NamedTuple
withmissing_keys
andunexpected_keys
fields:missing_keys is a list of str containing the missing keys
unexpected_keys is a list of str containing the unexpected keys
- Note:
If a parameter or buffer is registered as
None
and its corresponding key exists in<a href="#morpheus.models.dfencoder.ae_module.AEModule.state_dict">state_dict</a>
,<a href="#morpheus.models.dfencoder.ae_module.AEModule.load_state_dict">load_state_dict()</a>
will raise aRuntimeError
.
- modules()[source]
Returns an iterator over all modules in the network.
- Yields:
- Note:
Module: a module in the network
Duplicate modules are returned only once. In the following example,
l
will be returned only once.Example:
>>> l = nn.Linear(2, 2) >>> net = nn.Sequential(l, l) >>> for idx, m in enumerate(net.modules()): ... print(idx, '->', m) 0 -> Sequential( (0): Linear(in_features=2, out_features=2, bias=True) (1): Linear(in_features=2, out_features=2, bias=True) ) 1 -> Linear(in_features=2, out_features=2, bias=True)
- named_buffers(prefix='', recurse=True)[source]
Returns an iterator over module buffers, yielding both the name of the buffer as well as the buffer itself.
- Args:
- Yields:
prefix (str): prefix to prepend to all buffer names. recurse (bool): if True, then yields buffers of this module
and all submodules. Otherwise, yields only buffers that are direct members of this module.
(str, torch.Tensor): Tuple containing the name and buffer
Example:
>>> # xdoctest: +SKIP("undefined vars") >>> for name, buf in self.named_buffers(): >>> if name in ['running_var']: >>> print(buf.size())
- named_children()[source]
Returns an iterator over immediate children modules, yielding both the name of the module as well as the module itself.
- Yields:
(str, Module): Tuple containing a name and child module
Example:
>>> # xdoctest: +SKIP("undefined vars") >>> for name, module in model.named_children(): >>> if name in ['conv4', 'conv5']: >>> print(module)
- named_modules(memo=None, prefix='', remove_duplicate=True)[source]
Returns an iterator over all modules in the network, yielding both the name of the module as well as the module itself.
- Args:
- Yields:
- Note:
memo: a memo to store the set of modules already added to the result prefix: a prefix that will be added to the name of the module remove_duplicate: whether to remove the duplicated module instances in the result
or not
(str, Module): Tuple of name and module
Duplicate modules are returned only once. In the following example,
l
will be returned only once.Example:
>>> l = nn.Linear(2, 2) >>> net = nn.Sequential(l, l) >>> for idx, m in enumerate(net.named_modules()): ... print(idx, '->', m) 0 -> ('', Sequential( (0): Linear(in_features=2, out_features=2, bias=True) (1): Linear(in_features=2, out_features=2, bias=True) )) 1 -> ('0', Linear(in_features=2, out_features=2, bias=True))
- named_parameters(prefix='', recurse=True)[source]
Returns an iterator over module parameters, yielding both the name of the parameter as well as the parameter itself.
- Args:
- Yields:
prefix (str): prefix to prepend to all parameter names. recurse (bool): if True, then yields parameters of this module
and all submodules. Otherwise, yields only parameters that are direct members of this module.
(str, Parameter): Tuple containing the name and parameter
Example:
>>> # xdoctest: +SKIP("undefined vars") >>> for name, param in self.named_parameters(): >>> if name in ['bias']: >>> print(param.size())
- parameters(recurse=True)[source]
Returns an iterator over module parameters.
This is typically passed to an optimizer.
- Args:
- recurse (bool): if True, then yields parameters of this module
and all submodules. Otherwise, yields only parameters that are direct members of this module.
- Yields:
Parameter: module parameter
Example:
>>> # xdoctest: +SKIP("undefined vars") >>> for param in model.parameters(): >>> print(type(param), param.size()) <class 'torch.Tensor'> (20L,) <class 'torch.Tensor'> (20L, 1L, 5L, 5L)
- register_backward_hook(hook)[source]
Registers a backward hook on the module.
This function is deprecated in favor of
register_full_backward_hook()
and the behavior of this function will change in future versions.- Returns:
torch.utils.hooks.RemovableHandle
:
a handle that can be used to remove the added hook by calling
handle.remove()
- register_buffer(name, tensor, persistent=True)[source]
Adds a buffer to the module.
This is typically used to register a buffer that should not to be considered a model parameter. For example, BatchNorm’s
running_mean
is not a parameter, but is part of the module’s state. Buffers, by default, are persistent and will be saved alongside parameters. This behavior can be changed by settingpersistent
toFalse
. The only difference between a persistent buffer and a non-persistent buffer is that the latter will not be a part of this module’s<a href="#morpheus.models.dfencoder.ae_module.AEModule.state_dict">state_dict</a>
.Buffers can be accessed as attributes using given names.
- Args:
- name (str): name of the buffer. The buffer can be accessed
- tensor (Tensor or None): buffer to be registered. If
None
, then operations - persistent (bool): whether the buffer is part of this module’s
from this module using the given name
that run on buffers, such as
<a href="#morpheus.models.dfencoder.ae_module.AEModule.cuda">cuda</a>
, are ignored. IfNone
, the buffer is not included in the module’s<a href="#morpheus.models.dfencoder.ae_module.AEModule.state_dict">state_dict</a>
.<a href="#morpheus.models.dfencoder.ae_module.AEModule.state_dict">state_dict</a>
.
Example:
>>> # xdoctest: +SKIP("undefined vars") >>> self.register_buffer('running_mean', torch.zeros(num_features))
- register_forward_hook(hook)[source]
Registers a forward hook on the module.
The hook will be called every time after
<a href="#morpheus.models.dfencoder.ae_module.AEModule.forward">forward()</a>
has computed an output. It should have the following signature:hook(module, input, output) -> None or modified output
The input contains only the positional arguments given to the module. Keyword arguments won’t be passed to the hooks and only to the
forward
. The hook can modify the output. It can modify the input inplace but it will not have effect on forward since this is called after<a href="#morpheus.models.dfencoder.ae_module.AEModule.forward">forward()</a>
is called.- Returns:
torch.utils.hooks.RemovableHandle
:
a handle that can be used to remove the added hook by calling
handle.remove()
- register_forward_pre_hook(hook)[source]
Registers a forward pre-hook on the module.
The hook will be called every time before
<a href="#morpheus.models.dfencoder.ae_module.AEModule.forward">forward()</a>
is invoked. It should have the following signature:hook(module, input) -> None or modified input
The input contains only the positional arguments given to the module. Keyword arguments won’t be passed to the hooks and only to the
forward
. The hook can modify the input. User can either return a tuple or a single modified value in the hook. We will wrap the value into a tuple if a single value is returned(unless that value is already a tuple).- Returns:
torch.utils.hooks.RemovableHandle
:
a handle that can be used to remove the added hook by calling
handle.remove()
- register_full_backward_hook(hook)[source]
Registers a backward hook on the module.
The hook will be called every time the gradients with respect to a module are computed, i.e. the hook will execute if and only if the gradients with respect to module outputs are computed. The hook should have the following signature:
hook(module, grad_input, grad_output) -> tuple(Tensor) or None
The
grad_input
andgrad_output
are tuples that contain the gradients with respect to the inputs and outputs respectively. The hook should not modify its arguments, but it can optionally return a new gradient with respect to the input that will be used in place ofgrad_input
in subsequent computations.grad_input
will only correspond to the inputs given as positional arguments and all kwarg arguments are ignored. Entries ingrad_input
andgrad_output
will beNone
for all non-Tensor arguments.For technical reasons, when this hook is applied to a Module, its forward function will receive a view of each Tensor passed to the Module. Similarly the caller will receive a view of each Tensor returned by the Module’s forward function.
WarningModifying inputs or outputs inplace is not allowed when using backward hooks and will raise an error.
- Returns:
torch.utils.hooks.RemovableHandle
:
a handle that can be used to remove the added hook by calling
handle.remove()
- register_load_state_dict_post_hook(hook)[source]
Registers a post hook to be run after module’s
load_state_dict
is called.- It should have the following signature::
hook(module, incompatible_keys) -> None
The
module
argument is the current module that this hook is registered on, and theincompatible_keys
argument is aNamedTuple
consisting of attributesmissing_keys
andunexpected_keys
.missing_keys
is alist
ofstr
containing the missing keys andunexpected_keys
is alist
ofstr
containing the unexpected keys.The given incompatible_keys can be modified inplace if needed.
Note that the checks performed when calling
<a href="#morpheus.models.dfencoder.ae_module.AEModule.load_state_dict">load_state_dict()</a>
withstrict=True
are affected by modifications the hook makes tomissing_keys
orunexpected_keys
, as expected. Additions to either set of keys will result in an error being thrown whenstrict=True
, and clearning out both missing and unexpected keys will avoid an error.- Returns:
torch.utils.hooks.RemovableHandle
:
a handle that can be used to remove the added hook by calling
handle.remove()
- register_module(name, module)[source]
Alias for
<a href="#morpheus.models.dfencoder.ae_module.AEModule.add_module">add_module()</a>
.- register_parameter(name, param)[source]
Adds a parameter to the module.
The parameter can be accessed as an attribute using given name.
- Args:
- name (str): name of the parameter. The parameter can be accessed
- param (Parameter or None): parameter to be added to the module. If
from this module using the given name
None
, then operations that run on parameters, such as<a href="#morpheus.models.dfencoder.ae_module.AEModule.cuda">cuda</a>
, are ignored. IfNone
, the parameter is not included in the module’s<a href="#morpheus.models.dfencoder.ae_module.AEModule.state_dict">state_dict</a>
.
- requires_grad_(requires_grad=True)[source]
Change if autograd should record operations on parameters in this module.
This method sets the parameters’
requires_grad
attributes in-place.This method is helpful for freezing part of the module for finetuning or training parts of a model individually (e.g., GAN training).
See locally-disable-grad-doc for a comparison between
<a href="#morpheus.models.dfencoder.ae_module.AEModule.requires_grad_">requires_grad_()</a>
and several similar mechanisms that may be confused with it.- Args:
- requires_grad (bool): whether autograd should record operations on
parameters in this module. Default:
True
.- Returns:
Module: self
- set_extra_state(state)[source]
This function is called from
<a href="#morpheus.models.dfencoder.ae_module.AEModule.load_state_dict">load_state_dict()</a>
to handle any extra state found within the<a href="#morpheus.models.dfencoder.ae_module.AEModule.state_dict">state_dict</a>
. Implement this function and a corresponding<a href="#morpheus.models.dfencoder.ae_module.AEModule.get_extra_state">get_extra_state()</a>
for your module if you need to store extra state within its<a href="#morpheus.models.dfencoder.ae_module.AEModule.state_dict">state_dict</a>
.- Args:
state (dict): Extra state from the
<a href="#morpheus.models.dfencoder.ae_module.AEModule.state_dict">state_dict</a>
See
torch.Tensor.share_memory_()
- state_dict(*args, destination=None, prefix='', keep_vars=False)[source]
Returns a dictionary containing references to the whole state of the module.
Both parameters and persistent buffers (e.g. running averages) are included. Keys are corresponding parameter and buffer names. Parameters and buffers set to
None
are not included.NoteThe returned object is a shallow copy. It contains references to the module’s parameters and buffers.
WarningCurrently
state_dict()
also accepts positional arguments fordestination
,prefix
andkeep_vars
in order. However, this is being deprecated and keyword arguments will be enforced in future releases.WarningPlease avoid the use of argument
destination
as it is not designed for end-users.- Args:
- destination (dict, optional): If provided, the state of module will
- prefix (str, optional): a prefix added to parameter and buffer
- keep_vars (bool, optional): by default the
Tensor
s
be updated into the dict and the same object is returned. Otherwise, an
OrderedDict
will be created and returned. Default:None
.names to compose the keys in state_dict. Default:
''
.returned in the state dict are detached from autograd. If it’s set to
True
, detaching will not be performed. Default:False
.- Returns:
- dict:
a dictionary containing a whole state of the module
Example:
>>> # xdoctest: +SKIP("undefined vars") >>> module.state_dict().keys() ['bias', 'weight']
- to(*args, **kwargs)[source]
Moves and/or casts the parameters and buffers.
This can be called as
- to(device=None, dtype=None, non_blocking=False)[source]
- to(dtype, non_blocking=False)[source]
- to(tensor, non_blocking=False)[source]
- to(memory_format=torch.channels_last)[source]
Its signature is similar to
torch.Tensor.to()
, but only accepts floating point or complexdtype
s. In addition, this method will only cast the floating point or complex parameters and buffers todtype
(if given). The integral parameters and buffers will be moveddevice
, if that is given, but with dtypes unchanged. Whennon_blocking
is set, it tries to convert/move asynchronously with respect to the host if possible, e.g., moving CPU Tensors with pinned memory to CUDA devices.See below for examples.
NoteThis method modifies the module in-place.
- Args:
- device (
torch.device
): the desired device of the parameters - dtype (
torch.dtype
): the desired floating point or complex dtype of - tensor (torch.Tensor): Tensor whose dtype and device are the desired
- memory_format (
torch.memory_format
): the desired memory
and buffers in this module
the parameters and buffers in this module
dtype and device for all parameters and buffers in this module
format for 4D parameters and buffers in this module (keyword only argument)
- device (
- Returns:
Module: self
Examples:
>>> # xdoctest: +IGNORE_WANT("non-deterministic") >>> linear = nn.Linear(2, 2) >>> linear.weight Parameter containing: tensor([[ 0.1913, -0.3420], [-0.5113, -0.2325]]) >>> linear.to(torch.double) Linear(in_features=2, out_features=2, bias=True) >>> linear.weight Parameter containing: tensor([[ 0.1913, -0.3420], [-0.5113, -0.2325]], dtype=torch.float64) >>> # xdoctest: +REQUIRES(env:TORCH_DOCTEST_CUDA1) >>> gpu1 = torch.device("cuda:1") >>> linear.to(gpu1, dtype=torch.half, non_blocking=True) Linear(in_features=2, out_features=2, bias=True) >>> linear.weight Parameter containing: tensor([[ 0.1914, -0.3420], [-0.5112, -0.2324]], dtype=torch.float16, device='cuda:1') >>> cpu = torch.device("cpu") >>> linear.to(cpu) Linear(in_features=2, out_features=2, bias=True) >>> linear.weight Parameter containing: tensor([[ 0.1914, -0.3420], [-0.5112, -0.2324]], dtype=torch.float16) >>> linear = nn.Linear(2, 2, bias=None).to(torch.cdouble) >>> linear.weight Parameter containing: tensor([[ 0.3741+0.j, 0.2382+0.j], [ 0.5593+0.j, -0.4443+0.j]], dtype=torch.complex128) >>> linear(torch.ones(3, 2, dtype=torch.cdouble)) tensor([[0.6122+0.j, 0.1150+0.j], [0.6122+0.j, 0.1150+0.j], [0.6122+0.j, 0.1150+0.j]], dtype=torch.complex128)
- to_empty(*, device)[source]
Moves the parameters and buffers to the specified device without copying storage.
- Args:
- device (
torch.device
): The desired device of the parameters
and buffers in this module.
- device (
- Returns:
Module: self
- train(mode=True)[source]
Sets the module in training mode.
This has any effect only on certain modules. See documentations of particular modules for details of their behaviors in training/evaluation mode, if they are affected, e.g.
Dropout
,BatchNorm
, etc.- Args:
- mode (bool): whether to set training mode (
True
) or evaluation
mode (
False
). Default:True
.- mode (bool): whether to set training mode (
- Returns:
Module: self
- type(dst_type)[source]
Casts all parameters and buffers to
dst_type
.NoteThis method modifies the module in-place.
- Args:
- Returns:
dst_type (type or string): the desired type
Module: self
- xpu(device=None)[source]
Moves all model parameters and buffers to the XPU.
This also makes associated parameters and buffers different objects. So it should be called before constructing optimizer if the module will live on XPU while being optimized.
NoteThis method modifies the module in-place.
- Arguments:
- device (int, optional): if specified, all parameters will be
copied to that device
- Returns:
Module: self
- zero_grad(set_to_none=False)[source]
Sets gradients of all model parameters to zero. See similar function under
torch.optim.Optimizer
for more context.- Args:
- set_to_none (bool): instead of setting to zero, set the grads to None.
See
torch.optim.Optimizer.zero_grad()
for details.