Update README.md

README.md

@@ -1,8 +1,79 @@
 ---
 tags:
-- model_hub_mixin
+- drug-discovery
+- ibm
+- mammal
+- pytorch
+- small molecules drugs
+- smiles
+- MoleculeNet
+- toxicity
+- safetensors
+- biomed-multi-alignment
+license: apache-2.0
+library_name: biomed-multi-alignment
+base_model:
+- ibm/biomed.omics.bl.sm.ma-ted-458m
 ---
 
-This model has been pushed to the Hub using the [PytorchModelHubMixin](https://huggingface.co/docs/huggingface_hub/package_reference/mixins#huggingface_hub.PyTorchModelHubMixin) integration:
-- Library: [More Information Needed]
-- Docs: [More Information Needed]
+Drugs must satisfy stringent criteria for both efficacy and safety. This model predicts the likelihood of failure in clinical toxicity trials 
+for small-molecule drugs, represented using SMILES (Simplified Molecular Input Line Entry System) strings. It is a fine-tuned version of the 
+IBM biomedical foundation model, ibm/biomed.omics.bl.sm.ma-ted-458m [1], trained on over 2 billion biological samples spanning multiple modalities, 
+including proteins, small molecules, and single-cell gene expression data.
+
+The fine-tuning was performed using the MoleculeNet Clintox dataset [2]. For benchmarking, we employed predefined training, validation, and testing splits 
+provided by MolFormer [3], sourced from the dataset referenced in [4].
+
+- [1] https://huggingface.co/ibm/biomed.omics.bl.sm.ma-ted-458m
+- [2] Zhenqin Wu et al. “MoleculeNet: a benchmark for molecular machine learning”.
+In: Chemical science 9.2 (2018), pp. 513–530.
+- [3] Jerret Ross et al. “Large-scale chemical language representations capture molecular
+structure and properties”. In: Nature Machine Intelligence 4.12 (2022),
+pp. 1256–1264.
+- [4] https://github.com/IBM/molformer/tree/main/data that points to https://ibm.ent.box.com/v/MoLFormer-data (file: finetune datasets.zip).
+
+## Model Summary
+
+- **Developers:** IBM Research
+- **GitHub Repository:** https://github.com/BiomedSciAI/biomed-multi-alignment
+- **Paper:** https://arxiv.org/abs/2410.22367
+- **Release Date**: Dec 4th, 2024
+- **License:** [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0).
+
+## Usage
+
+Using `biomed.omics.bl.sm.ma-ted-458m.moleculenet_clintox_tox` requires installing https://github.com/BiomedSciAI/biomed-multi-alignment
+
+```
+pip install git+https://github.com/BiomedSciAI/biomed-multi-alignment.git
+```
+
+A simple example for using `ibm/omics.bl.sm.ma-ted-458m.moleculenet_clintox_tox`:
+
+```
+from mammal.examples.molnet.molnet_infer import load_model, task_infer
+
+smiles_seq = "C(Cl)Cl"
+
+task_dict = load_model(task_name="TOXICITY", device="cpu")
+result = task_infer(task_dict=task_dict, smiles_seq=smiles_seq)
+print(f"The prediction for {smiles_seq=} is {result}")
+```
+
+See our detailed example at: on `https://github.com/BiomedSciAI/biomed-multi-alignment` 
+
+
+## Citation
+
+If you found our work useful, please consider giving a star to the repo and cite our paper:
+```
+@misc{shoshan2024mammalmolecularaligned,
+      title={MAMMAL -- Molecular Aligned Multi-Modal Architecture and Language}, 
+      author={Yoel Shoshan and Moshiko Raboh and Michal Ozery-Flato and Vadim Ratner and Alex Golts and Jeffrey K. Weber and Ella Barkan and Simona Rabinovici-Cohen and Sagi Polaczek and Ido Amos and Ben Shapira and Liam Hazan and Matan Ninio and Sivan Ravid and Michael M. Danziger and Joseph A. Morrone and Parthasarathy Suryanarayanan and Michal Rosen-Zvi and Efrat Hexter},
+      year={2024},
+      eprint={2410.22367},
+      archivePrefix={arXiv},
+      primaryClass={q-bio.QM},
+      url={https://arxiv.org/abs/2410.22367}, 
+}
+```