<p align="center"><img src="https://raw.githubusercontent.com/mims-harvard/TDC/master/fig/logo.png" alt="logo" width="600px" /></p>
----
[](https://tdcommons.ai)
[](https://badge.fury.io/py/PyTDC)
[](https://pepy.tech/project/pytdc)
[](https://pepy.tech/project/pytdc)
[](https://github.com/mims-harvard/TDC/stargazers)
[](https://github.com/mims-harvard/TDC/network/members)
[](https://app.circleci.com/pipelines/github/mims-harvard/TDC)
[](http://tdc.readthedocs.io/?badge=latest)
[](https://opensource.org/licenses/MIT)
[](https://twitter.com/ProjectTDC)
[**Website**](https://tdcommons.ai) | [**Nature Chemical Biology 2022 Paper**](https://www.nature.com/articles/s41589-022-01131-2) | [**NeurIPS 2021 Paper**](https://openreview.net/pdf?id=8nvgnORnoWr) | [**Long Paper**](https://arxiv.org/abs/2102.09548) | [**Slack**](https://join.slack.com/t/pytdc/shared_invite/zt-x0ujg5v6-zwtQZt83fhRdgrYjXRFz5g) | [**TDC Mailing List**](https://groups.io/g/tdc) | [**TDC Documentation**](https://tdc.readthedocs.io/) | [**Contribution Guidelines**](CONTRIBUTE.md)
Artificial intelligence is poised to reshape therapeutic science. **Therapeutics Data Commons** is a coordinated initiative to access and evaluate artificial intelligence capability across therapeutic modalities and stages of discovery, supporting the development of AI methods, with a strong bent towards establishing the foundation of which AI methods are most suitable for drug discovery applications and why.
Researchers across disciplines can use TDC for numerous applications. AI-solvable tasks, AI-ready datasets, and curated benchmarks in TDC serve as a meeting point between biochemical and AI scientists. TDC facilitates algorithmic and scientific advances and accelerate machine learning method development, validation and transition into biomedical and clinical implementation.
TDC is an open-science initiative. We welcome [contributions from the community.](CONTRIBUTE.md)
## Key TDC Presentations and Publications
[1] Huang, Fu, Gao, et al., Artificial Intelligence Foundation for Therapeutic Science, Nature Chemical Biology, 2022 [**\[Paper\]**](https://www.nature.com/articles/s41589-022-01131-2)
[2] Huang, Fu, Gao, et al., Therapeutics Data Commons: Machine Learning Datasets and Tasks for Drug Discovery and Development, NeurIPS 2021 [**\[Paper\]**](https://openreview.net/forum?id=8nvgnORnoWr) [**\[Poster\]**](https://drive.google.com/file/d/1LfF8mfPLUqAVEzH3KPBxDO_VF7nLFtiJ/view?usp=sharing)
[3] Huang et al., Benchmarking Molecular Machine Learning in Therapeutics Data Commons, ELLIS ML4Molecules 2021 [**\[Paper\]**](https://cloud.ml.jku.at/s/54pB5Eqf6ftX7qA) [**\[Slides\]**](https://drive.google.com/file/d/1iOSW_5eruca4vdygDxS1H64c49oQuH40/view?usp=sharing)
[4] Huang et al., Therapeutics Data Commons: Machine Learning Datasets and Tasks for Drug Discovery and Development, Baylearn 2021 [**\[Slides\]**](https://drive.google.com/file/d/1BNpk3dOdqE3ksgyVV-V3xySdBMq-8cXL/view?usp=sharing) [**\[Poster\]**](https://drive.google.com/file/d/1LfF8mfPLUqAVEzH3KPBxDO_VF7nLFtiJ/view?usp=sharing)
[5] Huang, Fu, Gao et al., Therapeutics Data Commons, NSF-Harvard Symposium on Drugs for Future Pandemics 2020 [**\[#futuretx20\]**](https://www.drugsymposium.org/) [**\[Slides\]**](https://drive.google.com/file/d/11eTrh_lsqPcwu3RZRYjJGNpJ3s18YlBS/view) [**\[Video\]**](https://youtu.be/ZuCOhEZtaOw)
[6] [TDC User Group Meetup, Jan 2022](https://harvard.zoom.us/rec/share/HO0TjRPs56YG-Fu3i033izaTwebB4KwUhPeNURkWSI-anrH9su03lCtUlHeZG-WP.67ZJmAIHsD7Q_2GQ) [**\[Agenda\]**](https://shoutout.wix.com/so/d1Nv1pC2d#/main)
[7] Zitnik, Machine Learning to Translate the Cancer Genome and Epigenome Session, [AACR Annual Meeting 2022, Apr 2022](https://www.aacr.org/meeting/aacr-annual-meeting-2022/)
[8] Zitnik, Few-Shot Learning for Network Biology, [Keynote at KDD Workshop on Data Mining in Bioinformatics](https://biokdd.org/biokdd21/keynote.html)
[9] Zitnik, Actionable machine learning for drug discovery and development, [Broad Institute, Models, Inference & Algorithms Seminar, 2021](https://www.broadinstitute.org/talks/actionable-machine-learning-drug-discovery-and-development)
[10] Zitnik, Graph Neural Networks for Biomedical Data, [Machine Learning in Computational Biology, 2020](https://sites.google.com/cs.washington.edu/mlcb2020/schedule?authuser=0)
[11] Zitnik, Graph Neural Networks for Identifying COVID-19 Drug Repurposing Opportunities, [MIT AI Cures, 2020](https://www.aicures.mit.edu/drugdiscoveryconference)
## Unique Features of TDC
- *Diverse areas of therapeutics development*: TDC covers a wide range of learning tasks, including target discovery, activity screening, efficacy, safety, and manufacturing across biomedical products, including small molecules, antibodies, and vaccines.
- *Ready-to-use datasets*: TDC is minimally dependent on external packages. Any TDC dataset can be retrieved using only 3 lines of code.
- *Data functions*: TDC provides extensive data functions, including data evaluators, meaningful data splits, data processors, and molecule generation oracles.
- *Leaderboards*: TDC provides benchmarks for fair model comparison and a systematic model development and evaluation.
- *Open-source initiative*: TDC is an open-source initiative. If you want to get involved, let us know.
<p align="center"><img src="https://raw.githubusercontent.com/mims-harvard/TDC/master/fig/tdc_overview.png" alt="overview" width="600px" /></p>
See [here](https://tdcommons.ai/news/) for the latest updates in TDC!
## Installation
### Using `pip`
To install the core environment dependencies of TDC, use `pip`:
```bash
pip install PyTDC
```
**Note**: TDC is in the beta release. Please update your local copy regularly by
```bash
pip install PyTDC --upgrade
```
The core data loaders are lightweight with minimum dependency on external packages:
```bash
numpy, pandas, tqdm, scikit-learn, fuzzywuzzy, seaborn
```
For utilities requiring extra dependencies, TDC prints installation instructions. To install full dependencies, please use the following `conda-forge` solution.
### Using `conda`
Data functions for molecule oracles, scaffold split, etc., require certain packages like RDKit. To install those packages, use the following `conda` installation:
```bash
conda install -c conda-forge pytdc
```
## Tutorials
We provide tutorials to get started with TDC:
| Name | Description |
|-------|---------------------------------------------------------|
| [101](tutorials/TDC_101_Data_Loader.ipynb) | Introduce TDC Data Loaders |
| [102](tutorials/TDC_102_Data_Functions.ipynb) | Introduce TDC Data Functions |
| [103.1](tutorials/TDC_103.1_Datasets_Small_Molecules.ipynb) | Walk through TDC Small Molecule Datasets |
| [103.2](tutorials/TDC_103.2_Datasets_Biologics.ipynb) | Walk through TDC Biologics Datasets |
| [104](tutorials/TDC_104_ML_Model_DeepPurpose.ipynb) | Generate 21 ADME ML Predictors with 15 Lines of Code |
| [105](tutorials/TDC_105_Oracle.ipynb) | Molecule Generation Oracles |
| [106](tutorials/TDC_106_BenchmarkGroup_Submission_Demo.ipynb) | Benchmark submission |
| [DGL](tutorials/DGL_User_Group_Demo.ipynb) | Demo presented at DGL GNN User Group Meeting |
| [U1.1](tutorials/User_Group/UserGroupMeeting_Tianfan.ipynb) | Demo presented at first TDC User Group Meetup |
| [U1.2](tutorials/User_Group/UserGroupMeeting_Wenhao.ipynb) | Demo presented at first TDC User Group Meetup |
| `201 <https://colab.research.google.com/drive/1xTgBwKUfP2b8j6Fqh28M2GUp2ScfENMX?usp=sharing>`_ | TDC-2 Resource and Multi-modal Single-Cell API |
## Design of TDC
TDC has a unique three-tiered hierarchical structure, which to our knowledge, is the first attempt at systematically organizing machine learning for therapeutics. We organize TDC into three distinct *problems*. For each problem, we give a collection *learning tasks*. Finally, for each task, we provide a series of *datasets*.
In the first tier, after observing a large set of therapeutics tasks, we categorize and abstract out three major areas (i.e., problems) where machine learning can facilitate scientific advances, namely, single-instance prediction, multi-instance prediction, and generation:
* Single-instance prediction `single_pred`: Prediction of property given individual biomedical entity.
* Multi-instance prediction `multi_pred`: Prediction of property given multiple biomedical entities.
* Generation `generation`: Generation of new desirable biomedical entities.
<p align="center"><img src="https://raw.githubusercontent.com/mims-harvard/TDC/master/fig/tdc_problems.png" alt="problems" width="500px" /></p>
The second tier in the TDC structure is organized into learning tasks. Improvement on these tasks can result in numerous applications, including identifying personalized combinatorial therapies, designing novel class of antibodies, improving disease diagnosis, and finding new cures for emerging diseases.
Finally, in the third tier of TDC, each task is instantiated via multiple datasets. For each dataset, we provide several splits of the dataset into training, validation, and test sets to simulate the type of understanding and generalization (e.g., the model's ability to generalize to entirely unseen compounds or to granularly resolve patient response to a polytherapy) needed for transition into production and clinical implementation.
## TDC Data Loaders
TDC provides a collection of workflows with intuitive, high-level APIs for both beginners and experts to create machine learning models in Python. Building off the modularized "Problem -- Learning Task -- Data Set" structure (see above) in TDC, we provide a three-layer API to access any learning task and dataset. This hierarchical API design allows us to easily incorporate new tasks and datasets.
For a concrete example, to obtain the HIA dataset from ADME therapeutic learning task in the single-instance prediction problem:
```python
from tdc.single_pred import ADME
data = ADME(name = 'HIA_Hou')
# split into train/val/test with scaffold split methods
split = data.get_split(method = 'scaffold')
# get the entire data in the various formats
data.get_data(format = 'df')
```
You can see all the datasets that belong to a task as follows:
```python
from tdc.utils import retrieve_dataset_names
retrieve_dataset_names('ADME')
```
See all therapeutic tasks and datasets on the [TDC website](https://zitniklab.hms.harvard.edu/TDC/overview/)!
## TDC Data Functions
#### Dataset Splits
To retrieve the training/validation/test dataset split, you could simply type
```python
data = X(name = Y)
data.get_split(seed = 42)
# {'train': df_train, 'val': df_val, 'test': df_test}
```
You can specify the splitting method, random seed, and split fractions in the function by e.g. `data.get_split(method = 'scaffold', seed = 1, frac = [0.7, 0.1, 0.2])`. Check out the [data split page](https://zitniklab.hms.harvard.edu/TDC/functions/data_split/) on the website for details.
#### Strategies for Model Evaluation
We provide various evaluation metrics for the tasks in TDC, which are described in [model evaluation page](https://zitniklab.hms.harvard.edu/TDC/functions/data_evaluation/) on the website. For example, to use metric ROC-AUC, you could simply type
```python
from tdc import Evaluator
evaluator = Evaluator(name = 'ROC-AUC')
score = evaluator(y_true, y_pred)
```
#### Data Processing
TDC provides numerous data processing functions, including label transformation, data balancing, pair data to PyG/DGL graphs, negative sampling, database querying and so on. For function usage, see our [data processing page](https://zitniklab.hms.harvard.edu/TDC/functions/data_process/) on the TDC website.
#### Molecule Generation Oracles
For molecule generation tasks, we provide 10+ oracles for both goal-oriented and distribution learning. For detailed usage of each oracle, please checkout the [oracle page](https://zitniklab.hms.harvard.edu/TDC/functions/oracles/) on the website. For example, we want to retrieve the GSK3Beta oracle:
```python
from tdc import Oracle
oracle = Oracle(name = 'GSK3B')
oracle(['CC(C)(C)....'
'C[C@@H]1....',
'CCNC(=O)....',
'C[C@@H]1....'])
# [0.03, 0.02, 0.0, 0.1]
```
## TDC Leaderboards
Every dataset in TDC is a benchmark, and we provide training/validation and test sets for it, together with data splits and performance evaluation metrics. To participate in the leaderboard for a specific benchmark, follow these steps:
* Use the TDC benchmark data loader to retrieve the benchmark.
* Use training and/or validation set to train your model.
* Use the TDC model evaluator to calculate the performance of your model on the test set.
* Submit the test set performance to a TDC leaderboard.
As many datasets share a therapeutics theme, we organize benchmarks into meaningfully defined groups, which we refer to as benchmark groups. Datasets and tasks within a benchmark group are carefully curated and centered around a theme (for example, TDC contains a benchmark group to support ML predictions of the ADMET properties). While every benchmark group consists of multiple benchmarks, it is possible to separately submit results for each benchmark in the group. Here is the code framework to access the benchmarks:
```python
from tdc import BenchmarkGroup
group = BenchmarkGroup(name = 'ADMET_Group', path = 'data/')
predictions_list = []
for seed in [1, 2, 3, 4, 5]:
benchmark = group.get('Caco2_Wang')
# all benchmark names in a benchmark group are stored in group.dataset_names
predictions = {}
name = benchmark['name']
train_val, test = benchmark['train_val'], benchmark['test']
train, valid = group.get_train_valid_split(benchmark = name, split_type = 'default', seed = seed)
# --------------------------------------------- #
# Train your model using train, valid, test #
# Save test prediction in y_pred_test variable #
# --------------------------------------------- #
predictions[name] = y_pred_test
predictions_list.append(predictions)
results = group.evaluate_many(predictions_list)
# {'caco2_wang': [6.328, 0.101]}
```
For more information, visit [here](https://tdcommons.ai/benchmark/overview/).
## Cite Us
If you find Therapeutics Data Commons useful, cite our [package](https://pypi.org/project/PyTDC/), our [NeurIPS paper](https://openreview.net/pdf?id=8nvgnORnoWr) , [Nature Chemical Biology paper](https://www.nature.com/articles/s41589-022-01131-2) , and our [Harvard Dataverse Dataset](https://dataverse.harvard.edu/dataset.xhtml?persistentId=doi:10.7910/DVN/21LKWG):
```
@online{PyTDC,
author={Velez-Arce, Alejandro, and Huang, Kexin, and Fu, Tianfan and Gao, Wenhao and Zhao, Yue and Roohani, Yusuf and Leskovec, Jure and Coley,
Connor W and Xiao, Cao and Sun, Jimeng and Zitnik, Marinka}
title={Therapeutic Data Commons - PyTDC},
url={https://pypi.org/project/PyTDC/},
urldate = {2021-03-28},
publisher={Zitnik Lab, Harvard University}
}
```
```
@article{Huang2021tdc,
title={Therapeutics Data Commons: Machine Learning Datasets and Tasks for Drug Discovery and Development},
author={Huang, Kexin and Fu, Tianfan and Gao, Wenhao and Zhao, Yue and Roohani, Yusuf and Leskovec, Jure and Coley,
Connor W and Xiao, Cao and Sun, Jimeng and Zitnik, Marinka},
journal={Proceedings of Neural Information Processing Systems, NeurIPS Datasets and Benchmarks},
year={2021}
}
```
```
@article{Huang2022artificial,
title={Artificial intelligence foundation for therapeutic science},
author={Huang, Kexin and Fu, Tianfan and Gao, Wenhao and Zhao, Yue and Roohani, Yusuf and Leskovec, Jure and Coley,
Connor W and Xiao, Cao and Sun, Jimeng and Zitnik, Marinka},
journal={Nature Chemical Biology},
year={2022}
}
```
```
@data{DVN/21LKWG_2020,
author = {Alejandro Velez-Arce, Kexin Huang, Tianfan Fu, Wenhao Gao, Yue Zhao, Yusuf Roohani, Jure Leskovec, Connor W. Coley, Cao Xiao, Jimeng Sun, and Marinka Zitnik},
publisher = {Harvard Dataverse},
title = {{Therapeutics Data Commons (https://tdcommons.ai)}},
UNF = {UNF:6:KESpbe1TOPOW2BGCtjSI2w==},
year = {2020},
version = {V80},
doi = {10.7910/DVN/21LKWG},
url = {https://doi.org/10.7910/DVN/21LKWG}
}
```
TDC is built on top of other open-sourced projects. If you used these datasets/functions in your research, please cite the original work as well. You can find the original paper in the website to the function/dataset.
## Contribute
TDC is a community-driven and open-science initiative. To get involved, join our [Slack Workspace](https://join.slack.com/t/pytdc/shared_invite/zt-x0ujg5v6-zwtQZt83fhRdgrYjXRFz5g) and checkout the [contribution guide](CONTRIBUTE.md)!
## Contact
Reach us at [contact@tdcommons.ai](mailto:contact@tdcommons.ai) or open a GitHub issue.
## Data Server
TDC is hosted on [Harvard Dataverse](https://dataverse.harvard.edu/dataset.xhtml?persistentId=doi:10.7910/DVN/21LKWG) with the following persistent identifier [https://doi.org/10.7910/DVN/21LKWG](https://doi.org/10.7910/DVN/21LKWG). When Dataverse is under maintenance, TDC datasets cannot be retrieved. That happens rarely; please check the status on [the Dataverse website](https://dataverse.harvard.edu/).
## License
TDC codebase is under MIT license. For individual dataset usage, please refer to the dataset license found in the website.
Raw data
{
"_id": null,
"home_page": "https://github.com/mims-harvard/TDC",
"name": "PyTDC",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "TDC Team",
"author_email": "alejandro_velez-arce@hms.harvard.edu",
"download_url": "https://files.pythonhosted.org/packages/11/a5/82af7891394666d1b894cf7891f3ff407d8d61d23a219c34701de09a3818/PyTDC-0.4.15.tar.gz",
"platform": null,
"description": "<p align=\"center\"><img src=\"https://raw.githubusercontent.com/mims-harvard/TDC/master/fig/logo.png\" alt=\"logo\" width=\"600px\" /></p>\n\n----\n\n[](https://tdcommons.ai)\n[](https://badge.fury.io/py/PyTDC)\n[](https://pepy.tech/project/pytdc)\n[](https://pepy.tech/project/pytdc)\n[](https://github.com/mims-harvard/TDC/stargazers)\n[](https://github.com/mims-harvard/TDC/network/members)\n\n[](https://app.circleci.com/pipelines/github/mims-harvard/TDC)\n\n[](http://tdc.readthedocs.io/?badge=latest)\n[](https://opensource.org/licenses/MIT)\n[](https://twitter.com/ProjectTDC)\n\n\n[**Website**](https://tdcommons.ai) | [**Nature Chemical Biology 2022 Paper**](https://www.nature.com/articles/s41589-022-01131-2) | [**NeurIPS 2021 Paper**](https://openreview.net/pdf?id=8nvgnORnoWr) | [**Long Paper**](https://arxiv.org/abs/2102.09548) | [**Slack**](https://join.slack.com/t/pytdc/shared_invite/zt-x0ujg5v6-zwtQZt83fhRdgrYjXRFz5g) | [**TDC Mailing List**](https://groups.io/g/tdc) | [**TDC Documentation**](https://tdc.readthedocs.io/) | [**Contribution Guidelines**](CONTRIBUTE.md)\n\nArtificial intelligence is poised to reshape therapeutic science. **Therapeutics Data Commons** is a coordinated initiative to access and evaluate artificial intelligence capability across therapeutic modalities and stages of discovery, supporting the development of AI methods, with a strong bent towards establishing the foundation of which AI methods are most suitable for drug discovery applications and why.\n\nResearchers across disciplines can use TDC for numerous applications. AI-solvable tasks, AI-ready datasets, and curated benchmarks in TDC serve as a meeting point between biochemical and AI scientists. TDC facilitates algorithmic and scientific advances and accelerate machine learning method development, validation and transition into biomedical and clinical implementation.\n\nTDC is an open-science initiative. We welcome [contributions from the community.](CONTRIBUTE.md)\n\n## Key TDC Presentations and Publications\n\n[1] Huang, Fu, Gao, et al., Artificial Intelligence Foundation for Therapeutic Science, Nature Chemical Biology, 2022 [**\\[Paper\\]**](https://www.nature.com/articles/s41589-022-01131-2)\n\n[2] Huang, Fu, Gao, et al., Therapeutics Data Commons: Machine Learning Datasets and Tasks for Drug Discovery and Development, NeurIPS 2021 [**\\[Paper\\]**](https://openreview.net/forum?id=8nvgnORnoWr) [**\\[Poster\\]**](https://drive.google.com/file/d/1LfF8mfPLUqAVEzH3KPBxDO_VF7nLFtiJ/view?usp=sharing) \n\n[3] Huang et al., Benchmarking Molecular Machine Learning in Therapeutics Data Commons, ELLIS ML4Molecules 2021 [**\\[Paper\\]**](https://cloud.ml.jku.at/s/54pB5Eqf6ftX7qA) [**\\[Slides\\]**](https://drive.google.com/file/d/1iOSW_5eruca4vdygDxS1H64c49oQuH40/view?usp=sharing) \n\n[4] Huang et al., Therapeutics Data Commons: Machine Learning Datasets and Tasks for Drug Discovery and Development, Baylearn 2021 [**\\[Slides\\]**](https://drive.google.com/file/d/1BNpk3dOdqE3ksgyVV-V3xySdBMq-8cXL/view?usp=sharing) [**\\[Poster\\]**](https://drive.google.com/file/d/1LfF8mfPLUqAVEzH3KPBxDO_VF7nLFtiJ/view?usp=sharing)\n\n[5] Huang, Fu, Gao et al., Therapeutics Data Commons, NSF-Harvard Symposium on Drugs for Future Pandemics 2020 [**\\[#futuretx20\\]**](https://www.drugsymposium.org/) [**\\[Slides\\]**](https://drive.google.com/file/d/11eTrh_lsqPcwu3RZRYjJGNpJ3s18YlBS/view) [**\\[Video\\]**](https://youtu.be/ZuCOhEZtaOw)\n\n[6] [TDC User Group Meetup, Jan 2022](https://harvard.zoom.us/rec/share/HO0TjRPs56YG-Fu3i033izaTwebB4KwUhPeNURkWSI-anrH9su03lCtUlHeZG-WP.67ZJmAIHsD7Q_2GQ) [**\\[Agenda\\]**](https://shoutout.wix.com/so/d1Nv1pC2d#/main)\n\n[7] Zitnik, Machine Learning to Translate the Cancer Genome and Epigenome Session, [AACR Annual Meeting 2022, Apr 2022](https://www.aacr.org/meeting/aacr-annual-meeting-2022/)\n\n[8] Zitnik, Few-Shot Learning for Network Biology, [Keynote at KDD Workshop on Data Mining in Bioinformatics](https://biokdd.org/biokdd21/keynote.html)\n\n[9] Zitnik, Actionable machine learning for drug discovery and development, [Broad Institute, Models, Inference & Algorithms Seminar, 2021](https://www.broadinstitute.org/talks/actionable-machine-learning-drug-discovery-and-development)\n\n[10] Zitnik, Graph Neural Networks for Biomedical Data, [Machine Learning in Computational Biology, 2020](https://sites.google.com/cs.washington.edu/mlcb2020/schedule?authuser=0)\n\n[11] Zitnik, Graph Neural Networks for Identifying COVID-19 Drug Repurposing Opportunities, [MIT AI Cures, 2020](https://www.aicures.mit.edu/drugdiscoveryconference)\n\n\n## Unique Features of TDC\n\n- *Diverse areas of therapeutics development*: TDC covers a wide range of learning tasks, including target discovery, activity screening, efficacy, safety, and manufacturing across biomedical products, including small molecules, antibodies, and vaccines.\n- *Ready-to-use datasets*: TDC is minimally dependent on external packages. Any TDC dataset can be retrieved using only 3 lines of code.\n- *Data functions*: TDC provides extensive data functions, including data evaluators, meaningful data splits, data processors, and molecule generation oracles. \n- *Leaderboards*: TDC provides benchmarks for fair model comparison and a systematic model development and evaluation.\n- *Open-source initiative*: TDC is an open-source initiative. If you want to get involved, let us know. \n\n<p align=\"center\"><img src=\"https://raw.githubusercontent.com/mims-harvard/TDC/master/fig/tdc_overview.png\" alt=\"overview\" width=\"600px\" /></p>\n\nSee [here](https://tdcommons.ai/news/) for the latest updates in TDC!\n\n## Installation\n\n### Using `pip`\n\nTo install the core environment dependencies of TDC, use `pip`:\n\n```bash\npip install PyTDC\n```\n\n**Note**: TDC is in the beta release. Please update your local copy regularly by\n\n```bash\npip install PyTDC --upgrade\n```\n\nThe core data loaders are lightweight with minimum dependency on external packages:\n\n```bash\nnumpy, pandas, tqdm, scikit-learn, fuzzywuzzy, seaborn\n```\n\nFor utilities requiring extra dependencies, TDC prints installation instructions. To install full dependencies, please use the following `conda-forge` solution. \n\n### Using `conda`\n\nData functions for molecule oracles, scaffold split, etc., require certain packages like RDKit. To install those packages, use the following `conda` installation: \n\n```bash\nconda install -c conda-forge pytdc\n```\n\n\n## Tutorials\n\nWe provide tutorials to get started with TDC:\n\n| Name | Description |\n|-------|---------------------------------------------------------|\n| [101](tutorials/TDC_101_Data_Loader.ipynb) | Introduce TDC Data Loaders |\n| [102](tutorials/TDC_102_Data_Functions.ipynb) | Introduce TDC Data Functions |\n| [103.1](tutorials/TDC_103.1_Datasets_Small_Molecules.ipynb) | Walk through TDC Small Molecule Datasets |\n| [103.2](tutorials/TDC_103.2_Datasets_Biologics.ipynb) | Walk through TDC Biologics Datasets |\n| [104](tutorials/TDC_104_ML_Model_DeepPurpose.ipynb) | Generate 21 ADME ML Predictors with 15 Lines of Code |\n| [105](tutorials/TDC_105_Oracle.ipynb) | Molecule Generation Oracles |\n| [106](tutorials/TDC_106_BenchmarkGroup_Submission_Demo.ipynb) | Benchmark submission |\n| [DGL](tutorials/DGL_User_Group_Demo.ipynb) | Demo presented at DGL GNN User Group Meeting |\n| [U1.1](tutorials/User_Group/UserGroupMeeting_Tianfan.ipynb) | Demo presented at first TDC User Group Meetup |\n| [U1.2](tutorials/User_Group/UserGroupMeeting_Wenhao.ipynb) | Demo presented at first TDC User Group Meetup |\n| `201 <https://colab.research.google.com/drive/1xTgBwKUfP2b8j6Fqh28M2GUp2ScfENMX?usp=sharing>`_ | TDC-2 Resource and Multi-modal Single-Cell API |\n\n\n## Design of TDC\n\nTDC has a unique three-tiered hierarchical structure, which to our knowledge, is the first attempt at systematically organizing machine learning for therapeutics. We organize TDC into three distinct *problems*. For each problem, we give a collection *learning tasks*. Finally, for each task, we provide a series of *datasets*.\n\nIn the first tier, after observing a large set of therapeutics tasks, we categorize and abstract out three major areas (i.e., problems) where machine learning can facilitate scientific advances, namely, single-instance prediction, multi-instance prediction, and generation:\n\n* Single-instance prediction `single_pred`: Prediction of property given individual biomedical entity.\n* Multi-instance prediction `multi_pred`: Prediction of property given multiple biomedical entities. \n* Generation `generation`: Generation of new desirable biomedical entities.\n\n<p align=\"center\"><img src=\"https://raw.githubusercontent.com/mims-harvard/TDC/master/fig/tdc_problems.png\" alt=\"problems\" width=\"500px\" /></p>\n\nThe second tier in the TDC structure is organized into learning tasks. Improvement on these tasks can result in numerous applications, including identifying personalized combinatorial therapies, designing novel class of antibodies, improving disease diagnosis, and finding new cures for emerging diseases.\n\nFinally, in the third tier of TDC, each task is instantiated via multiple datasets. For each dataset, we provide several splits of the dataset into training, validation, and test sets to simulate the type of understanding and generalization (e.g., the model's ability to generalize to entirely unseen compounds or to granularly resolve patient response to a polytherapy) needed for transition into production and clinical implementation.\n\n\n## TDC Data Loaders\n\nTDC provides a collection of workflows with intuitive, high-level APIs for both beginners and experts to create machine learning models in Python. Building off the modularized \"Problem -- Learning Task -- Data Set\" structure (see above) in TDC, we provide a three-layer API to access any learning task and dataset. This hierarchical API design allows us to easily incorporate new tasks and datasets.\n\nFor a concrete example, to obtain the HIA dataset from ADME therapeutic learning task in the single-instance prediction problem:\n\n```python\nfrom tdc.single_pred import ADME\ndata = ADME(name = 'HIA_Hou')\n# split into train/val/test with scaffold split methods\nsplit = data.get_split(method = 'scaffold')\n# get the entire data in the various formats\ndata.get_data(format = 'df')\n```\n\nYou can see all the datasets that belong to a task as follows:\n\n```python\nfrom tdc.utils import retrieve_dataset_names\nretrieve_dataset_names('ADME')\n```\n\nSee all therapeutic tasks and datasets on the [TDC website](https://zitniklab.hms.harvard.edu/TDC/overview/)!\n\n## TDC Data Functions\n\n#### Dataset Splits\n\nTo retrieve the training/validation/test dataset split, you could simply type\n```python \ndata = X(name = Y)\ndata.get_split(seed = 42)\n# {'train': df_train, 'val': df_val, 'test': df_test}\n```\nYou can specify the splitting method, random seed, and split fractions in the function by e.g. `data.get_split(method = 'scaffold', seed = 1, frac = [0.7, 0.1, 0.2])`. Check out the [data split page](https://zitniklab.hms.harvard.edu/TDC/functions/data_split/) on the website for details.\n\n#### Strategies for Model Evaluation\n\nWe provide various evaluation metrics for the tasks in TDC, which are described in [model evaluation page](https://zitniklab.hms.harvard.edu/TDC/functions/data_evaluation/) on the website. For example, to use metric ROC-AUC, you could simply type\n\n```python\nfrom tdc import Evaluator\nevaluator = Evaluator(name = 'ROC-AUC')\nscore = evaluator(y_true, y_pred)\n```\n\n#### Data Processing \n\nTDC provides numerous data processing functions, including label transformation, data balancing, pair data to PyG/DGL graphs, negative sampling, database querying and so on. For function usage, see our [data processing page](https://zitniklab.hms.harvard.edu/TDC/functions/data_process/) on the TDC website.\n\n#### Molecule Generation Oracles\n\nFor molecule generation tasks, we provide 10+ oracles for both goal-oriented and distribution learning. For detailed usage of each oracle, please checkout the [oracle page](https://zitniklab.hms.harvard.edu/TDC/functions/oracles/) on the website. For example, we want to retrieve the GSK3Beta oracle:\n\n```python\nfrom tdc import Oracle\noracle = Oracle(name = 'GSK3B')\noracle(['CC(C)(C)....' \n 'C[C@@H]1....',\n 'CCNC(=O)....', \n 'C[C@@H]1....'])\n\n# [0.03, 0.02, 0.0, 0.1]\n```\n\n## TDC Leaderboards\n\nEvery dataset in TDC is a benchmark, and we provide training/validation and test sets for it, together with data splits and performance evaluation metrics. To participate in the leaderboard for a specific benchmark, follow these steps:\n\n* Use the TDC benchmark data loader to retrieve the benchmark.\n\n* Use training and/or validation set to train your model.\n\n* Use the TDC model evaluator to calculate the performance of your model on the test set.\n\n* Submit the test set performance to a TDC leaderboard.\n\nAs many datasets share a therapeutics theme, we organize benchmarks into meaningfully defined groups, which we refer to as benchmark groups. Datasets and tasks within a benchmark group are carefully curated and centered around a theme (for example, TDC contains a benchmark group to support ML predictions of the ADMET properties). While every benchmark group consists of multiple benchmarks, it is possible to separately submit results for each benchmark in the group. Here is the code framework to access the benchmarks:\n\n```python\nfrom tdc import BenchmarkGroup\ngroup = BenchmarkGroup(name = 'ADMET_Group', path = 'data/')\npredictions_list = []\n\nfor seed in [1, 2, 3, 4, 5]:\n benchmark = group.get('Caco2_Wang') \n # all benchmark names in a benchmark group are stored in group.dataset_names\n predictions = {}\n name = benchmark['name']\n train_val, test = benchmark['train_val'], benchmark['test']\n train, valid = group.get_train_valid_split(benchmark = name, split_type = 'default', seed = seed)\n \n # --------------------------------------------- # \n # Train your model using train, valid, test #\n # Save test prediction in y_pred_test variable #\n # --------------------------------------------- #\n \n predictions[name] = y_pred_test\n predictions_list.append(predictions)\n\nresults = group.evaluate_many(predictions_list)\n# {'caco2_wang': [6.328, 0.101]}\n```\n\nFor more information, visit [here](https://tdcommons.ai/benchmark/overview/).\n\n\n## Cite Us\n\nIf you find Therapeutics Data Commons useful, cite our [package](https://pypi.org/project/PyTDC/), our [NeurIPS paper](https://openreview.net/pdf?id=8nvgnORnoWr) , [Nature Chemical Biology paper](https://www.nature.com/articles/s41589-022-01131-2) , and our [Harvard Dataverse Dataset](https://dataverse.harvard.edu/dataset.xhtml?persistentId=doi:10.7910/DVN/21LKWG):\n\n```\n@online{PyTDC,\n author={Velez-Arce, Alejandro, and Huang, Kexin, and Fu, Tianfan and Gao, Wenhao and Zhao, Yue and Roohani, Yusuf and Leskovec, Jure and Coley, \n Connor W and Xiao, Cao and Sun, Jimeng and Zitnik, Marinka}\n title={Therapeutic Data Commons - PyTDC},\n url={https://pypi.org/project/PyTDC/},\n urldate = {2021-03-28}, \n publisher={Zitnik Lab, Harvard University}\n}\n```\n\n```\n@article{Huang2021tdc,\n title={Therapeutics Data Commons: Machine Learning Datasets and Tasks for Drug Discovery and Development},\n author={Huang, Kexin and Fu, Tianfan and Gao, Wenhao and Zhao, Yue and Roohani, Yusuf and Leskovec, Jure and Coley, \n Connor W and Xiao, Cao and Sun, Jimeng and Zitnik, Marinka},\n journal={Proceedings of Neural Information Processing Systems, NeurIPS Datasets and Benchmarks},\n year={2021}\n}\n```\n\n```\n@article{Huang2022artificial,\n title={Artificial intelligence foundation for therapeutic science},\n author={Huang, Kexin and Fu, Tianfan and Gao, Wenhao and Zhao, Yue and Roohani, Yusuf and Leskovec, Jure and Coley, \n Connor W and Xiao, Cao and Sun, Jimeng and Zitnik, Marinka},\n journal={Nature Chemical Biology},\n year={2022}\n}\n```\n```\n@data{DVN/21LKWG_2020,\n author = {Alejandro Velez-Arce, Kexin Huang, Tianfan Fu, Wenhao Gao, Yue Zhao, Yusuf Roohani, Jure Leskovec, Connor W. Coley, Cao Xiao, Jimeng Sun, and Marinka Zitnik},\n publisher = {Harvard Dataverse},\n title = {{Therapeutics Data Commons (https://tdcommons.ai)}},\n UNF = {UNF:6:KESpbe1TOPOW2BGCtjSI2w==},\n year = {2020},\n version = {V80},\n doi = {10.7910/DVN/21LKWG},\n url = {https://doi.org/10.7910/DVN/21LKWG}\n}\n```\nTDC is built on top of other open-sourced projects. If you used these datasets/functions in your research, please cite the original work as well. You can find the original paper in the website to the function/dataset.\n\n## Contribute\n\nTDC is a community-driven and open-science initiative. To get involved, join our [Slack Workspace](https://join.slack.com/t/pytdc/shared_invite/zt-x0ujg5v6-zwtQZt83fhRdgrYjXRFz5g) and checkout the [contribution guide](CONTRIBUTE.md)!\n\n## Contact\n\nReach us at [contact@tdcommons.ai](mailto:contact@tdcommons.ai) or open a GitHub issue.\n\n## Data Server\n\nTDC is hosted on [Harvard Dataverse](https://dataverse.harvard.edu/dataset.xhtml?persistentId=doi:10.7910/DVN/21LKWG) with the following persistent identifier [https://doi.org/10.7910/DVN/21LKWG](https://doi.org/10.7910/DVN/21LKWG). When Dataverse is under maintenance, TDC datasets cannot be retrieved. That happens rarely; please check the status on [the Dataverse website](https://dataverse.harvard.edu/).\n\n## License\nTDC codebase is under MIT license. For individual dataset usage, please refer to the dataset license found in the website.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Therapeutics Data Commons",
"version": "0.4.15",
"project_urls": {
"Homepage": "https://github.com/mims-harvard/TDC"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "11a582af7891394666d1b894cf7891f3ff407d8d61d23a219c34701de09a3818",
"md5": "1d0f8b2616a27f6f057fd291c5a7b233",
"sha256": "821ce3e6325c9d1eefa68495b9cc71ea89014c92ad94595db85c8fcb0fc1414a"
},
"downloads": -1,
"filename": "PyTDC-0.4.15.tar.gz",
"has_sig": false,
"md5_digest": "1d0f8b2616a27f6f057fd291c5a7b233",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 135215,
"upload_time": "2024-05-18T16:43:57",
"upload_time_iso_8601": "2024-05-18T16:43:57.494807Z",
"url": "https://files.pythonhosted.org/packages/11/a5/82af7891394666d1b894cf7891f3ff407d8d61d23a219c34701de09a3818/PyTDC-0.4.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-18 16:43:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mims-harvard",
"github_project": "TDC",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"circle": true,
"requirements": [
{
"name": "biopython",
"specs": [
[
"==",
"1.78"
]
]
},
{
"name": "dataclasses",
"specs": [
[
"==",
"0.6"
]
]
},
{
"name": "fuzzywuzzy",
"specs": [
[
"==",
"0.18.0"
]
]
},
{
"name": "huggingface_hub",
"specs": [
[
"==",
"0.20.3"
]
]
},
{
"name": "mygene",
"specs": [
[
"==",
"3.2.2"
]
]
},
{
"name": "numpy",
"specs": [
[
"==",
"1.26.4"
]
]
},
{
"name": "openpyxl",
"specs": [
[
"==",
"3.0.10"
]
]
},
{
"name": "pandas",
"specs": [
[
"==",
"2.1.4"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.31.0"
]
]
},
{
"name": "scikit-learn",
"specs": [
[
"==",
"1.2.2"
]
]
},
{
"name": "seaborn",
"specs": [
[
"==",
"0.12.2"
]
]
},
{
"name": "tqdm",
"specs": [
[
"==",
"4.65.0"
]
]
},
{
"name": "cellxgene-census",
"specs": [
[
"==",
"1.10.2"
]
]
},
{
"name": "gget",
"specs": [
[
"==",
"0.28.4"
]
]
},
{
"name": "pydantic",
"specs": [
[
"==",
"2.6.3"
]
]
},
{
"name": "rdkit",
"specs": [
[
"==",
"2023.9.5"
]
]
},
{
"name": "tiledbsoma",
"specs": [
[
"==",
"1.7.2"
]
]
},
{
"name": "yapf",
"specs": [
[
"==",
"0.40.2"
]
]
}
],
"lcname": "pytdc"
}
JSON
