ervau commited on
Commit
e45f9f9
·
verified ·
1 Parent(s): 0faf9d5

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +41 -31
README.md CHANGED
@@ -6,52 +6,60 @@ pretty_name: ProtHGT Knowledge Graph Data & Pretrained Checkpoints
6
  ---
7
 
8
  # ProtHGT Knowledge Graph Data & Pretrained Checkpoints
9
- This repository provides the **knowledge graph (KG) `.pt` files** and **pretrained model checkpoints** used in **ProtHGT: Heterogeneous Graph Transformers for Automated Protein Function Prediction Using Biological Knowledge Graphs and Language Models**.
10
  - **Code (training & prediction)**: https://github.com/HUBioDataLab/ProtHGT
11
 
12
  ---
13
 
14
  ## What’s Inside
 
 
 
15
 
16
- ### data/
17
- PyTorch Geometric-compatible KG files:
18
- - Full KG file (e.g., `prothgt-kg.pt`)
19
- - Train/validation/test splits (e.g., `prothgt-*-graph.pt`)
20
- - Alternative KG versions under `alternative_protein_embeddings/` (e.g., `esm2/`, `prott5/`), where the protein node features differ by embedding type.
21
 
22
- **Available Files**
23
  ```
24
- ├── prothgt-kg.pt # The default full knowledge graph containing TAPE embeddings as the initial protein representations.
25
- ├── prothgt-train-graph.pt # Training set (80% of the default full KG).
26
- ├── prothgt-val-graph.pt # Validation set (10% of the default full KG).
27
- ├── prothgt-test-graph.pt # Test set (10% of the default full KG).
28
- └── alternative_protein_embeddings/ # Contains alternative KGs with different protein representations.
29
- ├──apaac/
30
- │ └── ...
31
- ├──esm2/
32
- │ └── ...
33
- └──prott5/
34
- └── ...
35
  ```
36
 
 
 
 
 
 
 
 
 
 
 
37
 
38
  ### models/
39
- Pretrained ProtHGT models (`.pt`). Models are provided:
40
- - per GO sub-ontology (e.g., Molecular Function / Biological Process / Cellular Component)
41
- - per protein embedding type (default vs `esm2` / `prott5` / etc.)
42
 
43
- **Important:** Use a model checkpoint that matches the KG embedding variant you are using.
 
 
 
 
 
 
 
 
44
 
45
- **Available Files**
46
  ```
47
- ├── prothgt-model-molecular-function.pt # Pretrained ProtHGT checkpoint for Molecular Function (default/TAPE-based KG).
48
- ├── prothgt-model-biological-process.pt # Pretrained ProtHGT checkpoint for Biological Process (default/TAPE-based KG).
49
- ├── prothgt-model-cellular-component.pt # Pretrained ProtHGT checkpoint for Cellular Component (default/TAPE-based KG).
50
- └── alternative_protein_embeddings/ # Models trained with alternative protein representations.
51
- ├── esm2/
52
- │ └── ...
53
- └── prott5/
54
- └── ...
55
  ```
56
 
57
  ---
@@ -63,6 +71,8 @@ Key scripts:
63
  - `train.py` — trains ProtHGT using the provided KG splits
64
  - `predict.py` — runs inference using pretrained checkpoints
65
 
 
 
66
  ---
67
 
68
  ### Citation
 
6
  ---
7
 
8
  # ProtHGT Knowledge Graph Data & Pretrained Checkpoints
9
+ This repository provides the **knowledge graph (KG) `.pt` files** and **pretrained model checkpoints** used in **ProtHGT: Heterogeneous Graph Transformers for Automated Protein Function Prediction Using Knowledge Graphs and Language Models**.
10
  - **Code (training & prediction)**: https://github.com/HUBioDataLab/ProtHGT
11
 
12
  ---
13
 
14
  ## What’s Inside
15
+ Files are organized by task: `go/` for GO term prediction and `ec/` for EC number prediction,
16
+ under both `knowledge_graphs/` and `models/`. In each task, the top-level files use the default TAPE protein embeddings,
17
+ and `alternative_protein_embeddings/` holds versions whose protein node features use ESM-2 or ProtT5 instead.
18
 
19
+ ### knowledge_graphs/
20
+ PyTorch Geometric-compatible KG files: a full KG plus train/validation/test splits per task.
 
 
 
21
 
22
+ **GO term prediction — `knowledge_graphs/go/`**
23
  ```
24
+ ├── prothgt-kg.pt # The default full knowledge graph (TAPE embeddings).
25
+ ├── prothgt-train-graph.pt # Training set (80% of the full KG).
26
+ ├── prothgt-val-graph.pt # Validation set (10%).
27
+ ├── prothgt-test-graph.pt # Test set (10%).
28
+ └── alternative_protein_embeddings/ # ESM-2 / ProtT5 variants.
29
+ ├── esm2/ prothgt-esm2-{kg,train-graph,val-graph,test-graph}.pt
30
+ └── prott5/ prothgt-prott5-{kg,train-graph,val-graph,test-graph}.pt
 
 
 
 
31
  ```
32
 
33
+ **EC number prediction — `knowledge_graphs/ec/`**
34
+ ```
35
+ ├── prothgt-ec-kg.pt # The default full EC knowledge graph (TAPE embeddings).
36
+ ├── prothgt-ec-train-graph.pt # Training set.
37
+ ├── prothgt-ec-val-graph.pt # Validation set.
38
+ ├── prothgt-ec-test-graph.pt # Test set (transductive: training proteins' EC edges injected).
39
+ └── alternative_protein_embeddings/ # ESM-2 / ProtT5 variants.
40
+ ├── esm2/ prothgt-ec-esm2-{kg,train-graph,val-graph,test-graph}.pt
41
+ └── prott5/ prothgt-ec-prott5-{kg,train-graph,val-graph,test-graph}.pt
42
+ ```
43
 
44
  ### models/
45
+ Pretrained ProtHGT checkpoints (`.pt`). **Use a checkpoint that matches the KG embedding variant you are using.**
 
 
46
 
47
+ **GO term prediction — `models/go/`** (one model per GO sub-ontology × embedding)
48
+ ```
49
+ ├── prothgt-model-molecular-function.pt # default TAPE-based KG
50
+ ├── prothgt-model-biological-process.pt
51
+ ├── prothgt-model-cellular-component.pt
52
+ └── alternative_protein_embeddings/ # ESM-2 / ProtT5 variants.
53
+ ├── esm2/ prothgt-esm2-model-{molecular-function,biological-process,cellular-component}.pt
54
+ └── prott5/ prothgt-prott5-model-{molecular-function,biological-process,cellular-component}.pt
55
+ ```
56
 
57
+ **EC number prediction — `models/ec/`** (one joint hierarchical model per embedding, predicting all four EC levels)
58
  ```
59
+ ├── prothgt-ec-model.pt # default TAPE-based KG
60
+ └── alternative_protein_embeddings/ # ESM-2 / ProtT5 variants.
61
+ ├── esm2/ prothgt-ec-esm2-model.pt
62
+ └── prott5/ prothgt-ec-prott5-model.pt
 
 
 
 
63
  ```
64
 
65
  ---
 
71
  - `train.py` — trains ProtHGT using the provided KG splits
72
  - `predict.py` — runs inference using pretrained checkpoints
73
 
74
+ GO term prediction lives at the top level of `src/`; EC number prediction is in `src/ec/`.
75
+
76
  ---
77
 
78
  ### Citation