Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
m-yoshinaka committed Jul 3, 2020
1 parent cc886b9 commit 4a6621c
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,21 @@

We explain the details of SAPPHIRE in the following paper.
```
@inproceedings{yoshinaka-2020,
@inproceedings{yoshinaka-etal-2020,
author = {Yoshinaka, Masato and Kajiwara, Tomoyuki and Arase, Yuki},
title = {SAPPHIRE: Simple Aligner for Phrasal Paraphrase with Hierarchical Representaion},
booktitle = {Proceedings of the 12th International Conference on Language Resources and Evaluation (LREC 2020)},
year = {2020},
pages = {(to appear)},
url = {(to appear)}
pages = {6861--6867},
url = {https://www.aclweb.org/anthology/2020.lrec-1.847/}
}
```


## Description

SAPPHIRE depends only on a pre-trained word embedding.
Therefore, it is easily transferable to specific domains and different languages.
SAPPHIRE depends only on a pre-trained word embedding.
Therefore, it is easily transferable to specific domains and different languages.
This library is designed for a pre-trained model of [fastText](https://fasttext.cc/).
But it is easy to replace the model.

Expand All @@ -32,13 +32,13 @@ But it is easy to replace the model.

## Installation (for fastText version)

1. Install requirements
1. Install requirements
After cloning this repository, go to the root directory and install requirements.
```
$ pip install -r requirements.txt
```

2. Install SAPPHIRE
2. Install SAPPHIRE
Installation with `develop` option allows you to change the parameters and add scripts for other word representations.
```
$ python setup.py develop
Expand All @@ -47,7 +47,7 @@ $ python setup.py develop

3. Download the pre-trained model of fastText (or prepare your model of fastText) and move it to *model* directory.
```
$ curl -O https://dl.fbaipublicfiles.com/fasttext/vectors-english/wiki-news-300d-1M-subword.bin.zip
$ curl -O https://dl.fbaipublicfiles.com/fasttext/vectors-english/wiki-news-300d-1M-subword.bin.zip
$ unzip wiki-news-300d-1M-subword.bin.zip
$ mkdir model
$ mv wiki-news-300d-1M-subword.bin model/
Expand All @@ -74,5 +74,5 @@ After preparing a **tokenized** sentence pair (`tokenized_sentence_a: list` and
>>> print(alignment)
[(1, 3, 2, 3), (8, 9, 5, 6), (13, 13, 8, 8), (27, 27, 9, 9)]
```
phrase pair ($x, y$) : ($x_\text{start}, x_\text{end}, y_\text{start}, y_\text{end}$)
phrase pair ($x, y$) : ($x_\text{start}, x_\text{end}, y_\text{start}, y_\text{end}$)
\# 1-indexed alignment

0 comments on commit 4a6621c

Please sign in to comment.