rxn-metrics 1.1.0

Metrics for RXN models

RXN package for the calculation of metrics for OpenNMT-based models

This repository contains a Python package and associated scripts for training reaction models based on the OpenNMT library. This repository is closely related to rxn-onmt-models, which handles the training pipelines for these models. The repository also relies on other RXN packages; see rxn-utilities, rxn-chemutils, and rxn-onmt-utils.

Links:

• GitHub repository
• Documentation
• PyPI package

This repository was produced through a collaborative project involving IBM Research Europe and Syngenta.

System Requirements

This package is supported on all operating systems. It has been tested on the following systems:

• macOS: Big Sur (11.1)
• Linux: Ubuntu 18.04.4

A Python version of 3.6, 3.7, or 3.8 is recommended. Python versions 3.9 and above are not expe`cted to work due to compatibility with the selected version of OpenNMT.

Installation guide

The package can be installed from Pypi:

pip install rxn-metrics[rdkit,rxnmapper]

You can leave out the extra dependency rdkit if RDKit is already available in your environment. Also, you can leave out the extra dependency rxnmapper if you don't plan on calculating the "true reactant" accuracy.

For local development, the package can be installed with:

pip install -e ".[dev,rdkit,rxnmapper]"

Calculation of metrics

The metrics are best calculated by launching one of the following scripts:

• rxn-prepare-context-metrics
• rxn-prepare-forward-metrics
• rxn-prepare-retro-metrics Note that these scripts will run the models directly to limit the likelihood of making errors.

If the prediction files are available already, the script rxn-evaluate-metrics will compute the metrics only.

To aggregate all the metrics for different models (typically: after tuning the hyperparameters), you can run the script rxn-parse-metrics-into-csv.