Skip to content
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.

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

Link to the two sub packages #20

Closed
RemyLau opened this issue Sep 22, 2022 · 4 comments
Closed

Link to the two sub packages #20

RemyLau opened this issue Sep 22, 2022 · 4 comments

Comments

@RemyLau
Copy link

RemyLau commented Sep 22, 2022

Hi, first of all, thanks for making such an amazing graph embedding resource!

I'm wondering whether you can add some descriptions in the README clarifying that this repo is a thin wrapper of the two core packages embiggen and ensmallen and add links accordingly. I was a bit confused for a few minutes trying to find the source code and only came to realize it wraps the two libraries after looking at __init__.py.

@LucaCappelletti94
Copy link
Member

In Embiggen and Ensmallen README, we say, "these are a submodule of GRAPE. Refer to the GRAPE library for documentation etc...", but I did not think to write this the other way around, which we can surely add to avoid confusion.

This is mainly done because of software engineering needs since the tooling necessary to build Ensmallen is significantly different and much more complex than what is needed for Embiggen.

@RemyLau
Copy link
Author

RemyLau commented Sep 22, 2022

In Embiggen and Ensmallen README, we say, "these are a submodule of GRAPE. Refer to the GRAPE library for documentation etc...", but I did not think to write this the other way around, which we can surely add to avoid confusion.

This is mainly done because of software engineering needs since the tooling necessary to build Ensmallen is significantly different and much more complex than what is needed for Embiggen.

I see! Yeah, I think adding a similar note to the Grape README could be helpful for users since the API they know of / use would be Grape.

@LucaCappelletti94
Copy link
Member

I have added a short line on this at the beginning of the README. Does it fit the bill, in your opinion?

@RemyLau
Copy link
Author

RemyLau commented Sep 23, 2022

Yes it looks great!

@RemyLau RemyLau closed this as completed Sep 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants