api.rst 2.27 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
Datasets
========

.. automodule:: torchani.data
27
28
29
.. autofunction:: torchani.data.find_threshold
.. autofunction:: torchani.data.ShuffledDataset
.. autoclass:: torchani.data.CachedDataset
30
31
.. autofunction:: torchani.data.load_ani_dataset
.. autofunction:: torchani.data.create_aev_cache
Gao, Xiang's avatar
Gao, Xiang committed
32
.. autoclass:: torchani.data.BatchedANIDataset
Gao, Xiang's avatar
Gao, Xiang committed
33
.. autoclass:: torchani.data.AEVCacheLoader
Gao, Xiang's avatar
Gao, Xiang committed
34
35
36
37
38
39
40
.. automodule:: torchani.data.cache_aev


Utilities
=========

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


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
67
68
69
70
ASE Interface
=============

.. automodule:: torchani.ase
Gao, Xiang's avatar
Gao, Xiang committed
71
.. autoclass:: torchani.ase.Calculator
Gao, Xiang's avatar
Gao, Xiang committed
72

73
74
75
76
77
78
79
80

TorchANI Optimizater
====================

.. automodule:: torchani.optim
.. autoclass:: torchani.optim.AdamW


Gao, Xiang's avatar
Gao, Xiang committed
81
82
83
84
85
86
87
88
89
90
91
92
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
93
.. autofunction:: torchani.ignite.MaxAEMetric