Skip to content
Snippets Groups Projects
Commit e2af5040 authored by friebolin's avatar friebolin
Browse files

Update structure

parent 2478b101
No related branches found
No related tags found
No related merge requests found
......@@ -172,7 +172,7 @@ pip install -r requirements.txt
***
## ⚙️ Usage <a name="usage"></a>
🚀 Launch our application by following the steps below:
#### 🚀 Launch our application by following the steps below:
```bash
./main.py <COMMAND> <ARGUMENTS>...
......@@ -215,13 +215,13 @@ For `<COMMAND>` you must enter one of the commands you find in the list below, w
|🔛 **`-tb`**/**`--test_batch_size`**|Specifies the batch size for the test process.|Default is $16$.|
📝 If you want to use our *backtranslation* code, you must execute the following:
#### 📝 If you want to use our *backtranslation* code, you must execute the following:
```bash
python3 Code/backtranslate.py
```
🎥 If you want to see a demo of our model, you can enter your own sentence and let the model predict if a target word is used in its `literal` or `non-literal` sense:
#### 🎥 If you want to see a demo of our model, you can enter your own sentence and let the model predict if a target word is used in its `literal` or `non-literal` sense:
```bash
python3 inference.py
......@@ -234,8 +234,9 @@ python3 inference.py
## 🏯 Code-Structure <a name="code-structure"></a>
- ⚙️ [`requirements.txt`](requirements.txt): All necessary modules to install.
- 📱 [`main.py`](main.py): Our main code file which does ...
- 💻 [`Code`](code): Here, you can find all code files for our different models and data augmentation methods.
- 📱 [`main.py`](main.py): Our main code file is responsible for organizing input options and calling the necessary functions to preprocess datasets, train the model, and evaluate it on a test set.
- 🎥 [`inference.py`](inference.py): Run a demo version of our to test if an input sentence contains a metonymy.
- 💻 [`Code`](code): Here, you can find all code files for our different models and data augmentation methods, as well as a [`submit_template.sh`](Code/submit_template.sh).
- 📀 [`data`](data): Find all datasets in this folder.
- 🗂️ [`backtranslations`](data/backtranslations): Contains unfiltered generated paraphrases.
- 🗂️ [`fused_datasets`](data/fused_datasets): Contains original datasets fused with filtered paraphrases. Ready to be used for training the models.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment