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

potential name conflict #2

Open
Roger-luo opened this issue Jul 29, 2020 · 2 comments
Open

potential name conflict #2

Roger-luo opened this issue Jul 29, 2020 · 2 comments

Comments

@Roger-luo
Copy link

Thanks for making this package, and very nice talk! Just want to notify that there is https://github.com/JuliaPhysics/Lattices.jl already which is for defining lattices.

The name of this package might be a bit misleading given the existence of that package. It'd be easier for users to install this package if the name can be changed to a more distinguishable one.

@donm
Copy link
Owner

donm commented Jul 30, 2020

Thanks, Roger!

Yeah, it's true about the name. We thought about this too, and deep down I sort of knew that I was effectively drafting you (and maybe others) into a conversation to about names when I created the repo.

I'll tell you the thoughts that Cody and I had when we initially talked about the name, but please tell me what you think, too. Our thoughts were basically:

  • We're using the word "lattice" as a name in the same way that Flux.jl, Gadfly.jl, or JuMP.jl use their names less-than-literally, like a brand name.
  • Lattice.jl won't provide general purpose data structures or functionality for lattices (and two packages called Lattice.jl and Lattices.jl that both provided that functionality really would be ridiculously confusing).
  • If you know the Julia package naming conventions, then hearing a package with a singular name like Lattice or Gadfly doesn't really make you think that they're about lattices or gadflies, so it seemed like packages named with the singular and plural version of a word could be okay

On the other hand, just because frequent users of Julia might not be confused by a combination of names like FluxML/Flux.jl and JuliaPhysics/Fluxes.jl (if that existed), that doesn't mean somebody coming from PyTorch to experiment with Flux wouldn't be put off or confused. So I definitely see the other side to it, too.

@Roger-luo
Copy link
Author

Hi, I think it's not about the name convention. It's simply just because there is only one letter difference in the name, which potentially make things very confusing. A user will need to install Lattice to find out it's actually not Lattices. For the same reason I don't think we will use Fluxes if there is a package for it. But PhysicsFlux etc. to make things more explicit.

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