mlatom 1.2.1__tar.gz → 1.2.3__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
MLatom-1.2.3/MLatomF ADDED
@@ -0,0 +1,12 @@
1
+ #!/bin/bash
2
+ if [ -L $0 ]; then
3
+ dir=`dirname $(readlink $0)`
4
+ else
5
+ dir=`dirname $0`
6
+ fi
7
+ py=$dir/python
8
+ pkg_path=`$py -c 'import MLatom
9
+ print(MLatom.__path__[0])
10
+ '`
11
+ MLatomF=$pkg_path/MLatomF
12
+ $MLatomF "$@"
MLatom-1.2.3/PKG-INFO ADDED
@@ -0,0 +1,130 @@
1
+ Metadata-Version: 2.1
2
+ Name: MLatom
3
+ Version: 1.2.3
4
+ Summary: A Package for Atomistic Simulations with Machine Learning
5
+ Home-page: http://mlatom.com
6
+ Author: Pavlo O. Dral
7
+ Author-email: admin@mlatom.com
8
+ License: CC BY-NC-ND 4.0
9
+ Description: # Brief Introduction
10
+ A Package for Atomistic Simulations with Machine Learning
11
+
12
+ **manual**: http://mlatom.com/manual/
13
+ **tutorial**: http://mlatom.com/tutorial/
14
+
15
+
16
+ # Tasks Performed by MLatom
17
+ A brief overview of MLatom capabilities. See sections below for more details.
18
+
19
+ ## Tasks
20
+ - Estimating accuracy of ML models.
21
+ - Creating ML model and saving it to a file.
22
+ - Loading existing ML model from a file and performing ML calculations with this model.
23
+ - ML-cross-section to boost the calculation of ML-NEA
24
+
25
+ ## Data Set Operations
26
+ - Converting XYZ coordinates into an input vector (molecular descriptor) for ML.
27
+ - Sampling subsets from a data set.
28
+
29
+
30
+ # Sampling
31
+ - none: simply splitting the data set into the training, test, and, if necessary, training set into the subtraining and validation sets (in this order) without changing the order of indices.
32
+ - random sampling.
33
+ - user-defined: requests MLatom to read indices for the training, test, and, if necessary, for the subtraining and validation sets from files.
34
+ - [ structure-based sampling ](http://mlatom.com/self-correcting-machine-learning-and-structure-based-sampling/)
35
+ - from unsliced and sliced data
36
+ - [ farthest-point traversal iterative procedure ](https://en.wikipedia.org/wiki/Farthest-first_traversal), which starts from two points farthest apart.
37
+
38
+
39
+ # ML Algorithm
40
+ [ Kernel ridge regression](https://web.stanford.edu/~hastie/ElemStatLearn/) with the following kernels:
41
+ - [ Gaussian ](https://doi.org/10.1103/PhysRevLett.108.058301).
42
+ - [ Laplacian ](https://doi.org/10.1103/PhysRevLett.108.058301).
43
+ - exponential.
44
+ - [ Matérn ](http://dx.doi.org/10.1198/jasa.2010.tm09420) ([ details of implementation ](http://dx.doi.org/10.1021/acs.jpclett.8b02469)).
45
+ Permutationally invariant kernel and self-correction are also supported.
46
+
47
+
48
+ # Hybrid QM/ML Approaches
49
+ [ Δ-machine learning ](http://dx.doi.org/10.1021/acs.jctc.5b00099).
50
+
51
+
52
+ # Molecular Descriptors
53
+ - [ Coulomb matrix ](https://doi.org/10.1103/PhysRevLett.108.058301)
54
+ - [ sorted by norms of its rows ](http://dx.doi.org/10.1021/ct400195d);
55
+ - unsorted;
56
+ - permuted.
57
+ - [ Normalized inverted internuclear distances ](http://mlatom.com/self-correcting-machine-learning-and-structure-based-sampling/)
58
+ - sorted for user-defined atoms by the sum of their nuclear repulsions to all other atoms;
59
+ - unsorted;
60
+ - permuted.
61
+
62
+
63
+ # The KREG model
64
+ Now we set [ KREG (Kernel-ridge-regression using RE descriptor and the Gaussian kernel function )](http://dx.doi.org/10.1021/acs.jpclett.8b02469) as default ML method. Default hyperparameter optimization options were updated to speed up the hyperparameter search for KREG.
65
+
66
+
67
+ # Model Validation
68
+ [ ML model can be validated (generalization error can be estimated) in several ways: ](https://web.stanford.edu/~hastie/ElemStatLearn/)
69
+
70
+ - on a hold-out test set not used for training. Both training and test sets can be sampled in one of the ways described above;
71
+ - by performing N-fold cross-validation. User can define the number of folds N. If N is equal to the number of data points, leave-one-out cross-validation is performed. Only random or no sampling can be used for cross-validation.
72
+ - by performing leave-one-out cross-validation (special case of N-fold cross-validation).
73
+ MLatom prints out mean absolute error (MAE), mean signed error (MSE), root-mean-squared error (RMSE), mean values of reference and estimated values, largest positive and negative outliers, correlation coefficient and its squared value R2 as well as coefficients of linear regression and corresponding standard deviations.
74
+
75
+
76
+ # Hyperparameter Tuning
77
+ Gaussian, Laplacian, and Matérn kernels have σ and λ tunable hyperparameters. MLatom can determine them by performing user-defined number of iterations of hyperparameter optimization on a logarithmic grid. User can adjust number of grid points, starting and finishing points on the grid. Hyperparameter are tuned to minimize either mean absolute error or root-mean-square error as defined by the user. [ Hyperparameters can be tuned to minimize ](https://web.stanford.edu/~hastie/ElemStatLearn/)
78
+
79
+ - the error of the ML model trained on the subtraining set in a hold-out validation set. Both subtraining and validation sets are parts of the training set, which can be used at the end with optimal parameters for training the final ML model. These sets ideally should not overlap and can be [ sampled ](http://mlatom.com/features/#Sampling) from the training set in one of the ways described above;
80
+ - N-fold cross-validation error. User can define the number of folds N. If N is equal to the number of data points, leave-one-out cross-validation is performed. Only random or no sampling can be used for cross-validation.
81
+
82
+ Note that hyperparameter tuning can be performed together with model validation. This means that for example one can perform outer loop of the cross-validation for model validation and tune hyperparameters via inner loop of the cross-validation.
83
+
84
+
85
+ # First Derivatives
86
+ MLatom can be also used to estimate first derivatives from an ML model. It can be useful, if an ML model has been created for energies, and one wants to estimate forces. Two scenarios are possible:
87
+
88
+ - partial derivatives are calculated for each dimension of given input vectors (analytical derivatives for Gaussian kernel, numerical derivatives for other kernels);
89
+ - first derivatives are calculated in XYZ coordinates for input files containing molecular XYZ coordinates (only numerical derivatives).
90
+
91
+
92
+ # Cross Section
93
+ MLatom can significantly accelerate the calculation of cross-section with the Nuclear Ensemble Approach (NEA).
94
+
95
+ In brief, this feature uses fewer QC calculation to achieve higher precision and reduce computational cost. You can find more detail on this paper (please cite it when using this feature:
96
+
97
+ > Bao-Xin Xue, Mario Barbatti*, Pavlo O. Dral*, [ Machine Learning for Absorption Cross Sections ](https://doi.org/10.1021/acs.jpca.0c05310), J. Phys. Chem. A 2020, 124, 7199–7210. DOI: 10.1021/acs.jpca.0c05310.
98
+ > [ Preprint on ChemRxiv ](https://doi.org/10.26434/chemrxiv.12594191), DOI: 10.26434/chemrxiv.12594191.
99
+
100
+ # About Program
101
+ MLatom: a Package for Atomistic Simulations with Machine Learning
102
+ Version 1.2
103
+ http://mlatom.com/
104
+
105
+ Copyright (c) 2013-2020 Pavlo O. Dral
106
+ http://dr-dral.com/
107
+
108
+ All rights reserved. No part of MLatom may be used, published or redistributed without written permission by Pavlo Dral.
109
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
110
+ The software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.
111
+
112
+ Cite as:
113
+ 1. Pavlo O. Dral, J. Comput. Chem. 2019, 40, 2339-2347
114
+ 2. Pavlo O. Dral, Bao-Xin Xue, Fuchun Ge, Yi-Fan Hou, MLatom: A Package for Atomistic Simulations with Machine Learning, version 1.2, Xiamen University, Xiamen, China, 2013-2020.
115
+
116
+
117
+ # License
118
+
119
+ This work is licensed under the [Attribution-NonCommercial-NoDerivatives 4.0 International](http://creativecommons.org/licenses/by-nc-nd/4.0/) license. See LICENSE.CC-BY-NC-ND-4.0.
120
+
121
+ <a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-nd/4.0/88x31.png" /></a>
122
+
123
+ Platform: UNKNOWN
124
+ Classifier: Programming Language :: Python :: 3
125
+ Classifier: Operating System :: POSIX :: Linux
126
+ Classifier: Programming Language :: Fortran
127
+ Classifier: Topic :: Scientific/Engineering :: Chemistry
128
+ Classifier: Environment :: Console
129
+ Requires-Python: >=3.7
130
+ Description-Content-Type: text/markdown
MLatom-1.2.3/README.md ADDED
@@ -0,0 +1,113 @@
1
+ # Brief Introduction
2
+ A Package for Atomistic Simulations with Machine Learning
3
+
4
+ **manual**: http://mlatom.com/manual/
5
+ **tutorial**: http://mlatom.com/tutorial/
6
+
7
+
8
+ # Tasks Performed by MLatom
9
+ A brief overview of MLatom capabilities. See sections below for more details.
10
+
11
+ ## Tasks
12
+ - Estimating accuracy of ML models.
13
+ - Creating ML model and saving it to a file.
14
+ - Loading existing ML model from a file and performing ML calculations with this model.
15
+ - ML-cross-section to boost the calculation of ML-NEA
16
+
17
+ ## Data Set Operations
18
+ - Converting XYZ coordinates into an input vector (molecular descriptor) for ML.
19
+ - Sampling subsets from a data set.
20
+
21
+
22
+ # Sampling
23
+ - none: simply splitting the data set into the training, test, and, if necessary, training set into the subtraining and validation sets (in this order) without changing the order of indices.
24
+ - random sampling.
25
+ - user-defined: requests MLatom to read indices for the training, test, and, if necessary, for the subtraining and validation sets from files.
26
+ - [ structure-based sampling ](http://mlatom.com/self-correcting-machine-learning-and-structure-based-sampling/)
27
+ - from unsliced and sliced data
28
+ - [ farthest-point traversal iterative procedure ](https://en.wikipedia.org/wiki/Farthest-first_traversal), which starts from two points farthest apart.
29
+
30
+
31
+ # ML Algorithm
32
+ [ Kernel ridge regression](https://web.stanford.edu/~hastie/ElemStatLearn/) with the following kernels:
33
+ - [ Gaussian ](https://doi.org/10.1103/PhysRevLett.108.058301).
34
+ - [ Laplacian ](https://doi.org/10.1103/PhysRevLett.108.058301).
35
+ - exponential.
36
+ - [ Matérn ](http://dx.doi.org/10.1198/jasa.2010.tm09420) ([ details of implementation ](http://dx.doi.org/10.1021/acs.jpclett.8b02469)).
37
+ Permutationally invariant kernel and self-correction are also supported.
38
+
39
+
40
+ # Hybrid QM/ML Approaches
41
+ [ Δ-machine learning ](http://dx.doi.org/10.1021/acs.jctc.5b00099).
42
+
43
+
44
+ # Molecular Descriptors
45
+ - [ Coulomb matrix ](https://doi.org/10.1103/PhysRevLett.108.058301)
46
+ - [ sorted by norms of its rows ](http://dx.doi.org/10.1021/ct400195d);
47
+ - unsorted;
48
+ - permuted.
49
+ - [ Normalized inverted internuclear distances ](http://mlatom.com/self-correcting-machine-learning-and-structure-based-sampling/)
50
+ - sorted for user-defined atoms by the sum of their nuclear repulsions to all other atoms;
51
+ - unsorted;
52
+ - permuted.
53
+
54
+
55
+ # The KREG model
56
+ Now we set [ KREG (Kernel-ridge-regression using RE descriptor and the Gaussian kernel function )](http://dx.doi.org/10.1021/acs.jpclett.8b02469) as default ML method. Default hyperparameter optimization options were updated to speed up the hyperparameter search for KREG.
57
+
58
+
59
+ # Model Validation
60
+ [ ML model can be validated (generalization error can be estimated) in several ways: ](https://web.stanford.edu/~hastie/ElemStatLearn/)
61
+
62
+ - on a hold-out test set not used for training. Both training and test sets can be sampled in one of the ways described above;
63
+ - by performing N-fold cross-validation. User can define the number of folds N. If N is equal to the number of data points, leave-one-out cross-validation is performed. Only random or no sampling can be used for cross-validation.
64
+ - by performing leave-one-out cross-validation (special case of N-fold cross-validation).
65
+ MLatom prints out mean absolute error (MAE), mean signed error (MSE), root-mean-squared error (RMSE), mean values of reference and estimated values, largest positive and negative outliers, correlation coefficient and its squared value R2 as well as coefficients of linear regression and corresponding standard deviations.
66
+
67
+
68
+ # Hyperparameter Tuning
69
+ Gaussian, Laplacian, and Matérn kernels have σ and λ tunable hyperparameters. MLatom can determine them by performing user-defined number of iterations of hyperparameter optimization on a logarithmic grid. User can adjust number of grid points, starting and finishing points on the grid. Hyperparameter are tuned to minimize either mean absolute error or root-mean-square error as defined by the user. [ Hyperparameters can be tuned to minimize ](https://web.stanford.edu/~hastie/ElemStatLearn/)
70
+
71
+ - the error of the ML model trained on the subtraining set in a hold-out validation set. Both subtraining and validation sets are parts of the training set, which can be used at the end with optimal parameters for training the final ML model. These sets ideally should not overlap and can be [ sampled ](http://mlatom.com/features/#Sampling) from the training set in one of the ways described above;
72
+ - N-fold cross-validation error. User can define the number of folds N. If N is equal to the number of data points, leave-one-out cross-validation is performed. Only random or no sampling can be used for cross-validation.
73
+
74
+ Note that hyperparameter tuning can be performed together with model validation. This means that for example one can perform outer loop of the cross-validation for model validation and tune hyperparameters via inner loop of the cross-validation.
75
+
76
+
77
+ # First Derivatives
78
+ MLatom can be also used to estimate first derivatives from an ML model. It can be useful, if an ML model has been created for energies, and one wants to estimate forces. Two scenarios are possible:
79
+
80
+ - partial derivatives are calculated for each dimension of given input vectors (analytical derivatives for Gaussian kernel, numerical derivatives for other kernels);
81
+ - first derivatives are calculated in XYZ coordinates for input files containing molecular XYZ coordinates (only numerical derivatives).
82
+
83
+
84
+ # Cross Section
85
+ MLatom can significantly accelerate the calculation of cross-section with the Nuclear Ensemble Approach (NEA).
86
+
87
+ In brief, this feature uses fewer QC calculation to achieve higher precision and reduce computational cost. You can find more detail on this paper (please cite it when using this feature:
88
+
89
+ > Bao-Xin Xue, Mario Barbatti*, Pavlo O. Dral*, [ Machine Learning for Absorption Cross Sections ](https://doi.org/10.1021/acs.jpca.0c05310), J. Phys. Chem. A 2020, 124, 7199–7210. DOI: 10.1021/acs.jpca.0c05310.
90
+ > [ Preprint on ChemRxiv ](https://doi.org/10.26434/chemrxiv.12594191), DOI: 10.26434/chemrxiv.12594191.
91
+
92
+ # About Program
93
+ MLatom: a Package for Atomistic Simulations with Machine Learning
94
+ Version 1.2
95
+ http://mlatom.com/
96
+
97
+ Copyright (c) 2013-2020 Pavlo O. Dral
98
+ http://dr-dral.com/
99
+
100
+ All rights reserved. No part of MLatom may be used, published or redistributed without written permission by Pavlo Dral.
101
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
102
+ The software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.
103
+
104
+ Cite as:
105
+ 1. Pavlo O. Dral, J. Comput. Chem. 2019, 40, 2339-2347
106
+ 2. Pavlo O. Dral, Bao-Xin Xue, Fuchun Ge, Yi-Fan Hou, MLatom: A Package for Atomistic Simulations with Machine Learning, version 1.2, Xiamen University, Xiamen, China, 2013-2020.
107
+
108
+
109
+ # License
110
+
111
+ This work is licensed under the [Attribution-NonCommercial-NoDerivatives 4.0 International](http://creativecommons.org/licenses/by-nc-nd/4.0/) license. See LICENSE.CC-BY-NC-ND-4.0.
112
+
113
+ <a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-nd/4.0/88x31.png" /></a>
@@ -43,16 +43,18 @@ with open(os.path.join(here, 'README.md')) as f:
43
43
 
44
44
  setup(
45
45
  name = pkg_name,
46
- version = "1.2.1",
46
+ version = "1.2.3",
47
47
  author = "Pavlo O. Dral",
48
48
  author_email = "admin@mlatom.com",
49
+ license = 'CC BY-NC-ND 4.0', # https://creativecommons.org/licenses/by-nc-nd/4.0/
49
50
  description = "A Package for Atomistic Simulations with Machine Learning",
50
51
  long_description = README,
52
+ long_description_content_type = 'text/markdown',
51
53
  url = "http://mlatom.com",
52
- python_requires='>=3.6',
54
+ python_requires='>=3.7',
53
55
  packages = find_packages('src'),
54
56
  package_dir = {'' : 'src'},
55
- scripts = ['mlatom'],
57
+ scripts = ['mlatom', 'MLatomF'],
56
58
  package_data = {"": ['MLatomF', '*.json']},
57
59
  classifiers = [
58
60
  "Programming Language :: Python :: 3",
@@ -61,6 +63,7 @@ setup(
61
63
  "Topic :: Scientific/Engineering :: Chemistry",
62
64
  "Environment :: Console",
63
65
  ],
66
+ # install_requires = [],
64
67
  # entry_points = {
65
68
  # 'console_scripts' : ['mlatom=MLatom.MLatom:MLatomMainCls']
66
69
  # }
@@ -0,0 +1,130 @@
1
+ Metadata-Version: 2.1
2
+ Name: MLatom
3
+ Version: 1.2.3
4
+ Summary: A Package for Atomistic Simulations with Machine Learning
5
+ Home-page: http://mlatom.com
6
+ Author: Pavlo O. Dral
7
+ Author-email: admin@mlatom.com
8
+ License: CC BY-NC-ND 4.0
9
+ Description: # Brief Introduction
10
+ A Package for Atomistic Simulations with Machine Learning
11
+
12
+ **manual**: http://mlatom.com/manual/
13
+ **tutorial**: http://mlatom.com/tutorial/
14
+
15
+
16
+ # Tasks Performed by MLatom
17
+ A brief overview of MLatom capabilities. See sections below for more details.
18
+
19
+ ## Tasks
20
+ - Estimating accuracy of ML models.
21
+ - Creating ML model and saving it to a file.
22
+ - Loading existing ML model from a file and performing ML calculations with this model.
23
+ - ML-cross-section to boost the calculation of ML-NEA
24
+
25
+ ## Data Set Operations
26
+ - Converting XYZ coordinates into an input vector (molecular descriptor) for ML.
27
+ - Sampling subsets from a data set.
28
+
29
+
30
+ # Sampling
31
+ - none: simply splitting the data set into the training, test, and, if necessary, training set into the subtraining and validation sets (in this order) without changing the order of indices.
32
+ - random sampling.
33
+ - user-defined: requests MLatom to read indices for the training, test, and, if necessary, for the subtraining and validation sets from files.
34
+ - [ structure-based sampling ](http://mlatom.com/self-correcting-machine-learning-and-structure-based-sampling/)
35
+ - from unsliced and sliced data
36
+ - [ farthest-point traversal iterative procedure ](https://en.wikipedia.org/wiki/Farthest-first_traversal), which starts from two points farthest apart.
37
+
38
+
39
+ # ML Algorithm
40
+ [ Kernel ridge regression](https://web.stanford.edu/~hastie/ElemStatLearn/) with the following kernels:
41
+ - [ Gaussian ](https://doi.org/10.1103/PhysRevLett.108.058301).
42
+ - [ Laplacian ](https://doi.org/10.1103/PhysRevLett.108.058301).
43
+ - exponential.
44
+ - [ Matérn ](http://dx.doi.org/10.1198/jasa.2010.tm09420) ([ details of implementation ](http://dx.doi.org/10.1021/acs.jpclett.8b02469)).
45
+ Permutationally invariant kernel and self-correction are also supported.
46
+
47
+
48
+ # Hybrid QM/ML Approaches
49
+ [ Δ-machine learning ](http://dx.doi.org/10.1021/acs.jctc.5b00099).
50
+
51
+
52
+ # Molecular Descriptors
53
+ - [ Coulomb matrix ](https://doi.org/10.1103/PhysRevLett.108.058301)
54
+ - [ sorted by norms of its rows ](http://dx.doi.org/10.1021/ct400195d);
55
+ - unsorted;
56
+ - permuted.
57
+ - [ Normalized inverted internuclear distances ](http://mlatom.com/self-correcting-machine-learning-and-structure-based-sampling/)
58
+ - sorted for user-defined atoms by the sum of their nuclear repulsions to all other atoms;
59
+ - unsorted;
60
+ - permuted.
61
+
62
+
63
+ # The KREG model
64
+ Now we set [ KREG (Kernel-ridge-regression using RE descriptor and the Gaussian kernel function )](http://dx.doi.org/10.1021/acs.jpclett.8b02469) as default ML method. Default hyperparameter optimization options were updated to speed up the hyperparameter search for KREG.
65
+
66
+
67
+ # Model Validation
68
+ [ ML model can be validated (generalization error can be estimated) in several ways: ](https://web.stanford.edu/~hastie/ElemStatLearn/)
69
+
70
+ - on a hold-out test set not used for training. Both training and test sets can be sampled in one of the ways described above;
71
+ - by performing N-fold cross-validation. User can define the number of folds N. If N is equal to the number of data points, leave-one-out cross-validation is performed. Only random or no sampling can be used for cross-validation.
72
+ - by performing leave-one-out cross-validation (special case of N-fold cross-validation).
73
+ MLatom prints out mean absolute error (MAE), mean signed error (MSE), root-mean-squared error (RMSE), mean values of reference and estimated values, largest positive and negative outliers, correlation coefficient and its squared value R2 as well as coefficients of linear regression and corresponding standard deviations.
74
+
75
+
76
+ # Hyperparameter Tuning
77
+ Gaussian, Laplacian, and Matérn kernels have σ and λ tunable hyperparameters. MLatom can determine them by performing user-defined number of iterations of hyperparameter optimization on a logarithmic grid. User can adjust number of grid points, starting and finishing points on the grid. Hyperparameter are tuned to minimize either mean absolute error or root-mean-square error as defined by the user. [ Hyperparameters can be tuned to minimize ](https://web.stanford.edu/~hastie/ElemStatLearn/)
78
+
79
+ - the error of the ML model trained on the subtraining set in a hold-out validation set. Both subtraining and validation sets are parts of the training set, which can be used at the end with optimal parameters for training the final ML model. These sets ideally should not overlap and can be [ sampled ](http://mlatom.com/features/#Sampling) from the training set in one of the ways described above;
80
+ - N-fold cross-validation error. User can define the number of folds N. If N is equal to the number of data points, leave-one-out cross-validation is performed. Only random or no sampling can be used for cross-validation.
81
+
82
+ Note that hyperparameter tuning can be performed together with model validation. This means that for example one can perform outer loop of the cross-validation for model validation and tune hyperparameters via inner loop of the cross-validation.
83
+
84
+
85
+ # First Derivatives
86
+ MLatom can be also used to estimate first derivatives from an ML model. It can be useful, if an ML model has been created for energies, and one wants to estimate forces. Two scenarios are possible:
87
+
88
+ - partial derivatives are calculated for each dimension of given input vectors (analytical derivatives for Gaussian kernel, numerical derivatives for other kernels);
89
+ - first derivatives are calculated in XYZ coordinates for input files containing molecular XYZ coordinates (only numerical derivatives).
90
+
91
+
92
+ # Cross Section
93
+ MLatom can significantly accelerate the calculation of cross-section with the Nuclear Ensemble Approach (NEA).
94
+
95
+ In brief, this feature uses fewer QC calculation to achieve higher precision and reduce computational cost. You can find more detail on this paper (please cite it when using this feature:
96
+
97
+ > Bao-Xin Xue, Mario Barbatti*, Pavlo O. Dral*, [ Machine Learning for Absorption Cross Sections ](https://doi.org/10.1021/acs.jpca.0c05310), J. Phys. Chem. A 2020, 124, 7199–7210. DOI: 10.1021/acs.jpca.0c05310.
98
+ > [ Preprint on ChemRxiv ](https://doi.org/10.26434/chemrxiv.12594191), DOI: 10.26434/chemrxiv.12594191.
99
+
100
+ # About Program
101
+ MLatom: a Package for Atomistic Simulations with Machine Learning
102
+ Version 1.2
103
+ http://mlatom.com/
104
+
105
+ Copyright (c) 2013-2020 Pavlo O. Dral
106
+ http://dr-dral.com/
107
+
108
+ All rights reserved. No part of MLatom may be used, published or redistributed without written permission by Pavlo Dral.
109
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
110
+ The software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.
111
+
112
+ Cite as:
113
+ 1. Pavlo O. Dral, J. Comput. Chem. 2019, 40, 2339-2347
114
+ 2. Pavlo O. Dral, Bao-Xin Xue, Fuchun Ge, Yi-Fan Hou, MLatom: A Package for Atomistic Simulations with Machine Learning, version 1.2, Xiamen University, Xiamen, China, 2013-2020.
115
+
116
+
117
+ # License
118
+
119
+ This work is licensed under the [Attribution-NonCommercial-NoDerivatives 4.0 International](http://creativecommons.org/licenses/by-nc-nd/4.0/) license. See LICENSE.CC-BY-NC-ND-4.0.
120
+
121
+ <a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-nd/4.0/88x31.png" /></a>
122
+
123
+ Platform: UNKNOWN
124
+ Classifier: Programming Language :: Python :: 3
125
+ Classifier: Operating System :: POSIX :: Linux
126
+ Classifier: Programming Language :: Fortran
127
+ Classifier: Topic :: Scientific/Engineering :: Chemistry
128
+ Classifier: Environment :: Console
129
+ Requires-Python: >=3.7
130
+ Description-Content-Type: text/markdown
@@ -1,3 +1,4 @@
1
+ MLatomF
1
2
  README.md
2
3
  mlatom
3
4
  setup.py
MLatom-1.2.1/PKG-INFO DELETED
@@ -1,20 +0,0 @@
1
- Metadata-Version: 1.2
2
- Name: MLatom
3
- Version: 1.2.1
4
- Summary: A Package for Atomistic Simulations with Machine Learning
5
- Home-page: http://mlatom.com
6
- Author: Pavlo O. Dral
7
- Author-email: admin@mlatom.com
8
- License: UNKNOWN
9
- Description: # About MLatom
10
- A Package for Atomistic Simulations with Machine Learning
11
- This version 1.2 on pypi is a test uploaded version.
12
-
13
-
14
- Platform: UNKNOWN
15
- Classifier: Programming Language :: Python :: 3
16
- Classifier: Operating System :: POSIX :: Linux
17
- Classifier: Programming Language :: Fortran
18
- Classifier: Topic :: Scientific/Engineering :: Chemistry
19
- Classifier: Environment :: Console
20
- Requires-Python: >=3.6
MLatom-1.2.1/README.md DELETED
@@ -1,4 +0,0 @@
1
- # About MLatom
2
- A Package for Atomistic Simulations with Machine Learning
3
- This version 1.2 on pypi is a test uploaded version.
4
-
@@ -1,20 +0,0 @@
1
- Metadata-Version: 1.2
2
- Name: MLatom
3
- Version: 1.2.1
4
- Summary: A Package for Atomistic Simulations with Machine Learning
5
- Home-page: http://mlatom.com
6
- Author: Pavlo O. Dral
7
- Author-email: admin@mlatom.com
8
- License: UNKNOWN
9
- Description: # About MLatom
10
- A Package for Atomistic Simulations with Machine Learning
11
- This version 1.2 on pypi is a test uploaded version.
12
-
13
-
14
- Platform: UNKNOWN
15
- Classifier: Programming Language :: Python :: 3
16
- Classifier: Operating System :: POSIX :: Linux
17
- Classifier: Programming Language :: Fortran
18
- Classifier: Topic :: Scientific/Engineering :: Chemistry
19
- Classifier: Environment :: Console
20
- Requires-Python: >=3.6
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes