API#

This page gives an overview of all public SynPlanner objects, functions and methods. All classes and functions exposed in synplan.* namespace are public.

The following subpackages are public.

  • synplan.chem: The module for curation (standardization and filtration) of reaction and molecular data.

  • synplan.interfaces: Functions for building interfaces, currently command line interface added. For the graphical user interface, see the HuggingFace repository.

  • synplan.mcts: Functions and classes responsible for Monte-Carlo Tree Search.

  • synplan.ml: Functions that are used to train policy and value networks.

  • synplan.route_quality: Post-search route analysis for competing functional group detection, incompatibility scoring, and route re-ranking based on selectivity issues. Inspired by Westerlund et al., ChemRxiv, 2025 (doi:10.26434/chemrxiv-2025-gdrr8).

  • synplan.utils: Functions used for configuring SynPlanner, loading all the data, logging and visualisation of synthetic routes.

What this section is for#

This is the reference for the Python API (functions and classes). Use it when you are scripting SynPlanner in Python, writing integrations, or need detailed signatures. If you are looking for how to run CLI commands or configure YAML, see Command-line interface and Configuration.

On this page