Metadata-Version: 2.4
Name: retrochimera
Version: 1.1.0
Summary: Frontier retrosynthesis prediction model
Author: Krzysztof Maziarz, Guoqing Liu, Marwin Segler
License:     MIT License
        
            Copyright (c) Microsoft Corporation.
        
            Permission is hereby granted, free of charge, to any person obtaining a copy
            of this software and associated documentation files (the "Software"), to deal
            in the Software without restriction, including without limitation the rights
            to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
            copies of the Software, and to permit persons to whom the Software is
            furnished to do so, subject to the following conditions:
        
            The above copyright notice and this permission notice shall be included in all
            copies or substantial portions of the Software.
        
            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
        
Project-URL: Repository, https://github.com/microsoft/retrochimera
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: h5py
Requires-Dist: joblib
Requires-Dist: more_itertools
Requires-Dist: omegaconf
Requires-Dist: protobuf==5.29.3
Requires-Dist: pydantic~=2.0
Requires-Dist: pyopenssl>=23.0.0
Requires-Dist: scikit-learn
Requires-Dist: syntheseus>=0.7.1
Requires-Dist: syntheseus-root-aligned==0.2.0
Requires-Dist: tensorboard==2.12.0
Requires-Dist: tqdm
Requires-Dist: wandb==0.17.7
Provides-Extra: dev
Requires-Dist: coverage; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Provides-Extra: graphium
Requires-Dist: syntheseus-graphium==0.1.0; extra == "graphium"
Provides-Extra: all
Requires-Dist: retrochimera[dev,graphium]; extra == "all"
Dynamic: license-file

<div align="center">

# RetroChimera

<p align="center">
  Backed by <a href="https://github.com/microsoft/syntheseus">Syntheseus</a> •
  <a href="https://arxiv.org/abs/2412.05269">Paper</a>
</p>

[![CI](https://github.com/microsoft/retrochimera/actions/workflows/ci.yml/badge.svg)](https://github.com/microsoft/retrochimera/actions/workflows/ci.yml)
[![Python Version](https://img.shields.io/badge/python-3.9-blue.svg)](https://www.python.org/downloads/)
[![pypi](https://img.shields.io/pypi/v/retrochimera.svg)](https://pypi.org/project/retrochimera/)
[![code style](https://img.shields.io/badge/code%20style-black-202020.svg)](https://github.com/ambv/black)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/microsoft/retrochimera/blob/main/LICENSE)

</div>

#

RetroChimera is a frontier retrosynthesis model, built upon ensembling two novel components with complementary inductive biases.
It outperforms existing models by a large margin, can learn from a very small number of examples per reaction class, and is preferred by industrial organic chemists over the reactions it was trained on in blind tests.

## Using RetroChimera

To install `retrochimera` locally, run

```bash
conda env create -f environment.yml
conda activate retrochimera

pip install retrochimera
```

then you can run inference via

```python
from retrochimera import RetroChimeraModel
from syntheseus import Molecule

model = RetroChimeraModel(model_dir="/model/checkpoint/dir/")
mol = Molecule("Oc1ccc(OCc2ccccc2)c(Br)c1")

predictions = model([mol], num_results=3)

for p in predictions[0]:
    print(p, f"({100. * p.metadata['probability']:.2f}%)")
```

For installation, there are two additional dependency groups: `dev` for running tests, and `graphium` for building the model architecture we used for USPTO-50K; if you care about running the USPTO-50K checkpoint, you need to install via `pip install retrochimera[graphium]`.

If you want to train your own checkpoint, please follow the instructions in [`retrochimera/README.md`](retrochimera/README.md).

## Checkpoints for RetroChimera 1

The main (and most powerful) checkpoint we release is trained on [Pistachio](https://figshare.com/ndownloader/files/59468882).
For benchmarking, we also provide (weaker) checkpoints trained on [USPTO-50K](https://figshare.com/ndownloader/files/59511926) and [USPTO-FULL](https://figshare.com/ndownloader/files/59494598).

If you care about reproducing the USPTO-* results from our paper _exactly_, make sure to use the inference hyperparameters listed in Extended Data Tables 3 and 4.
By default, these parameters are set to values optimal for the Pistachio checkpoint.

> [!WARNING]
> RetroChimera 1 is being released for research and experimentation - we hope you try to break it in any way possible and share the results back to us. As any ML model it is **not free from errors and may hallucinate**, in particular when used for inputs out of the training distribution. We look forward to collaborating with the community so we can improve the model for everyone!
>
> Before using any of the predictions in a real-world setting, they **must be risk-assessed and verified independently by chemistry experts**.
> In particular, **reactions ranked lower in the output list are increasingly likely to be hallucinations**;
> we recommend requesting no more than 5-10 reactions per input unless paired with stringent filtering (see e.g. [[1]](https://www.nature.com/articles/nature25978)[[2]](https://pubs.acs.org/doi/10.1021/acs.accounts.5c00155))
>
> If you find that RetroChimera 1 doesn't work on your favourite drug-like molecule, please let us know at retrochimera@microsoft.com, so we can make sure we improve this in the next model version.

## Citation

If you use RetroChimera in your work, please consider citing our
[arXiv preprint](https://arxiv.org/abs/2412.05269)
(bibtex below).

```
@article{maziarz2025chemist,
  title={Chemist-aligned retrosynthesis by ensembling diverse inductive bias models},
  author={Maziarz, Krzysztof and Liu, Guoqing and Misztela, Hubert and Tripp, Austin and Li, Junren and Kornev, Aleksei and Gai{\'n}ski, Piotr and Hoefling, Holger and Fortunato, Mike and Gupta, Rishi and Segler, Marwin},
  journal={arXiv preprint arXiv:2412.05269},
  year={2025}
}
```

## Contributing

This project welcomes contributions and suggestions.  Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

## Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft 
trademarks or logos is subject to and must follow 
[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
Any use of third-party trademarks or logos are subject to those third-party's policies.
