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

.. autoclass:: torchani.AEVComputer
    :members:
.. autoclass:: torchani.ANIModel
.. autoclass:: torchani.Ensemble
.. autoclass:: torchani.EnergyShifter
    :members:
.. autoclass:: torchani.nn.Gaussian


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

.. automodule:: torchani.models
.. autoclass:: torchani.models.ANI1x
    :members:
.. autoclass:: torchani.models.ANI1ccx
    :members:


Gao, Xiang's avatar
Gao, Xiang committed
23
24
25
26
27
Datasets
========

.. automodule:: torchani.data
.. autoclass:: torchani.data.BatchedANIDataset
Gao, Xiang's avatar
Gao, Xiang committed
28
.. autoclass:: torchani.data.AEVCacheLoader
Gao, Xiang's avatar
Gao, Xiang committed
29
30
31
32
33
34
35
.. automodule:: torchani.data.cache_aev


Utilities
=========

.. automodule:: torchani.utils
36
37
.. autofunction:: torchani.utils.pad
.. autofunction:: torchani.utils.pad_coordinates
Gao, Xiang's avatar
Gao, Xiang committed
38
39
.. autofunction:: torchani.utils.present_species
.. autofunction:: torchani.utils.strip_redundant_padding
Gao, Xiang's avatar
Gao, Xiang committed
40
41
.. autoclass:: torchani.utils.ChemicalSymbolsToInts
    :members:
Gao, Xiang's avatar
Gao, Xiang committed
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59


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.Builtins
.. autoclass:: torchani.neurochem.Trainer
    :members:
.. automodule:: torchani.neurochem.trainer


Gao, Xiang's avatar
Gao, Xiang committed
60
61
62
63
64
65
ASE Interface
=============

.. automodule:: torchani.ase
.. autoclass:: torchani.ase.NeighborList
    :members:
Gao, Xiang's avatar
Gao, Xiang committed
66
.. autoclass:: torchani.ase.Calculator
Gao, Xiang's avatar
Gao, Xiang committed
67

Gao, Xiang's avatar
Gao, Xiang committed
68
69
70
71
72
73
74
75
76
77
78
79
80
Ignite Helpers
==============

.. automodule:: torchani.ignite
.. autoclass:: torchani.ignite.Container
    :members:
.. autoclass:: torchani.ignite.DictLoss
.. autoclass:: torchani.ignite.PerAtomDictLoss
.. autoclass:: torchani.ignite.TransformedLoss
.. autofunction:: torchani.ignite.MSELoss
.. autoclass:: torchani.ignite.DictMetric
.. autofunction:: torchani.ignite.RMSEMetric
.. autofunction:: torchani.ignite.MAEMetric