Update README.md

README.md

@@ -1,3 +1,107 @@
 ---
 license: mit
+inference: false
 ---
+
+# Otter UBC Classifier Model Card
+
+
+## Model details
+Otter models are based on Graph Neural Networks (GNN) that propagates initial embeddings through a set of layers that upgrade input embedding according to the node neighbours. 
+The architecture of GNN consists of two main blocks: encoder and decoder. 
+- For encoder we first define a projection layer which consists of a set of linear transformations for each node modality and projects nodes into common dimensionality, then we apply several multi-relational graph convolutional layers (R-GCN) which distinguish between different types of edges between source and target nodes by having a set of trainable parameters for each edge type. 
+- For decoder we consider link prediction task, which consists of a scoring function that maps each triple of source and target nodes and the corresponding edge and maps that to a scalar number defined over interval [0; 1].
+
+
+**Model type:**
+
+For link prediction, we consider three choices of scoring functions: DistMult, TransE and a Binary Classifier that are commonly used in the literature. The outcomes of scoring of each triple are then compared against actual labels using negative log likelihood loss function.
+
+- Flow control: One crucial aspect of pretraining the GNN involves addressing the disparity between the data accessible during pretraining and the data accessible during subsequent tasks. Specifically, during pretraining, there are numerous attributes associated with proteins or drugs, whereas during downstream fine-tuning, only amino acid sequences and SMILES are available. Consequently, during pretraining, we explore two scenarios: one which controls the information propagated to the Drug/Protein entities and one without such control. In our experiments, we present results for both cases to provide an insight on the impact of restricting information flow during pretraining on the subsequent tasks. 
+- Noisy Links: An additional significant consideration is the presence of noisy links within the up-stream data and how they affect the downstream tasks. To investigate the potential impact on these tasks, we manually handpick a subset of links from each database that are relevant to drug discovery (see details in the Appendix). We then compare the outcomes when training the GNN using only these restricted links versus using all possible links present in the graphs. 
+- Regression: Certain pretraining datasets, like Uniprot, contain numerical data properties. Hence, we incorporate an extra regression objective aimed at minimizing the root mean square error (MSE) of the predicted numerical data properties. In the learning process, we combine the regression objective and the link prediction objective to create a single objective function.  
+
+| Scoring Type | Noisy Links | Flow Control | Regression |
+|--------------|:-----------:|--------------|------------|
+| Classifier Head | No       | Yes          | No         |
+
+**Model training data:**
+
+The model was trained over *UBC*. *UBC* is a dataset comprising entities (Proteins/Drugs) from  Uniprot (U), BindingDB (B) and. ChemBL (C). It contains 6,207,654 triples.
+
+**Model results:**
+
+<style type="text/css">
+.tg  {border-collapse:collapse;border-spacing:0;}
+.tg td{border-color:black;border-style:solid;border-width:1px;font-family:Arial, sans-serif;font-size:14px;
+  overflow:hidden;padding:10px 5px;word-break:normal;}
+.tg th{border-color:black;border-style:solid;border-width:1px;font-family:Arial, sans-serif;font-size:14px;
+  font-weight:normal;overflow:hidden;padding:10px 5px;word-break:normal;}
+.tg .tg-c3ow{border-color:inherit;text-align:center;vertical-align:top}
+.tg .tg-0pky{border-color:inherit;text-align:center;vertical-align:centr;text-emphasis:bold}
+</style>
+<table class="tg">
+<thead>
+  <tr>
+    <th class="tg-0pky">Dataset</th>
+    <th class="tg-c3ow">DTI DG</th>
+    <th class="tg-c3ow" colspan="3">DAVIS</th>
+    <th class="tg-c3ow" colspan="3">KIBA</th>
+  </tr>
+</thead>
+<tbody>
+  <tr>
+    <td class="tg-0pky">Splits</td>
+    <td class="tg-c3ow">Temporal</td>
+    <td class="tg-c3ow">Random</td>
+    <td class="tg-c3ow">Target</td>
+    <td class="tg-c3ow">Drug</td>
+    <td class="tg-c3ow">Random</td>
+    <td class="tg-c3ow">Target</td>
+    <td class="tg-c3ow">Drug</td>
+  </tr>
+  <tr>
+    <td class="tg-0pky">Results</td>
+    <td class="tg-c3ow">0.580</td>
+    <td class="tg-c3ow">0.810</td>
+    <td class="tg-c3ow">0.573</td>
+    <td class="tg-c3ow">0.104</td>
+    <td class="tg-c3ow">0.861</td>
+    <td class="tg-c3ow">0.631</td>
+    <td class="tg-c3ow">0.616</td>
+  </tr>
+</tbody>
+</table>
+
+**Model date:**
+
+
+**Paper or resources for more information:**
+- [GitHub Repo](https://github.com/IBM/otter-knowledge)
+
+**License:**
+
+MIT
+
+**Where to send questions or comments about the model:**
+- [GitHub Repo](https://github.com/IBM/otter-knowledge)
+
+## How to use
+
+Clone the repo:
+```sh
+git clone https://github.com/IBM/otter-knowledge.git
+cd otter-knowledge
+```
+- Run the inference for Proteins:
+  
+  *Replace test_data with the path to a CSV file containing the protein sequences, and name_of_the_column with the name of the column of the protein sequence in the CSV.*
+```python
+python inference --test test_data  --sequence_column name_of_the_column --model_path ibm/otter_ubc_classifier 
+```
+- Run the inference for Drugs:
+
+  *Replace test_data with the path to a CSV file containing the Drug SMILES, and name_of_the_column with the name of the column of the SMILES in the CSV.*
+```python
+python inference --test test_data --sequence_column name_of_the_column input_type Drug --relation_name smiles --model_path ibm/otter_ubc_classifier 
+```