2023.04 Release Notes

NOTE: Docker has announced the general availability of Compose v2 and also marked v1 as deprecated, with an end of life (EOL) of April 2023. All new downloads and support documentation will now refer to v2. The new Compose v2 has been integrated into docker and is called directly from docker, ie docker compose, rather than via a seperate docker-compose binary. In practice the dash has been replaced with a space. This change will impact future ASKCOS deployments so we recommend that you upgrade your docker installs as soon as possible

askcos-site

User notes:

• Make IPP Compatiable with Template free model (MR askcos-site!167)
  • Modified the requestRetro function and other tree rendering functions to accommodate for template-free model
• Add model and training set selector (MR askcos-site!168)
  • Added model and training set selector in the settings menu.
• Add edit and cancel change button in note (MR askcos-site!170)
  • Added edit note and cancel change button in IPP notes.
  • More User initiative to edit a note and cancel a change.
• Add Strategy Planning to IPP (MR askcos-site!171)
  • New feature to select multiple models using strategy planning.
  • The model selected can be template-based or template-free
• Implementing parallelization of the request done to ASKCOS API via promises (MR askcos-site!175)
  • As multiple strategies can be submitted, the time taken increased. This change enabled:
    • Parallelization of all the API calls.
    • Precursors will not get added to the graph if any of the requests fail resulting in incomplete graphs!
• Prettier code formatter setting default (MR askcos-site!177)
• Display model name used for prediction in reaction node (MR askcos-site!178)
  • Display the name of the model used to predict the precursor inside the reaction node
• Strategy based Tree Builder (MR askcos-site!180)
  • A new tree builder modal was developed to submit only template based model tasks.
  • Settings such as template prioritizer, template count and maximum cum prob are automatically passed to the MC Tree Builder.
• Improved Alert and Confirm Message Box (MR askcos-site!182)
  • Standardizing message boxes across all of ASKCOS.
• Accordion in Setting Menu (MR askcos-site!183)
  • Added support for collapsible tab in the setting menu for a better user experience
• Count analog single pathway (MR askcos-site!184)
  • Addition of count analogs for single pathways in the Tree Explorer.
  • The ASKCOS API Tree Analysis endpoint was also updated with an optional index field for the single tree analysis.
  • The sorting method disable function is also changed to check for all the trees in the list of trees to detect if the num_analog field is present or not.
• PMI Calculation for Single Pathway (MR askcos-site!185)
  • Addition of PMI Calculation for single pathway in the Tree Explorer

Bug fixes:

• Multiple Nodes displayed in the same precursor (MR askcos-site!173)
  • The ASKCOS backend returns smiles_split for template based models but not for template free models. This split for template free models is now performed in the frontend.
• Fixing for addition of new precursor (MR askcos-site!181)
  • With new fields in the DataGraph, when a new precursor is added, the model field is empty. Now, the model field is prepopulating for explicitly added precursors.

askcos-deploy

Updated ymls according to newest openretro (MR askcos-deploy!125)

Docker Compose Deployment

We currently support two methods for deploying ASKCOS: Docker Compose and Kubernetes. Docker Compose is a simpler method for deploying on a single workstation, while Kubernetes is more complex but is suitable for scaling across multiple nodes.

Hardware Requirements

To deploy ASKCOS with the default number of workers, we recommend using a server with at least 16 CPU cores and 64 GB memory. The default configuration uses approximately 45 GB memory at deploy, but usage will increase while running some compute tasks. ASKCOS is not currently set up to use GPUs for machine learning predictions.

For deployment on AWS, this corresponds to an m5.4xlarge instance or similar. (Note that ASKCOS does not work on ARM-based instances.)

For deployment on Google Cloud, this corresponds to an e2-standard-16 instance or similar.

If you plan to increase worker scales, you should increase hardware resources accordingly.

Finally, you should provision at least 80 GB of drive space for a basic deployment. More disk space is recommended for long-term deployments to store user data and support updates and custom models and data.

Software Prerequisites

To deploy ASKCOS using Docker Compose, you must have the following installed on your machine:

• git
• Docker (installation instructions)

Quickstart

