Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/TatsuyaShirakawa/poincare-embedding
Poincaré Embedding (unofficial)
https://github.com/TatsuyaShirakawa/poincare-embedding
hyperbolic-geometry machine-learning representation-learning
Last synced: about 2 months ago
JSON representation
Poincaré Embedding (unofficial)
- Host: GitHub
- URL: https://github.com/TatsuyaShirakawa/poincare-embedding
- Owner: TatsuyaShirakawa
- License: mit
- Created: 2017-06-23T15:00:09.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-05-07T09:41:51.000Z (over 5 years ago)
- Last Synced: 2024-06-17T09:34:53.234Z (3 months ago)
- Topics: hyperbolic-geometry, machine-learning, representation-learning
- Language: C++
- Homepage:
- Size: 237 KB
- Stars: 230
- Watchers: 12
- Forks: 28
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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.](https://arxiv.org/abs/1705.08039)
## 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
```shell
cd poincare-embedding
mkdir work & cd work
cmake ..
make
```
## Setup python environment
From the poincare-embeddings directory...
```shell
python3 -m venv venv
source venv/bin/activate
```
if using windows:
```shell
python3 -m venv venv
venv\Scripts\activate
```
Then run the following:
```shell
python3 -m pip install -r requirements.txt
python3 -c "import nltk; nltk.download('wordnet')"
```
## Tutorial
We assume that you are in work directory
```shell
cd poincare-embedding
mkdir work & cd work
```
### Data Creation
You can create WordNet noun hypernym pairs as follows
```shell
python ../scripts/create_wordnet_noun_hierarchy.py ./wordnet_noun_hypernyms.tsv
```
and mammal subtree is created by
```shell
python ../scripts/create_mammal_subtree.py ./mammal_subtree.tsv
```
### Run
```shell
./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
```shell
python ../scripts/plot_mammal_subtree.py ./embeddings.tsv --center_mammal
```
Note: if that doesn't work, may need to run the following:
```shell
tr -d '\015' < embeddings.tsv > embeddings_clean.tsv
```
Double check that the file has removed the character in question, then run
```shell
mv embeddings_clean.tsv embeddings.tsv
```
