Update README.md

README.md

@@ -5,6 +5,8 @@ portuguese_wsc
 
 Solver for Winograd Schema Challenge in Portuguese. Portuguese translations for original Winograd Schema Challenge are also being proposed here.
 
+Preliminary results were presented on a conference paper: [Melo, Gabriela Souza de; Imaizumi, Vinicius A. ; Cozman, Fabio Gagliardi . Winograd Schemas in Portuguese. In: Encontro Nacional de Inteligência Artificial e Computacional, 2019](http://www.bracis2019.ufba.br/Camera_Ready/199152_1.pdf).
+
 ----
 
 ## Project Setup
@@ -15,11 +17,11 @@ Solver for Winograd Schema Challenge in Portuguese. Portuguese translations for
 
 - A Dockerfile is available, and may be used with `docker build -t wsc_port  .` followed by `nvidia-docker run -it -v $PWD/models:/code/models wsc_port`.
 
-- The Dockerfile contains a few different options for running, which can be selected by commenting and uncommenting the final sections of it.
-
-- For running outside of Docker container, Conda is required
+- The Dockerfile contains a few different options for running the code, which can be selected by commenting and uncommenting the final sections of it.
 
-- To create the conda environment: `conda env create -f environment.yml`
+- For running outside of the Docker container, Conda is required.
+
+    - To create the conda environment: `conda env create -f environment.yml`
 
 - Makefile contains some of the commands used to run the code. These commands must be run from inside the environment.
 
@@ -29,7 +31,7 @@ Solver for Winograd Schema Challenge in Portuguese. Portuguese translations for
     - `make winograd_test` runs evaluation of Winograd Schema Challenge
     - `make generate` runs language model for generation of text
 
-- Code runs for both English and Portuguese cases, and this setting is controlled by the variable `PORTUGUESE` in `src.consts`
+- Code runs for both English and Portuguese cases, and this setting is controlled by the variable `PORTUGUESE` in `src.consts`.
 
 - Run tests with `make tests`, which is equivalent to `pytest --cov=src tests/`. Use `pytest --cov=src --cov-report=html tests/` for generation of HTML test report. Needs pytest and pytest-cov packages. If there are import errors, should run `pip install -e .` to locally install package from source code.
 
@@ -52,19 +54,12 @@ Solver for Winograd Schema Challenge in Portuguese. Portuguese translations for
     │
     ├── githooks           <- Contains githooks scripts being used for development. Git hook directory for repo needs to be set to this folder.
     │
-    ├── models             <- Trained and serialized models, model predictions, or model summaries.
-    │
-    ├── notebooks          <- Jupyter notebooks. Naming convention is a number (for ordering),
-    │                         the creator's initials, and a short `-` delimited description, e.g.
-    │                         `1.0-jqp-initial-data-exploration`.
+    ├── models             <- Trained and serialized models, model predictions, or model summaries. Gitignored due to their size.
     │
-    ├── reports            <- Generated analysis as HTML, PDF, LaTeX, etc.
-    │   └── figures        <- Generated graphics and figures to be used in reporting.
+    ├── notebooks          <- Jupyter notebooks, used during experimentation and testing.
     │
     ├── src                <- Source code for use in this project.
-    │   ├── __init__.py    <- Makes src a Python module.
-    │   │
-    │   └── scripts           
+    │   ├── __init__.py    <- Makes src a Python module. 
     └── tests              <- Tests module, using Pytest.
 
 <p><small>Project based on the <a target="_blank" href="https://drivendata.github.io/cookiecutter-data-science/">cookiecutter data science project template</a>. #cookiecutterdatascience</small></p>
@@ -75,20 +70,4 @@ Solver for Winograd Schema Challenge in Portuguese. Portuguese translations for
 
 - Code for Language Model based on [Pytorch's Word-level language modeling RNN example](https://github.com/pytorch/examples/tree/master/word_language_model)
 - Code for parallelization of PyTorch model based on [PyTorch-Encoding package](https://github.com/zhanghang1989/PyTorch-Encoding) with help from [this medium post](https://medium.com/huggingface/training-larger-batches-practical-tips-on-1-gpu-multi-gpu-distributed-setups-ec88c3e51255).
-- Idea of using language model for solving Winograd Schema Challenge based on paper "A Simple Method for Commonsense Reasoning":
-```
-@article{DBLP:journals/corr/abs-1806-02847,
-  author    = {Trieu H. Trinh and
-               Quoc V. Le},
-  title     = {A Simple Method for Commonsense Reasoning},
-  journal   = {CoRR},
-  volume    = {abs/1806.02847},
-  year      = {2018},
-  url       = {http://arxiv.org/abs/1806.02847},
-  archivePrefix = {arXiv},
-  eprint    = {1806.02847},
-  timestamp = {Mon, 13 Aug 2018 16:46:22 +0200},
-  biburl    = {https://dblp.org/rec/bib/journals/corr/abs-1806-02847},
-  bibsource = {dblp computer science bibliography, https://dblp.org}
-}
-```
+- Idea of using language model for solving Winograd Schema Challenge based on the paper ["A Simple Method for Commonsense Reasoning"](https://arxiv.org/abs/1806.02847), by Trieu H. Trinh and Quoc V. Le, 2018.