api.rst 1.88 KB
Newer Older
Gao, Xiang's avatar
Gao, Xiang committed
1
2
3
4
5
6
7
TorchANI
========

.. autoclass:: torchani.AEVComputer
    :members:
.. autoclass:: torchani.ANIModel
.. autoclass:: torchani.Ensemble
Gao, Xiang's avatar
Gao, Xiang committed
8
9
.. autoclass:: torchani.SpeciesConverter
    :members:
Gao, Xiang's avatar
Gao, Xiang committed
10
11
12
13
14
.. autoclass:: torchani.EnergyShifter
    :members:
.. autoclass:: torchani.nn.Gaussian


Gao, Xiang's avatar
Gao, Xiang committed
15
16
17
18
19
20
21
22
Model Zoo
=========

.. automodule:: torchani.models
.. autoclass:: torchani.models.ANI1x
    :members:
.. autoclass:: torchani.models.ANI1ccx
    :members:
Christian Devereux's avatar
Christian Devereux committed
23
24
.. autoclass:: torchani.models.ANI2x
    :members:
Gao, Xiang's avatar
Gao, Xiang committed
25
26


Gao, Xiang's avatar
Gao, Xiang committed
27
28
29
30
Datasets
========

.. automodule:: torchani.data
Gao, Xiang's avatar
Gao, Xiang committed
31

Gao, Xiang's avatar
Gao, Xiang committed
32
33
34
35
36
37


Utilities
=========

.. automodule:: torchani.utils
38
.. autofunction:: torchani.utils.pad_atomic_properties
Gao, Xiang's avatar
Gao, Xiang committed
39
40
.. autofunction:: torchani.utils.present_species
.. autofunction:: torchani.utils.strip_redundant_padding
41
.. autofunction:: torchani.utils.map2central
Gao, Xiang's avatar
Gao, Xiang committed
42
43
.. autoclass:: torchani.utils.ChemicalSymbolsToInts
    :members:
44
.. autofunction:: torchani.utils.vibrational_analysis
45
.. autofunction:: torchani.utils.get_atomic_masses
Gao, Xiang's avatar
Gao, Xiang committed
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62


NeuroChem
=========

.. automodule:: torchani.neurochem
.. autoclass:: torchani.neurochem.Constants
    :members:
.. autofunction:: torchani.neurochem.load_sae
.. autofunction:: torchani.neurochem.load_atomic_network
.. autofunction:: torchani.neurochem.load_model
.. autofunction:: torchani.neurochem.load_model_ensemble
.. autoclass:: torchani.neurochem.Trainer
    :members:
.. automodule:: torchani.neurochem.trainer


Gao, Xiang's avatar
Gao, Xiang committed
63
64
65
66
ASE Interface
=============

.. automodule:: torchani.ase
Gao, Xiang's avatar
Gao, Xiang committed
67
.. autoclass:: torchani.ase.Calculator
Gao, Xiang's avatar
Gao, Xiang committed
68

Ignacio Pickering's avatar
Ignacio Pickering committed
69
70
71
72
73
74
75
76
77
78
79
80
Units
=====

.. automodule:: torchani.units
.. autofunction:: torchani.units.hartree2ev
.. autofunction:: torchani.units.hartree2kcalmol
.. autofunction:: torchani.units.hartree2kjoulemol
.. autofunction:: torchani.units.ev2kcalmol
.. autofunction:: torchani.units.ev2kjoulemol
.. autofunction:: torchani.units.mhessian2fconst
.. autofunction:: torchani.units.sqrt_mhessian2invcm
.. autofunction:: torchani.units.sqrt_mhessian2milliev