ASKCOS can be downloaded using deploy tokens, which provide read-only access to the source code and our container registry in GitLab. Below is a complete example showing how to deploy the ASKCOS application using deploy tokens (omitted in this example). The deploy tokens can be found on the MLPDS Member Resources ASKCOS Versions Page.

$ export DEPLOY_TOKEN_USERNAME=
$ export DEPLOY_TOKEN_PASSWORD=
$ docker login registry.gitlab.com -u $DEPLOY_TOKEN_USERNAME -p $DEPLOY_TOKEN_PASSWORD
$ git clone https://$DEPLOY_TOKEN_USERNAME:$DEPLOY_TOKEN_PASSWORD@gitlab.com/mlpds_mit/askcos/askcos-deploy.git
$ cd askcos-deploy
$ git checkout 2023.04
$ bash deploy.sh deploy -v 2023.04

Upgrade Information

The askcos-deploy repository also provides scripts to upgrade an existing ASKCOS deployment in-place.

$ cd askcos-deploy
$ git fetch origin
$ git checkout 2023.04
$ bash deploy.sh update -v 2023.04

Some releases include changes or additions which require further action. Depending on the version you are upgrading from, you may need to perform one or more of the following steps.

Notes from earlier releases

The 2022.04 release includes a new WLN forward prediction model trained on Pistachio 2021Q3. This model should be deployed automatically if you go through the update process.

In addition, we identified some changes to SMILES canonicalization resulting from updates to the RDKit version used by ASKCOS in previous releases. The changes affect a very small fraction of documents in the ASKCOS buyables and chemical historian databases. More information on the effects and fixes can be found in the Note on SMILES canonicalization in the release highlights.

The 2022.01 release includes reaction precedent data for the CAS template relevance model. This data is necessary to use the new CAS SciFinderⁿ integration. The data can be imported into MongoDB using the following command:

$ bash deploy.sh seed-db -x cas

!> Note: For on-premise deployments, you will need to register redirect URL's with CAS before the SciFinder integration will work properly. For example, the redirect URL registered for the demo site is https://askcos-demo.mit.edu/*. Please contact us or your CAS representative directly to begin a request.

Another major new feature in 2022.01 is the experimental C++ tree builder, which uses a reinforcement learning model and is highly optimized for computational speed. Due to high resource requirements, the C++ tree builder is not deployed by default. For more details and deployment info, please see the C++ tree builder deployment documentation.

The 2021.10 release includes two new template relevance models: one trained on enzymatic reactions from BKMS, and one trained on ring-breaking reactions from Pistachio. In order to use the new models, the associated data will need to be imported into MongoDB:

$ bash deploy.sh seed-db -r bkms -c bkms -x bkms
$ bash deploy.sh seed-db -r ringbreaker

Note that the deploy.sh script has been updated to change the default behavior for seed-db to append new data. To drop all existing data (the previous behavior), you can pass the --drop argument.

The 2021.07 release includes a new template relevance model trained on a SciFinder/CAS template set. In order to use the new model, you will need to import the reaction templates into MongoDB:

$ bash deploy.sh seed-db -r cas --append

!>Please note that chemical historian data is not included for the CAS model at this time, so chemical popularity information will not be available for tree builder jobs using the CAS model.

The 2021.07 also introduces a model serving configuration file, located at askcos-deploy/model_config.yaml. Models deployed using Tensorflow Serving or Torchserve must be added to the configuration file to provide connection parameters to ASKCOS. Any existing custom models should be added to ensure they work after updating.

The 2023.04 release includes a new template relevance model trained on a Reaxys Enzymatic template set. In order to use the new model, you will need to import the reaction templates into MongoDB:

$ bash deploy.sh seed-db -r reaxys_enzymatic

First Time Deployment

Deploying the Web Application

Deployment is initiated by a bash script that runs a few docker-compose commands in a specific order. Several database services need to be started first, and more importantly seeded with data, before other services (which rely on the availability of data in the database) can start. The deploy.sh script is provided in the askcos-deploy repository and should be run as follows:

$ bash deploy.sh command [optional arguments]

For a full list of available commands and options, use the help command.

There are a number of available commands for common deploy tasks:

