FairNMR500 / evaluation /README.md
Huggggooo's picture
Release FairNMR500 v1.0.0
e4bcd5b verified
|
Raw History Blame Contribute Delete
2.25 kB
# FairNMR500 evaluation
Requires Python 3.10+ and RDKit. From the repository root:
```bash
python -m pip install -r requirements.txt
python evaluation/metric.py --predictions predictions.jsonl --output metrics.json
```
Prepare one JSON object per line, using the released sample `id` and an ordered
list of predicted SMILES:
```json
{"id": "fairnmr500_000", "smiles": ["CCO", "CCCO"]}
{"id": "fairnmr500_001", "smiles": []}
```
These two rows illustrate the format, not benchmark predictions. Empty lists,
omitted samples, empty strings, and invalid SMILES count as misses. Invalid and
duplicate SMILES retain their original candidate positions; candidates are not
deduplicated or promoted. Duplicate IDs, unknown IDs, malformed JSON, and
non-string candidates are rejected as input errors. Prediction order across
rows does not matter; candidate order within each row does.
The script reports `correct@1`, `correct@10`, `hit@1`, and `hit@10`. The hit rates
are fractions between 0 and 1. The denominator is the full reference file
(500 examples for this release), including samples without predictions.
## Molecular comparison
The rank matcher follows Section 5.1 of the
[SpecXMaster Technical Report, v5](https://arxiv.org/html/2603.23101v5#S5.SS1):
- Parse SMILES with RDKit, remove atom maps and explicit hydrogens, and produce
canonical isomeric representations.
- Ignore the configuration of a single tetrahedral stereocenter.
- For multiple tetrahedral stereocenters, equate full-inversion enantiomers and
preserve relative stereochemistry; partial inversion is not generally equal.
- Normalize unspecified stereogenic double bonds to E, while retaining explicit
E/Z labels except for the original matcher's nitrogen-associated patterns.
The exact implemented pattern is a double-bond endpoint that is nitrogen, or
nitrogen directly attached to either endpoint.
- Require all other connectivity to match exactly. Empty/invalid SMILES have no
comparison key and cannot match a valid reference.
The evaluation equivalences do not change the GT stored in the dataset. The
script uses no internal services, model weights, or inference-project modules.
Dependencies are pinned to the RDKit version used in release validation.