From a855511b842895e269a17264cd67498f3013a8b2 Mon Sep 17 00:00:00 2001 From: Krzysztof Maziarz Date: Tue, 5 Sep 2023 13:29:22 +0000 Subject: [PATCH] doc(cli): Add docstring --- syntheseus/cli/search.py | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/syntheseus/cli/search.py b/syntheseus/cli/search.py index c3bb3bab..ad057c1c 100644 --- a/syntheseus/cli/search.py +++ b/syntheseus/cli/search.py @@ -1,3 +1,17 @@ +"""Script for running end-to-end retrosynthetic search. + +The supported single-step model types are listed in `syntheseus/reaction_prediction/cli/eval.py`; +each can be combined with either MCTS or Retro* to perform search. + +Example invocation: + python ./syntheseus/cli/search.py \ + inventory_smiles_file=[INVENTORY_SMILES_FILE_PATH] \ + search_target="NC1=Nc2ccc(F)cc2C2CCCC12" \ + model_class=LocalRetro \ + model_dir=[MODEL_DIR] \ + time_limit_s=60 +""" + from __future__ import annotations import datetime