• deploy: runs standard first-time deployment tasks, including seed-db
• update: pulls new docker image from GitLab repository and restarts all services
• seed-db: seed the database with default or custom data files
• start: start a deployment without performing first-time tasks
• stop: stop a running deployment
• clean: stop a running deployment and remove all docker containers and volumes

For a running deployment, new data can be seeded into the database using the seed-db command along with arguments indicating the types of data to be seeded. Note that this will replace the existing data in the database. The available arguments are as follows:

• -b, --buyables: specify buyables data to seed, either default or path to data file
• -c, --chemicals: specify chemicals data to seed, either default or path to data file
• -x, --reactions: specify reactions data to seed, either default or path to data file
• -r, --retro-templates: specify retrosynthetic templates to seed, either default or path to data file
• -f, --forward-templates: specify forward templates to seed, either default or path to data file
• -e, --references: specify model reference data to seed, only supports default currently

For example, to seed default buyables data and custom retrosynthetic pathways, run the following from the deploy folder:

$ bash deploy.sh seed-db --buyables default --retro-templates /path/to/my.retro.templates.json.gz

To update a deployment, run the following from the deploy folder:

$ bash deploy.sh update --version x.y.z

To stop a currently running application, run the following from the deploy folder:

$ bash deploy.sh stop

If you would like to clean up and remove everything from a previous deployment (NOTE: you will lose user data), run the following from the deploy folder:

$ bash deploy.sh clean

Backing Up User Data

If you are upgrading from v0.3.1 or later, the backup/restore process is no longer needed unless you are moving deployments to a new machine.

New backup and restore functions were added in askcos-deploy 2020.07 to provide more robust backup/restore capabilities based on Docker volumes. The commands can be used whether the site is running or not; the only requirement is that the mongo_data and mysql_data Docker volumes exist.

To backup:

bash deploy.sh backup [-d /absolute/path/to/backup/dir]

To restore:

bash deploy.sh restore [-d /absolute/path/to/backup/dir]

!>Note: These backup and restore processes are run in a bare alpine linux image which will be automatically pulled by Docker.

Add Customization

There are a few parts of the application that you can customize:

• Header sub-title next to ASKCOS (to designate this as a local deployment at your organization)
• Email addresses for the support form
• Whether to enable the chemical name to SMILES resolver
• Whether authorization is required to modify the buyables database
• Add internal URL to a Pistachio web app deployment to enable direct links

These are handled as an environment variables that can change upon deployment (and are therefore not tied into the image directly). This can be found in the customization file, which is created automatically during deployment from the customization.example file.

In addition, the following methods enable more substantial customizations to the ASKCOS website without rebuilding the askcos-site image:

• Customization of Django site settings
  • Include customizations in the askcos-deploy/custom_django_settings.py file which is mounted to /usr/local/askcos-site/askcos_site/custom_settings.py in the app container
• Customization of web frontend
  • Include custom script or css tags in a custom_head.html Django template file which is mounted to /usr/local/askcos-site/askcos_site/templates/custom_head.html and included in the <head> section of every page

Please let us know what other degrees of customization you would like.

Managing Django

If you'd like to manage the Django app (i.e. - run python manage.py ...), for example, to create an admin superuser, you can run commands in the running app service as follows:

$ docker-compose exec app bash -c "python /usr/local/askcos-site/manage.py createsuperuser"

In this case you'll be presented an interactive prompt to create a superuser with your desired credentials.

Scaling Workers

Only 1 worker per queue is deployed by default with limited concurrency. This is not ideal for many-user demand. The scaling of each worker is defined at the top of the deploy.sh script. To scale a desired worker, change the appropriate value in deploy.sh, for example:

n_tb_c_worker=N          # Tree builder chiral worker

where N is the number of workers you want. Then run bash deploy.sh start [-v <version>].

Kubernetes Deployment

ASKCOS 2022.07 includes a Helm chart to make it easier to deploy ASKCOS on Kubernetes. The previous Kubernetes configuration can still be used for 2020.07 or earlier but will no longer be updated.

Hardware Requirements

