Jump to content

NEEMP:Modes

From WebChemistry Wiki

NEEMP features three modes: calculation, parametrization and validation. Each mode can be selected specifying one of the following keywords after the option --mode or -m:

Calculation mode : charges (calculate EEM charges)

Parametrization mode : params (calculate EEM parameters)

Validation mode : cover (display how many molecules are covered by the given parameters set) and cross (perform EEM parameters quality assay)

NB: NEEMP provides an additional functionality (-m info or --mode info) which displays information about the training set provided as argument to the --sdf-file option. Specifically, number of molecules, the total number of atoms and number of atoms for each type are printed; the latter being defined by default as the chemical element and the maximal bond order. To override this behaviour in all NEEMP's modes and group the atoms only by chemical element, use the option --atom-types-by Element (for details on the syntax, see the examples or option list paragraph).

Calculation mode

Figure 1: The percentage of covered molecules in the set is extremely low because of the absence of parameters for C1. All the molecules containing this atom types are automatically discarded.

To compute EEM charges with NEEMP, it is necessary to provide the SDF file with molecules for which the charges will be computed (option --sdf-file) and the PAR file with EEM parameters (option --par-file). EEM charges will be written into the file specified by --chg-out-file option.

The user should keep in mind that, because of the EEM method itself, the EEM charges cannot be computed for elements or element types for which the parameters are missing. This situation is well depicted by Figure 1, where a modified version of the parameters set examples/ElemBond.par lacking the parameters for C1 (carbon presenting only single bonds), has been employed to compute the EEM charges for the set examples/set01.sdf (for details on the syntax, see the examples or option list section).

Parametrization mode

This mode serves for calculation of EEM parameters. Three main components make up the input for this mode:

  • a training set of molecules (argument of --sdf-file option)
  • a set of QM charges for each molecule in the sdf file (argument of --chg-file option)
  • the specification of the parametrization approach (by -p or --params-method) and its specific options.

Linear Regression (LR)

LR (--params-method lr-full or -p lr-full) is the default parametrization approach in NEEMP, since its application in the parametrization process is well documented and described in literature ( maybe add a reference ). The main extension in respect to previous version is the ability for the user to define by which metrics the best performing parameter set will be selected (see figure):

-s R2 or --sort-by R2 to select the parameter set with the highest squared Pearson coefficient (R2)
-s RMSD or --sort-by RMSD to select the parameter set with the lowest atom type root mean square difference (avg(RMSD))
Figure 2: Detailed view of the LR parametrization settings for two distinct NEEMP executions differing in the best-performance selection metrics (R2 in left side image and RMSD in the right side image).

Additionally, the quality of the parameter set may benefit from the usage of a discarding procedure (-d simple or --discard simple). In fact it has been proved that using a subset of the original training set often leads to EEM charges that better agree with the reference QM charges ( maybe add a reference also if any). For useful examples on the LR parametrization approach and the discarding procedure see respectively 5/6 and 7. In particular the latter introduces the --limit-iters and --limit-time options, which modulate the behaviour of the discarding procedure, setting respectively an upper bound in the number of iterations and/or in the execution time.

Guided Minimization (GM)

In parallel we developed an advanced EEM parametrization approach specifically tailored to cope with heterogeneous data, which in the past presented quite a challenge in the EEM parametrization framework. It consists in the combination of a global minimization method (simple guidance) with a local minimization technique (NEWUOA, maybe add a reference ), hence the name Guided Minimization. To call this approach in NEEMP use the option --params-method gm or -p gm.

Figure 3: Abridged GM approach output for structures file examples/set01.sdf and charge file examples/charges.chg. In the upper block are displayed the specifics for the gm parametrization procedure. Note as the bottom block presents the same structure as for other parametrization approaches and options.

The behaviour of the GM approach can be modulated by several options, but to make life easier we provide the user with reasonable default values that have been tuned to output optimal parameter set (for a complete view of the options refer to the option list and the examples section).

NB: the default quality evaluating metrics for GM approach is the average RMSD, but this behaviour can be overridden using the --sort-by option as in the LR method.

Validation mode

This mode allows us to perform two types of EEM parameter set validation - coverage validation and quality validation.

Coverage validation

Figure 4: Percentage of molecules in set examples/set02.sdf covered by the displayed parameters set examples/Element.par

To see how many molecules from the set are covered by the provided parameters, simply pass NEEMP those two files (options --sdf-file and --par-file). Figure 4 shows a close-up from the cover mode output for set02.sdf and the parameters set Element.par, both present in the examples directory (for details on the syntax and the complete output, see the examples or option list paragraph)

Quality validation

To assess the quality of the EEM parameters on a different set than one they were based on, NEEMP's cross mode can be used.

Required input files are: EEM parameters (passed as argument of option --par-file) and a new set of molecular structures (argument of --sdf-file) for which ab-initio charges have been computed (argument of --chg-file).

For details on the syntax and additional output, see the examples or option list section.

Figure 5: Cross mode output for structures file examples/set02.sdf, charge file examples/charges.chg and parameters set examples/Element.par . Note the block at the bottom where the statistics descriptors for the whole set and for each chemical element are displayed.