Skip to content

Documentation: Unclear documentation for PoincareRelations #2244

@gokul-uf

Description

@gokul-uf

Description

The documentation for PoincareRelations specifies that the input should be a file with one relation per line. In case the relation is assymetric (as is the case with hypernymy) it is not clear whether the pairs should be
a. (u, v) where u is a v ex. u = cat, v = mammal
b. (u, v) where v is a u ex. u = mammal, v = cat

This maybe clear to people working in this area, but a bit confusing to people just starting with PoincareModel.

Thanks!

Metadata

Metadata

Assignees

No one assigned

    Labels

    difficulty easyEasy issue: required small fixdocumentationCurrent issue related to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions