{"id":13676038,"url":"https://github.com/TatsuyaShirakawa/poincare-embedding","last_synced_at":"2025-04-29T03:30:30.395Z","repository":{"id":201630230,"uuid":"95230318","full_name":"TatsuyaShirakawa/poincare-embedding","owner":"TatsuyaShirakawa","description":"Poincaré Embedding (unofficial)","archived":false,"fork":false,"pushed_at":"2019-05-07T09:41:51.000Z","size":243,"stargazers_count":232,"open_issues_count":1,"forks_count":27,"subscribers_count":12,"default_branch":"master","last_synced_at":"2024-11-11T17:45:39.998Z","etag":null,"topics":["hyperbolic-geometry","machine-learning","representation-learning"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TatsuyaShirakawa.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2017-06-23T15:00:09.000Z","updated_at":"2024-09-09T07:51:44.000Z","dependencies_parsed_at":null,"dependency_job_id":"a6700070-9093-44a3-b664-195f8627634b","html_url":"https://github.com/TatsuyaShirakawa/poincare-embedding","commit_stats":null,"previous_names":["tatsuyashirakawa/poincare-embedding"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TatsuyaShirakawa%2Fpoincare-embedding","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TatsuyaShirakawa%2Fpoincare-embedding/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TatsuyaShirakawa%2Fpoincare-embedding/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TatsuyaShirakawa%2Fpoincare-embedding/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TatsuyaShirakawa","download_url":"https://codeload.github.com/TatsuyaShirakawa/poincare-embedding/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251426691,"owners_count":21587633,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hyperbolic-geometry","machine-learning","representation-learning"],"created_at":"2024-08-02T13:00:16.748Z","updated_at":"2025-04-29T03:30:29.679Z","avatar_url":"https://github.com/TatsuyaShirakawa.png","language":"C++","funding_links":[],"categories":["C++"],"sub_categories":[],"readme":"# poincare-embedding\n\nThese codes implement Poincar\\'e Embedding introduced in the following paper:\n\n[Maximilian Nickel and Douwe Kiela, \"Poincar\\'e Embeddings for Learning Hierarchical Representations'\", arXiv preprint arXiv:1705.08039, 2017.](https://arxiv.org/abs/1705.08039)\n\n## Requirements\n\n- C++ compiler that supports c++14 or later\n    - for Windows user, using cygwin is recommended (with CMAKE and gcc/g++ selection) (thanks @patrickgitacc)\n\n## Build\n\n```shell\ncd poincare-embedding\nmkdir work \u0026 cd work\ncmake ..\nmake\n```\n\n## Setup python environment\n\nFrom the poincare-embeddings directory...\n\n```shell\npython3 -m venv venv\nsource venv/bin/activate\n```\n\nif using windows:\n\n```shell\npython3 -m venv venv\nvenv\\Scripts\\activate\n```\n\nThen run the following:\n\n```shell\npython3 -m pip install -r requirements.txt\npython3 -c \"import nltk; nltk.download('wordnet')\"\n```\n\n## Tutorial\n\nWe assume that you are in work directory\n\n\n```shell\ncd poincare-embedding\nmkdir work \u0026 cd work\n```\n\n### Data Creation\n\nYou can create WordNet noun hypernym pairs as follows\n\n```shell\npython ../scripts/create_wordnet_noun_hierarchy.py ./wordnet_noun_hypernyms.tsv\n```\n\nand mammal subtree is created by\n\n```shell\npython ../scripts/create_mammal_subtree.py ./mammal_subtree.tsv\n```\n\n### Run\n\n```shell\n./poincare_embedding ./mammal_subtree.tsv ./embeddings.tsv -d 2 -t 8 -e 1000 -l 0.1 -L 0.0001 -n 20 -s 0\n```\n### Plot a Mammal Tree\n\n```shell\npython ../scripts/plot_mammal_subtree.py ./embeddings.tsv --center_mammal\n```\n\nNote: if that doesn't work, may need to run the following:\n\n```shell\ntr -d '\\015' \u003c embeddings.tsv \u003e embeddings_clean.tsv\n```\n\nDouble check that the file has removed the character in question, then run\n\n```shell\nmv embeddings_clean.tsv embeddings.tsv\n```\n\n![mammal.png](./misc/mammal.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTatsuyaShirakawa%2Fpoincare-embedding","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FTatsuyaShirakawa%2Fpoincare-embedding","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTatsuyaShirakawa%2Fpoincare-embedding/lists"}