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

Package naming #75

Closed
lorenzwalthert opened this issue Aug 17, 2021 · 3 comments · Fixed by #88
Closed

Package naming #75

lorenzwalthert opened this issue Aug 17, 2021 · 3 comments · Fixed by #88
Assignees

Comments

@lorenzwalthert
Copy link

lorenzwalthert commented Aug 17, 2021

Hi @yitao-li, cool work 🥳 .I know you already published on CRAN but I was just wondering if the package should be renamed {cuml} to make it consistent with existing R ML packages from the tidy/mlverse:

  • keras (and not kerasR, which is another R interface)
  • tensorflow
  • torch (and not rTorch, which is another R interface)
  • tabnet
  • ...

Given that this package is not yet widely used or advertised, I name change would be relatively 'cheap'. I know I have no stake in this what so ever, just thinking out loud. Feel free to close with no comment :-)

@yitao-li
Copy link
Contributor

I see. That's a great suggestion! Thanks. I didn't even realize there was this naming convention : )

@yitao-li
Copy link
Contributor

yitao-li commented Aug 17, 2021

I'm inclined to rename cuml4r to cuml, but then realized there are some places where cuml the C++ library and the cuml4r the R package are mentioned in the same sentence or in the same paragraph within the roxygen docs. This makes the cuml4r to cuml renaming a bit challenging. E.g., there are (and will be more) places where I need to say if cuml4r is not compiled and linked with a valid version of cuml, then X will not happen and Y will happen instead... 🤔

I guess I can say "... not compiled and linked with a valid version of libcuml..." instead, but still, cuml4r somehow sounds like the least confusing name in those places 😄

@lorenzwalthert
Copy link
Author

I see. I think alternatively, you could write „the R package“ and „the C++ package“ to distinguish. And/or use {cuml} to refer to the R package (another new convention not backed by the tidyverse style). I think the benefits of the convention may outweigh the drawbacks in these situations.

@yitao-li yitao-li linked a pull request Aug 24, 2021 that will close this issue
@yitao-li yitao-li self-assigned this Sep 7, 2021
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

Successfully merging a pull request may close this issue.

2 participants