openadmet/microsomal-clearance-chemeleon-baseline

This is a baseline model trained on publicly available data. While we've done our best to curate the data, the model performance is quite poor. Proceed with caution.

This is our baseline microsomal clearance model. It is a multitask CheMeleon model trained on liver microsome data curated from ChEMBL.

We curated intrinsic clearance data (CLint) from three species: human (human liver microsome, or HLM), rat (rat liver microsome or RLM), and mouse (mouse liver microsome, or MLM). During training of this model, all CLint values were scaled to in vivo clearance. To ensure accurate training and predictions, be sure to check whether or not your CLint values are for in vivo or in vitro clearance. See this blog post for further details on the intricacies of microsomal clearance data.

Getting Started

<<<<<<< Updated upstream

We highly recommend you have the Anvil framework from openadmet-models installed in an environment (called openadmet-models) for ease of use and full utilization of OpenADMET's models. For full documentation, visit our website here. If you'd like to see some more examples on how to use Anvil, see our demos here.

Option A: Downloading & running the model with Github

=======

Pre-requisites

IMPORTANT NOTE You will need git lfs installed.

Downloading the model

1. Clone the model repo:

git clone https://huggingface.co/openadmet/microsomal-clearance-chemeleon-baseline/

2. Change to the repo directory. Ensure you have git lfs installed for the repo and get the large model files:

git lfs install
git lfs pull

Option A: Running the model locally

We highly recommend you have the Anvil framework from openadmet-models installed in an environment (called openadmet-models) for ease of use and full utilization of OpenADMET's models. The installation instructions can be found here and also below:

Stashed changes

1. You can install openadmet-models via our GitHub package. If you want the latest development version, clone the repository and install in editable mode:

git clone git@github.com:OpenADMET/openadmet-models.git

2. Set up an environment using the provided files in devtools/conda-envs.

cd openadmet-models/
conda env create -f devtools/conda-envs/openadmet-models.yaml
conda activate openadmet-models
pip install -e .

3. If you want to use GPU acceleration, ensure you have the appropriate CUDA toolkit installed and use the openadmet-models-cuda.yaml file instead:

conda env create -f devtools/conda-envs/openadmet-models-gpu.yaml
conda activate openadmet-models
pip install -e .

<<<<<<< Updated upstream 4. IMPORTANT NOTE You will also need git lfs installed.

5. After installing Anvil, clone the model repo:

git clone https://huggingface.co/openadmet/microsomal-clearance-chemeleon-baseline/

6. Change to the repo directory. Ensure you have git lfs installed for the repo and get the large model files:

git lfs install
git lfs pull

7. You are now ready to use the model!

Option B: Downloading & running the model with Docker

Alternatively, you can also use Docker to spin up a containerized pre-installed environment to run openadmet-models. Just be sure you are mounting the correct folder (./microsomal-clearance-chemeleon-baseline) where you've downloaded the model.

If you're using a gpu, run:

Option B: Running the model with Docker

1. Alternatively, you can also use Docker to spin up a containerized pre-installed environment to run openadmet-models. Just be sure you are mounting the correct folder (./microsomal-clearance-chemeleon-baseline) where you've downloaded the model.
2. For CPU only, run:

docker run -it --user=root --rm  \
    -v ./microsomal-clearance-chemeleon-baseline:/home/mambauser/model:rw \
    all ghcr.io/openadmet/openadmet-models:main 

3. For GPU, run:

   Stashed changes

docker run -it --user=root --rm  \
    -v ./microsomal-clearance-chemeleon-baseline:/home/mambauser/model:rw \
    --runtime=nvidia 
    --gpus 
    all ghcr.io/openadmet/openadmet-models:main 

<<<<<<< Updated upstream Otherwise, for cpu only: docker run -it --user=root --rm \ -v ./microsomal-clearance-chemeleon-baseline:/home/mambauser/model:rw \ all ghcr.io/openadmet/openadmet-models:main

Stashed changes

Using the model

NOTE This model predicts ${\log }_{10}(C{L}_{int})\backslash log\_\{10\}(CL\_\{int\})$ values. To get real $C{L}_{int}CL\_\{int\}$ values, simply backtransform:

$$C{L}_{int}={10}^{\widehat{y}}CL\_\{int\}\; =\; 10^\{\backslash hat\{y\}\}$$

Where $\widehat{y}\backslash hat\{y\}$ is our model prediction.

We will use this model for inference, aka predict the ${\log }_{10}(C{L}_{int})\backslash log\_\{10\}(CL\_\{int\})$ values of a set of molecular compounds unseen to the model. For demonstration purposes, we have provided a small subset of compounds from a ZINC deck in the file compounds_for_inference.csv.

The generic command to run our inference pipeline is:

openadmet predict \
    --input-path <the path to the data to predict on> \
    --input-col <the column to of the data to predict on, often SMILES> \
    --model-dir <the anvil_training directory of the model to predict with> \
    --output-csv <the path to an output CSV to save the predictions to> \
    --accelerator <whether to use gpu or cpu, defaults to gpu>

You can run this directly in your command line, OR you can use the bash script we've provided, run_model_inference.sh.

For our working example, this command becomes:

openadmet predict \
    --input-path compounds_for_inference.csv \
    --input-col OPENADMET_CANONICAL_SMILES \
    --model-dir anvil_training/ \
    --output-csv predictions.csv \
    --accelerator cpu

You can easily substitute your own set of compounds, simply modify the --input-path and --input-col arguments for your specific dataset.

In our example, this outputs a file called predictions.csv which will have predicted (the OADMET_PRED columns) CLint values for all the species the model was trained on (human, rat, and mouse):

OADMET_PRED_chemprop_LOG_CLint_{species},
OADMET_STD_chemprop_LOG_CLint_{species}

NOTE In this example, the standard deviation (OADMET_STD) columns are empty because uncertainty cannot be estimated unless running inference on an ensemble of models. For further details, visit our demo specifically about ensembling.