ZhiyuanChen commited on
Commit
1dde6f9
·
verified ·
1 Parent(s): 8b705ba

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +79 -5
README.md CHANGED
@@ -11,12 +11,86 @@ sdk_version: 5.16.0
11
  ---
12
 
13
 
14
- <p style="text-align: center;">Developed by DanLing on Earth</p>
15
 
16
- We are a community of scientists, researchers, engineers, and others who are working together to push the boundaries of what is possible with Deep Learning.
 
17
 
18
- We are a community of individuals from around the world who seek to make Deep Learning more accessible.
19
 
20
- We are passionate about Deep Learning and the people who use it.
 
 
21
 
22
- We are DanLing.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
11
  ---
12
 
13
 
14
+ # [MultiMolecule](https://multimolecule.danling.org)
15
 
16
+ > [!TIP]
17
+ > Accelerate Molecular Biology Research with Machine Learning
18
 
19
+ [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.15119050.svg)](https://doi.org/10.5281/zenodo.15119050)
20
 
21
+ [![Codacy - Quality](https://app.codacy.com/project/badge/Grade/ad5fd8904c2e426bb0a865a9160d6c69)](https://app.codacy.com/gh/DLS5-Omics/multimolecule/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
22
+ [![Codacy - Coverage](https://app.codacy.com/project/badge/Coverage/ad5fd8904c2e426bb0a865a9160d6c69)](https://app.codacy.com/gh/DLS5-Omics/multimolecule/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
23
+ [![CodeCov - Coverage](https://codecov.io/gh/DLS5-Omics/multimolecule/graph/badge.svg?token=G9WGWCOFQE)](https://codecov.io/gh/DLS5-Omics/multimolecule)
24
 
25
+ [![PyPI - Version](https://img.shields.io/pypi/v/multimolecule)](https://pypi.org/project/multimolecule)
26
+ [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/multimolecule)](https://pypi.org/project/multimolecule)
27
+ [![Downloads Statistics](https://static.pepy.tech/badge/multimolecule/month)](https://multimolecule.danling.org)
28
+
29
+ [![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
30
+
31
+ ## 🧬 Introduction
32
+
33
+ MultiMolecule is a framework that bridges molecular biology and machine learning. It offers machine learning tools specifically designed for biomolecular data (RNA, DNA, and protein).
34
+
35
+ MultiMolecule serves as a foundation for advancing research at the intersection of molecular biology and machine learning.
36
+
37
+ ## 🚀 Features
38
+
39
+ ### 📑 Resources
40
+
41
+ - **[Model Hub](https://multimolecule.danling.org/models)**: Models designed for biomolecular data.
42
+ - **[Dataset Hub](https://multimolecule.danling.org/datasets)**: Processed biomolecular datasets.
43
+
44
+ ### 🛠️ Tools
45
+
46
+ - **[`pipelines`](pipelines)**: End-to-end workflows for applying models.
47
+ - **[`runner`](runner)**: Automatic Runner for training models.
48
+
49
+ ### ⚙️ Infrastructure
50
+
51
+ - **[`data`](data)**: Smart [`Dataset`][multimolecule.data.Dataset] that automatically infer tasks—including their level (sequence, token, contact) and type (classification, regression).
52
+ - **[`tokenisers`](tokenisers)**: Tokenizers for biomolecular sequences.
53
+ - **[`module`](module)**: Neural network building blocks.
54
+
55
+ ## 🔧 Installation
56
+
57
+ === "Install the stable release from PyPI"
58
+
59
+ ```bash
60
+ pip install multimolecule
61
+ ```
62
+
63
+ === "Install the latest development version"
64
+
65
+ ```bash
66
+ pip install git+https://github.com/DLS5-Omics/multimolecule
67
+ ```
68
+
69
+ ## 📜 Citation
70
+
71
+ If you use MultiMolecule in your research, please cite us as follows:
72
+
73
+ ```bibtex
74
+ @software{chen_2024_12638419,
75
+ author = {Chen, Zhiyuan and Zhu, Sophia Y.},
76
+ title = {MultiMolecule},
77
+ doi = {10.5281/zenodo.12638419},
78
+ publisher = {Zenodo},
79
+ url = {https://doi.org/10.5281/zenodo.12638419},
80
+ year = 2024,
81
+ month = may,
82
+ day = 4
83
+ }
84
+ ```
85
+
86
+ ## 📄 License
87
+
88
+ We believe openness is the Foundation of Research.
89
+
90
+ MultiMolecule is licensed under the [GNU Affero General Public License](license.md).
91
+
92
+ For additional terms and clarifications, please refer to our [License FAQ](license-faq.md).
93
+
94
+ Please join us in building an open research community.
95
+
96
+ `SPDX-License-Identifier: AGPL-3.0-or-later`