tfep.nn.transformers.quatprod.QuaternionProductTransformer

class tfep.nn.transformers.quatprod.QuaternionProductTransformer(*args, **kwargs)

Bases: MAFTransformer

Quaternion product transformer.

This is a volume-preserving transformation that can be applied to quaternions. For each (normalized) quaternion in the input, the conditioner must provide a 4-dimensional vector (possibly unnormalized). As quaternions typically model the orientation of a molecule, the transformation is equivalent to applying a separate rigid rotation to each molecule and thus has a unit Jacobian.

__init__(*args, **kwargs) → None

Initialize internal Module state, shared by both nn.Module and ScriptModule.

Methods

__init__(*args, **kwargs)	Initialize internal Module state, shared by both nn.Module and ScriptModule.
add_module(name, module)	Add a child module to the current module.
apply(fn)	Apply fn recursively to every submodule (as returned by .children()) as well as self.
bfloat16()	Casts all floating point parameters and buffers to bfloat16 datatype.
buffers([recurse])	Return an iterator over module buffers.
children()	Return an iterator over immediate children modules.
compile(*args, **kwargs)	Compile this Module's forward using torch.compile().
cpu()	Move all model parameters and buffers to the CPU.
cuda([device])	Move all model parameters and buffers to the GPU.
double()	Casts all floating point parameters and buffers to double datatype.
eval()	Set the module in evaluation mode.
extra_repr()	Set the extra representation of the module.
float()	Casts all floating point parameters and buffers to float datatype.
forward(x, parameters)	Apply the transformation.
get_buffer(target)	Return the buffer given by target if it exists, otherwise throw an error.
get_degrees_out(degrees_in)	Returns the degrees associated to the conditioner's output.
get_extra_state()	Return any extra state to include in the module's state_dict.
get_identity_parameters(n_features)	Return the value of the parameters that makes this the identity function.
get_parameter(target)	Return the parameter given by target if it exists, otherwise throw an error.
get_submodule(target)	Return the submodule given by target if it exists, otherwise throw an error.
half()	Casts all floating point parameters and buffers to half datatype.
inverse(y, parameters)	Reverse the transformation.
ipu([device])	Move all model parameters and buffers to the IPU.
load_state_dict(state_dict[, strict, assign])	Copy parameters and buffers from state_dict into this module and its descendants.
modules()	Return an iterator over all modules in the network.
mtia([device])	Move all model parameters and buffers to the MTIA.
named_buffers([prefix, recurse, ...])	Return an iterator over module buffers, yielding both the name of the buffer as well as the buffer itself.
named_children()	Return an iterator over immediate children modules, yielding both the name of the module as well as the module itself.
named_modules([memo, prefix, remove_duplicate])	Return an iterator over all modules in the network, yielding both the name of the module as well as the module itself.
named_parameters([prefix, recurse, ...])	Return an iterator over module parameters, yielding both the name of the parameter as well as the parameter itself.
parameters([recurse])	Return an iterator over module parameters.
register_backward_hook(hook)	Register a backward hook on the module.
register_buffer(name, tensor[, persistent])	Add a buffer to the module.
register_forward_hook(hook, *[, prepend, ...])	Register a forward hook on the module.
register_forward_pre_hook(hook, *[, ...])	Register a forward pre-hook on the module.
register_full_backward_hook(hook[, prepend])	Register a backward hook on the module.
register_full_backward_pre_hook(hook[, prepend])	Register a backward pre-hook on the module.
register_load_state_dict_post_hook(hook)	Register a post-hook to be run after module's load_state_dict() is called.
register_load_state_dict_pre_hook(hook)	Register a pre-hook to be run before module's load_state_dict() is called.
register_module(name, module)	Alias for add_module().
register_parameter(name, param)	Add a parameter to the module.
register_state_dict_post_hook(hook)	Register a post-hook for the state_dict() method.
register_state_dict_pre_hook(hook)	Register a pre-hook for the state_dict() method.
requires_grad_([requires_grad])	Change if autograd should record operations on parameters in this module.
set_extra_state(state)	Set extra state contained in the loaded state_dict.
set_submodule(target, module)	Set the submodule given by target if it exists, otherwise throw an error.
share_memory()	See torch.Tensor.share_memory_().
state_dict(*args[, destination, prefix, ...])	Return a dictionary containing references to the whole state of the module.
to(*args, **kwargs)	Move and/or cast the parameters and buffers.
to_empty(*, device[, recurse])	Move the parameters and buffers to the specified device without copying storage.
train([mode])	Set the module in training mode.
type(dst_type)	Casts all parameters and buffers to dst_type.
xpu([device])	Move all model parameters and buffers to the XPU.
zero_grad([set_to_none])	Reset gradients of all model parameters.

Attributes

T_destination
call_super_init
dump_patches
training

forward(x: Tensor, parameters: Tensor) → tuple[Tensor]

Apply the transformation.

Parameters:

• x (torch.Tensor) – Shape (batch_size, n_quaternions*4). The quaternions elements are contiguous (i.e., the first and second input quaternions are x[:4] and x[4:8].

• parameters (torch.Tensor) – Shape (batch_size, n_quaternions*4). The parameters interpreted as (unnormalized) quaternions that will multiply those in x. These are normalized in the function.

Returns:

• y (torch.Tensor) – Shape (batch_size, n_quaternions*4). The transformed normalized quaternions.

• log_det_J (torch.Tensor) – Shape (batch_size,). The logarithm of the absolute value of the Jacobian determinant dy / dx (i.e., always zero).

get_degrees_out(degrees_in: Tensor) → Tensor

Returns the degrees associated to the conditioner’s output.

Parameters:

degrees_in (torch.Tensor) – Shape (n_transformed_features,). The autoregressive degrees associated to the features provided as input to the transformer.

Returns:

degrees_out – Shape (n_parameters,). The autoregressive degrees associated to each output of the conditioner that will be fed to the transformer as parameters.

Return type:

torch.Tensor

get_identity_parameters(n_features: int) → Tensor

Return the value of the parameters that makes this the identity function.

This can be used to initialize the normalizing flow to perform the identity transformation.

Parameters:

n_features (int) – The dimension of the input vector passed to the transformer. Must be divisible by 4.

Returns:

parameters – A tensor of shape (n_features,) representing the parameter vector to perform the identity function with a Moebius transformer.

Return type:

torch.Tensor

inverse(y: Tensor, parameters: Tensor) → tuple[Tensor]

Reverse the transformation.

Parameters:

• y (torch.Tensor) – Shape (batch_size, n_quaternions*4). The quaternions elements are contiguous (i.e., the first and second input quaternions are y[:4] and y[4:8].

• parameters (torch.Tensor) – Shape (batch_size, n_quaternions*4). The parameters interpreted as (unnormalized) quaternions that will multiply those in y. These are normalized in the function.

Returns:

• x (torch.Tensor) – Shape (batch_size, n_quaternions*4). The transformed normalized quaternions.

• log_det_J (torch.Tensor) – Shape (batch_size,). The logarithm of the absolute value of the Jacobian determinant dy / dx (i.e., always zero).