Skip to content

Commit

Permalink
change default args in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
guillemsimeon committed Jun 12, 2023
1 parent 96b6763 commit e0bf361
Showing 1 changed file with 8 additions and 11 deletions.
19 changes: 8 additions & 11 deletions torchmdnet/models/tensornet.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,34 +55,31 @@ def tensor_norm(tensor):


class TensorNet(nn.Module):
r"""TensorNet's architecture.
r"""TensorNet's architecture, from TensorNet: Cartesian Tensor Representations
for Efficient Learning of Molecular Potentials; G. Simeon and G. de Fabritiis.
Args:
hidden_channels (int, optional): Hidden embedding size.
(default: :obj:`128`)
num_layers (int, optional): The number of interaction layers.
(default: :obj:`6`)
(default: :obj:`2`)
num_rbf (int, optional): The number of radial basis functions :math:`\mu`.
(default: :obj:`50`)
(default: :obj:`32`)
rbf_type (string, optional): The type of radial basis function to use.
(default: :obj:`"expnorm"`)
trainable_rbf (bool, optional): Whether to train RBF parameters with
backpropagation. (default: :obj:`True`)
backpropagation. (default: :obj:`False`)
activation (string, optional): The type of activation function to use.
(default: :obj:`"silu"`)
cutoff_lower (float, optional): Lower cutoff distance for interatomic interactions.
(default: :obj:`0.0`)
cutoff_upper (float, optional): Upper cutoff distance for interatomic interactions.
(default: :obj:`5.0`)
(default: :obj:`4.5`)
max_z (int, optional): Maximum atomic number. Used for initializing embeddings.
(default: :obj:`100`)
(default: :obj:`128`)
max_num_neighbors (int, optional): Maximum number of neighbors to return for a
given node/atom when constructing the molecular graph during forward passes.
This attribute is passed to the torch_cluster radius_graph routine keyword
max_num_neighbors, which normally defaults to 32. Users should set this to
higher values if they are using higher upper distance cutoffs and expect more
than 32 neighbors per node/atom.
(default: :obj:`32`)
(default: :obj:`64`)
equivariance_invariance_group (string, optional): Group under whose action on input
positions internal tensor features will be equivariant and scalar predictions
will be invariant. O(3) or SO(3).
Expand Down

0 comments on commit e0bf361

Please sign in to comment.