Skip to content

Commit 54c0e0a

Browse files
committed
Improve readme
1 parent 95349c5 commit 54c0e0a

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,19 @@
1-
## Running the Code
1+
## Extracting the Dataset
22
In order to extract the features from the corpus proto files, run:
3-
python data_generation.py
43

4+
`python data_processing/data_generation.py`
5+
6+
In order for the command to be successful, it is necessary to have a directory
7+
_corpus/r252-corpus-features_ with the protos of the corpus. Optionally, it is possible to
8+
downloaded the extracted dataset at https://drive.google.com/file/d/14k4AgOVws4_TfPtDGefXzPn3x2Ph083h/view?usp=sharing. After putting the downloaded file
9+
under the _data/_ directory, it is possible to train and evaluate the model.
10+
11+
## Running the Models
512
In order to train a model and evaluate a model, run:
6-
python train.py --model_name="lstm_gcn_to_lstm_attention" --device=cuda:0 --print_every=10000
7-
--device="cuda" --attention=True --graph=True --iterations=500000
13+
`python training/train.py --model_name="lstm_gcn_to_lstm_attention"
14+
--print_every=10000 --attention=True --graph=True --iterations=500000`
815
All the possible options when running a model can be seen by running:
9-
python train.py --help
16+
`python train.py --help`
1017

1118
## Pretrained Models
1219
A pretrained version of the best performing model (as a state dictionary) can be downloaded at

0 commit comments

Comments
 (0)