first commit

Author: andreagemelli

.gitignore

@@ -0,0 +1,8 @@
+# system
+*.egg-info/
+__pycache__/
+*.py[cod]
+
+#user-defined
+dataset
+_old

LICENCE

@@ -0,0 +1,11 @@
+
+The MIT License (MIT)
+Copyright (c) 2022
+Andrea Gemelli
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

README.md

@@ -0,0 +1,27 @@
+# Documents 2 Graph
+- [Documents 2 Graph](#documents-2-graph)
+    - [Info](#info)
+    - [Install](#install)
+    - [Results](#results)
+    - [Usage](#usage)
+
+### Info
+Library to convert documents to graphs and perform several tasks on different datasets, like KIE on FUNSD.
+
+### Install
+```
+pip install .
+```
+
+### Results
+
+### Usage
+1. To train a **GCN** model for **Entity Labeling** on FUNSD (using CPU):
+```
+python src/main.py
+```
+
+2. To test a trained **GCN** model for **Entity Labeling** on FUNSD (using GPU):
+```
+python src/main.py --gpu 0 --config gcn --test -w output/weights/gcn-1651069965.pt
+```

configs/base.yaml

@@ -0,0 +1,14 @@
+MODEL:
+    # which model to use (choose one)
+    name: GCN # GAT, ...
+    num_layers: 3
+    hidden_dim: 64
+    dropout: 0.
+
+TRAIN:
+    lr: 0.01
+    weight_decay: 0.0005
+    epochs: 1000
+    batch_size: 1
+
+

configs/cv-1650992863.yaml

@@ -0,0 +1,17 @@
+INFO:
+  f1-macro: 0.5423
+  f1-micro: 0.6211
+  features: false
+  split: 0
+  total_params: 9604
+  val_loss: 0.7864165306091309
+MODEL:
+  dropout: 0.0
+  hidden_dim: 64
+  name: GCN
+  num_layers: 3
+TRAIN:
+  batch_size: 134
+  epochs: 1000
+  lr: 0.01
+  weight_decay: 0.0005

configs/cv-1651004399.yaml

@@ -0,0 +1,17 @@
+INFO:
+  f1-macro: 0.6133
+  f1-micro: 0.7326
+  features: true
+  split: 0
+  total_params: 13508
+  val_loss: 0.5918518304824829
+MODEL:
+  dropout: 0.0
+  hidden_dim: 64
+  name: GCN
+  num_layers: 2
+TRAIN:
+  batch_size: 14
+  epochs: 1000
+  lr: 0.01
+  weight_decay: 0.0005

configs/gcn.yaml

@@ -0,0 +1,17 @@
+INFO:
+  f1-macro: 0.6133
+  f1-micro: 0.7326
+  features: true
+  split: 0
+  total_params: 13508
+  val_loss: 0.5918518304824829
+MODEL:
+  dropout: 0.0
+  hidden_dim: 64
+  name: GCN
+  num_layers: 3
+TRAIN:
+  batch_size: 14
+  epochs: 1000
+  lr: 0.01
+  weight_decay: 0.0005

output/results/gcn-1651069965.json

@@ -0,0 +1 @@
+{"model": "GCN", "net-params": 9604, "features": "bbox", "val-loss": 0.7924164533615112, "f1-scores": [0.5682672628614822, 0.6462555066079295]}

output/results/gcn-1651070043.json

@@ -0,0 +1 @@
+{"model": "GCN", "net-params": 21892, "features": "text", "val-loss": 0.6191630959510803, "f1-scores": [0.6324179962172749, 0.73568281938326]}