poincare-embedding

These codes implement Poincar'e Embedding introduced in the following paper:

Maximilian Nickel and Douwe Kiela, "Poincar'e Embeddings for Learning Hierarchical Representations'", arXiv preprint arXiv:1705.08039, 2017.

Requirements

• C++ compiler that supports c++14 or later
  • for Windows user, using cygwin is recommended (with CMAKE and gcc/g++ selection) (thanks @patrickgitacc)

Build

cd poincare-embedding
mkdir work & cd work
cmake ..
make

Setup python environment

From the poincare-embeddings directory...

python3 -m venv venv
source venv/bin/activate

if using windows:

python3 -m venv venv
venv\Scripts\activate

Then run the following:

python3 -m pip install -r requirements.txt
python3 -c "import nltk; nltk.download('wordnet')"

Tutorial

We assume that you are in work directory

cd poincare-embedding
mkdir work & cd work

Data Creation

You can create WordNet noun hypernym pairs as follows

python ../scripts/create_wordnet_noun_hierarchy.py ./wordnet_noun_hypernyms.tsv

and mammal subtree is created by

python ../scripts/create_mammal_subtree.py ./mammal_subtree.tsv

Run

./poincare_embedding ./mammal_subtree.tsv ./embeddings.tsv -d 2 -t 8 -e 1000 -l 0.1 -L 0.0001 -n 20 -s 0

Plot a Mammal Tree

python ../scripts/plot_mammal_subtree.py ./embeddings.tsv --center_mammal

Note: if that doesn't work, may need to run the following:

tr -d '\015' < embeddings.tsv > embeddings_clean.tsv

Double check that the file has removed the character in question, then run

mv embeddings_clean.tsv embeddings.tsv