To deploy ASKCOS with the default number of workers, we recommend using a server with at least 16 CPU cores and 64 GB memory combined across nodes, and individual nodes with at least 16 GB memory. The default configuration uses approximately 45 GB memory total at deploy, with the most resource intensive worker needing about 14 GB, but usage will increase while running some compute tasks. ASKCOS is not currently set up to use GPUs for machine learning predictions.

For deployment on AWS, this corresponds to one m5.4xlarge instance or two m5.2xlarge instances. (Note that ASKCOS does not work on ARM-based instances.)

For deployment on Google Cloud, this corresponds to an e2-standard-16 instance or two e2-standard-8 instances.

If you plan to increase worker scales, you should increase hardware resources accordingly.

Software Prerequisites

In addition to git and Docker, we will assume that you are using a cluster which already has Kubernetes configured. You will also need to install Helm 3: https://helm.sh/docs/intro/install/.

Quickstart

Similar to the Docker Compose deployment, you will need to obtain the ASKCOS deploy tokens in order to clone the askcos-deploy repository and access the GitLab image registry. The deploy tokens can be found on the MLPDS Member Resources ASKCOS Versions Page.

$ export DEPLOY_TOKEN_USERNAME=
$ export DEPLOY_TOKEN_PASSWORD=
$ git clone https://$DEPLOY_TOKEN_USERNAME:$DEPLOY_TOKEN_PASSWORD@gitlab.com/mlpds_mit/askcos/askcos-deploy.git
$ cd askcos-deploy
$ git checkout 2023.04
$ helm install --set imageCredentials.username=$DEPLOY_TOKEN_USERNAME --set imageCredentials.password=$$DEPLOY_TOKEN_PASSWORD mydeploy ./helm/askcos

For more configuration options, please check out the values file at askcos-deploy/helm/askcos/values.yaml.

Add Customization

For Kubernetes, the same customizations can be applied as for the Docker Compose deployment:

• Header sub-title next to ASKCOS (to designate this as a local deployment at your organization)
• Email addresses for the support form
• Whether to enable the chemical name to SMILES resolver
• Whether authorization is required to modify the buyables database.
• Add internal URL to a Pistachio web app deployment to enable direct links

The environment variables for these customizations can be adjusted in the env block of the values.yaml file.

Managing Django

If you'd like to manage the Django app (i.e. - run python manage.py ...), for example, to create an admin superuser, you can run commands in the running app container as follows:

$ kubectl exec [ASKCOS POD] -c app -i -t -- python /usr/local/askcos-site/manage.py createsuperuser

In this case you'll be presented an interactive prompt to create a superuser with your desired credentials.

Scaling Workers

For Kubernetes, worker replicas can also be set in the values.yaml file. Celery workers are defined in the celery block as a list, and each item has a replicaCount field for for setting the number of replicas.

(Optional) Building Docker Images

If you would like to build the askcos-site Docker image yourself, you will need to download the appropriate repositories depending on where you want to start.

To only build askcos-site using a pre-built askcos-core image:

$ git clone https://gitlab.com/mlpds_mit/askcos/askcos-site
$ cd askcos-site
$ make [TAG=my_tag]

A Makefile is provided to make it easier to build the image with a default image name. You can also use the docker build command directly:

$ docker build -t <image name>:<tag> .

!>Note: The image name should correspond with what exists in the docker-compose.yml file. By default, the image name is environment variable ASKCOS_IMAGE_REGISTRY + askcos-site. If you choose to use a custom image name, make sure to modify the ASKCOS_IMAGE_REGISTRY variable or the docker-compose.yml file accordingly. For Kubernetes deployment, the image registry and tag are defined in the values.yaml file.

Similarly, if you also want to build askcos-core:

$ git clone https://gitlab.com/mlpds_mit/askcos/askcos-core
$ cd askcos-core
$ make [TAG=my_tag]

Note that you will need to specify the appropriate askcos-core version when building askcos-site afterwards:

$ cd askcos-core
$ make TAG=my_tag
$ cd ../askcos-site
$ make CORE_VERSION=my_tag TAG=my_tag

ASKCOS Development

Software package for the prediction of feasible synthetic routes towards a desired compound and associated tasks related to synthesis planning. Originally developed under the DARPA Make-It program and now being developed under the MLPDS Consortium.