Push model using huggingface_hub.

README.md

@@ -16,15 +16,15 @@ tags:
 
 - **Developers:** IBM Research
 - **GitHub Repository:** [https://github.com/BiomedSciAI/biomed-multi-view](https://github.com/BiomedSciAI/biomed-multi-view)
-- **Paper:** [Multi-view biomedical foundation models for molecule-target and property prediction](https://arxiv.org/abs/TBD)
-- **Release Date**: Oct 29th, 2024
-- **License:** [apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
+- **Paper:** [Multi-view biomedical foundation models for molecule-target and property prediction](https://arxiv.org/abs/2410.19704)
+- **Release Date**: Oct 28th, 2024
+- **License:** [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0)
 
 ## Model Description
 
-This model contains the implementation of the Multi-view Molecular Embedding with Late Fusion (MMELON) architecture. MMELON combines molecular representations from three views — image, 2-dimensional chemically-bonded graph, and text (SMILES) —to learn a joint embedding that can be finetuned for downstream tasks in chemical and biological property prediction.
+`biomed.sm.mv-te-84m` is a biomedical foundation model for small molecules created using MMELON (Multi-view Molecular Embedding with Late Fusion), a flexible approach to aggregate multiple views (sequence, image, graph) of molecules in a foundation model setting. While models based on single view representation typically performs well on some downstream tasks and not others, the multi-view model performs robustly across a wide range of property prediction tasks encompassing ligand-protein binding, molecular solubility, metabolism and toxicity. It has been applied to screen compounds against a large (> 100 targets) set of G Protein-Coupled receptors (GPCRs) to identify strong binders for 33 targets related to Alzheimer’s disease, which are validated through structure-based modeling and identification of key binding motifs [Multi-view biomedical foundation models for molecule-target and property prediction](https://arxiv.org/abs/2410.19704).
 
-It was introduced in the paper [Multi-view biomedical foundation models for molecule-target and property prediction](https://arxiv.org/) by authors and first released in [this repository](https://github.com/BiomedSciAI/biomed-multi-view).
+Source code is made available in [this repository](https://github.com/BiomedSciAI/biomed-multi-view).
 
 ![SmallMoleculeMultiView Overview](https://github.com/BiomedSciAI/biomed-multi-view/blob/main/docs/overview.png?raw=true)
 
@@ -34,13 +34,19 @@ It was introduced in the paper [Multi-view biomedical foundation models for mole
 
 The embeddings from these single-view pre-trained encoders are combined using an attention-based aggregator module. This module learns to weight each view appropriately, producing a unified multi-view embedding. This approach leverages the strengths of each representation to improve performance on downstream predictive tasks.
 
+## Intended Use and Limitations
+
+The model is intended for (1) Molecular property prediction.  The pre-trained model may be fine-tuned for both regression and classification tasks. Examples include but are not limited to binding affinity, solubility and toxicity. (2)  Pre-trained model embeddings may be used as the basis for similarity measures to search a chemical library. (3) Small molecule embeddings provided by the model may be combined with protein embeddings to fine-tune on tasks that utilize both small molecule and protein representation.  (4) Select task-specific fine-tuned models are given as examples. Through listed activities, model may aid in aspects of the molecular discovery such as lead finding or optimization.
+
+
+The model’s domain of applicability is small, drug-like molecules. It intended for use with molecules less than 1000 Da molecular weight.  The MMELON approach itself may be extended to include proteins and other macromolecules but does not at present provide embeddings for such entities.  The model is at present not intended for molecular generation.  Molecules must be given as a valid SMILES string that represents a valid chemically bonded graph. Invalid inputs will impact performance or lead to error.
 
 ## Usage
 
-Using `SmallMoleculeMultiView` requires [https://github.com/BiomedSciAI/biomed-multi-view](https://github.com/BiomedSciAI/biomed-multi-view)
+Using `SmallMoleculeMultiView` API requires the codebase [https://github.com/BiomedSciAI/biomed-multi-view](https://github.com/BiomedSciAI/biomed-multi-view)
 
 ## Installation
-Follow these steps to set up the `biomed.multi-view` codebase on your system.
+Follow these steps to set up the `biomed-multi-view` codebase on your system.
 
 ### Prerequisites
 * Operating System: Linux or macOS
@@ -50,27 +56,14 @@ Follow these steps to set up the `biomed.multi-view` codebase on your system.
 
 
 ### Step 1: Set up the project directory
-Choose a root directory where you want to install biomed.multi-view. For example:
+Choose a root directory where you want to install `biomed-multi-view`. For example:
 
 ```bash
 export ROOT_DIR=~/biomed-multiview
 mkdir -p $ROOT_DIR
 ```
 
-### Step 2: Install anaconda3
-If you have Anconda in your system you can skip this step.
-``` bash
-cd $ROOT_DIR
-# Download the Anaconda installer
-wget https://repo.anaconda.com/archive/Anaconda3-2023.03-Linux-x86_64.sh
-
-# Run the installer
-bash Anaconda3-2023.03-Linux-x86_64.sh
-# After installation, initialize Conda:
-source activate $ROOT_DIR/anaconda3/bin/activate
-```
-
-#### Step 3: Create and activate a Conda environment
+#### Step 2: Create and activate a Conda environment
 ```bash
 conda create -y python=3.11 --prefix $ROOT_DIR/envs/biomed-multiview
 ```
@@ -79,7 +72,7 @@ Activate the environment:
 conda activate $ROOT_DIR/envs/biomed-multiview
 ```
 
-#### Step 4: Clone the repository
+#### Step 3: Clone the repository
 Navigate to the project directory and clone the repository:
 ```bash
 mkdir -p $ROOT_DIR/code
@@ -89,14 +82,14 @@ cd $ROOT_DIR/code
 git clone https://github.com/BiomedSciAI/biomed-multi-view.git
 
 # Navigate into the cloned repository
-cd biomed.multi-view
+cd biomed-multi-view
 ```
 Note: If you prefer using SSH, ensure that your SSH keys are set up with GitHub and use the following command:
 ```bash
 git clone [email protected]:BiomedSciAI/biomed-multi-view.git
 ```
 
-#### Step 5: Install package dependencies
+#### Step 4: Install package dependencies
 Install the package in editable mode along with development dependencies:
 ``` bash
 pip install -e .['dev']
@@ -106,7 +99,7 @@ Install additional requirements:
 pip install -r requirements.txt
 ```
 
-#### Step 6: macOS-Specific instructions (Apple Silicon)
+#### Step 5: macOS-Specific instructions (Apple Silicon)
 If you are using a Mac with Apple Silicon (M1/M2/M3) and the zsh shell, you may need to disable globbing for the installation command:
 
 ``` bash
@@ -117,7 +110,7 @@ Install macOS-specific requirements optimized for Apple’s Metal Performance Sh
 pip install -r requirements-mps.txt
 ```
 
-#### Step 7:  Installation verification (optional)
+#### Step 6:  Installation verification (optional)
 Verify that the installation was successful by running unit tests
 
 ```bash
@@ -127,7 +120,8 @@ python -m unittest bmfm_sm.tests.all_tests
 
 ### Get embedding example
 
-A simple example:
+You can generate embeddings for a given molecule using the pretrained model with the following code.
+
 ```python
 # Necessary imports
 from bmfm_sm.api.smmv_api import SmallMoleculeMultiViewModel
@@ -152,6 +146,8 @@ print(example_emb.shape)
 
 ### Get prediction example
 
+You can use the finetuned models to make predictions on new data.
+
 ``` python
 from bmfm_sm.api.smmv_api import SmallMoleculeMultiViewModel
 from bmfm_sm.api.dataset_registry import DatasetRegistry
@@ -160,7 +156,7 @@ from bmfm_sm.api.dataset_registry import DatasetRegistry
 dataset_registry = DatasetRegistry()
 
 # Example SMILES string
-example_smiles = "CC(C)CC1=CC=C(C=C1)C(C)C(=O)O"
+example_smiles = "CC(C)C1CCC(C)CC1O"
 
 # Get dataset information for dataset
 ds = dataset_registry.get_dataset_info("QM7")
@@ -183,7 +179,7 @@ print("Prediction:", prediction)
 
 ##### Output:
 ```bash
-Prediction: {'prediction': [0.85], 'label': None}
+Prediction: {'prediction': [-2.53]}
 ```
 
 For more advanced usage, see our detailed examples at: https://github.com/BiomedSciAI/biomed-multi-view
@@ -191,12 +187,15 @@ For more advanced usage, see our detailed examples at: https://github.com/Biomed
 
 ## Citation
 
-If you found our work useful, please consider to give a star to the repo and cite our paper:
+If you found our work useful, please consider giving a star to the repo and cite our paper:
 ```
-@article{TBD,
-  title={TBD},
-  author={IBM Research Team},
-  jounal={arXiv preprint arXiv:TBD},
-  year={2024}
+@misc{suryanarayanan2024multiviewbiomedicalfoundationmodels,
+      title={Multi-view biomedical foundation models for molecule-target and property prediction},
+      author={Parthasarathy Suryanarayanan and Yunguang Qiu and Shreyans Sethi and Diwakar Mahajan and Hongyang Li and Yuxin Yang and Elif Eyigoz and Aldo Guzman Saenz and Daniel E. Platt and Timothy H. Rumbell and Kenney Ng and Sanjoy Dey and Myson Burch and Bum Chul Kwon and Pablo Meyer and Feixiong Cheng and Jianying Hu and Joseph A. Morrone},
+      year={2024},
+      eprint={2410.19704},
+      archivePrefix={arXiv},
+      primaryClass={q-bio.BM},
+      url={https://arxiv.org/abs/2410.19704},
 }
 ```