Skip to content

Fix formatting #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hsm207 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix formatting #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#Retrofitting
# Retrofitting
Manaal Faruqui, manaalfar@gmail.com

This tool is used to post-process word vectors to incorporate
Expand All @@ -7,19 +7,19 @@ these word vectors are generally better in performance on semantic
tasks than the original word vectors. This tool can be used for
word vectors obtained from any vector training model.

###Requirements
### Requirements

1. Python 2.7

###Data you need
### Data you need
1. Word vector file
2. Lexicon file (provided here)

Each vector file should have one word vector per line as follows (space delimited):-

```the -1.0 2.4 -0.3 ...```

###Running the program
### Running the program

```python retrofit.py -i word_vec_file -l lexicon_file -n num_iter -o out_vec_file```

Expand All @@ -28,12 +28,12 @@ Each vector file should have one word vector per line as follows (space delimite
where, 'n' is an integer which specifies the number of iterations for which the
optimization is to be performed. Usually n = 10 gives reasonable results.

###Output
### Output
File: ```out_vec.txt```

which are your new retrofitted and (hopefully) improved word vectors, enjoy !

###Reference
### Reference

Main paper to be cited
```
Expand All @@ -46,4 +46,3 @@ Main paper to be cited
```

If you are using PPDB (Ganitkevitch et al, 2013), WordNet (Miller, 1995) or FrameNet (Baker et al, 1998) for enrichment please cite the corresponding papers.