Skip to content

Commit fabdf38

Browse files
authored
Update README.md
Improve readability
1 parent db7d1eb commit fabdf38

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,15 @@
44
[![Colab](https://img.shields.io/badge/GoogleColab-tiny.cc/catpred-red)](https://tiny.cc/catpred)
55
[![License](https://img.shields.io/badge/License-MIT-green)](LICENSE)
66

7+
---
8+
79
## 🚨 Announcements 📢
810

911
-**27th Dec 2024** - Updated repository with scripts to reproduce results from the manuscript.
1012
- 🚧 **TODO** - Add prediction codes for models using 3D-structural features.
1113

14+
---
15+
1216
## 📚 Table of Contents
1317

1418
- [Google Colab Interface](#colab-interface)
@@ -21,10 +25,14 @@
2125
- [License](#license)
2226
- [Citations](#citations)
2327

28+
---
29+
2430
## 🌐 Google Colab Interface <a name="colab-interface"></a>
2531

2632
For ease of use without any hardware requirements, a Google Colab interface is available here: [tiny.cc/catpred](http://tiny.cc/catpred). It contains sample data, instructions, and installation all in the Colab notebook.
2733

34+
---
35+
2836
## 💻 Local Installation <a name="local-installation"></a>
2937

3038
If you would like to install the package on a local machine, please follow the instructions below.
@@ -103,6 +111,8 @@ Run using:
103111

104112
For all results pertaining to CatPred, UniKP, DLKcat, and Baseline models, this method trains everything from scratch. Then, it uses the trained checkpoints to make predictions and analyzes them to reproduce results of the publications, including all main and supplementary figures.
105113

114+
---
115+
106116
## 🙏 Acknowledgements <a name="acknw"></a>
107117

108118
We thank the authors of the following open-source repositories:
@@ -111,10 +121,14 @@ We thank the authors of the following open-source repositories:
111121
- **Rotary PyTorch** - The rotary positional embeddings functionality for Seq-Attn. is from [Rotary PyTorch](https://github.com/lucidrains/rotary-embedding-torch).
112122
- **Progres** - Protein Graph Embedding Search using pre-trained EGNN models from [Progres](https://github.com/greener-group/progres.git).
113123

124+
---
125+
114126
## 📜 License <a name="license"></a>
115127

116128
This source code is licensed under the MIT license found in the `LICENSE` file in the root directory of this source tree.
117129

130+
---
131+
118132
## 📖 Citations <a name="citations"></a>
119133

120134
If you find the models useful in your research, we ask that you cite the relevant paper:

0 commit comments

Comments
 (0)