numenta / nupic-legacy

Numenta Platform for Intelligent Computing is an implementation of Hierarchical Temporal Memory (HTM), a theory of intelligence based strictly on the neuroscience of the neocortex.
http://numenta.org/
GNU Affero General Public License v3.0
6.34k stars 1.56k forks source link

Renaming nupic to nupic.python #1001

Closed david-ragazzi closed 8 years ago

david-ragazzi commented 10 years ago

This issue matches the extraction plan (https://github.com/numenta/nupic/wiki/nupic.core-Extraction-Plan).

The plan above is very clear about nupic.core being just a transitional repo in the moment, in the end it will have all features located in nupic at moment (sensors, encoders, frameworks, etc).

I think this renaming should be done as soon as possible because the terms nupic.core and nupic already confused me and probally confused others, making I suggest incorrect and non-sense naming based on misunderstoods like seen here: https://github.com/numenta/nupic/issues/724.

Because this misunderstood, I also suggested the name nupic.core.net to the bindings repository to the .Net platform. However based on the extraction plan, I should call it simply nupic.bindings.net.

This issue do not imply changes in the current internal structure, i.e. all namespace should continue being nupic. Futhermore, the most changes already were done like the default strucuture for pyhton projects and now the "pip installabe" feature which will be merged soon. Probally some minor changes should be done in nupic.tools or others.

update: @scottpurdy suggested we renamed it to nupic.python in order to we follow the "project.subproject" notation.

utensil commented 10 years ago

+1 for removing .core from names like nupic.core.net. As for whether to rename nupic to nupic.py, I don't have an opinion...

rhyolight commented 10 years ago

Keep in mind that there may be a "binding" repository at some point, allowing multiple clients in each language. But I'm fine renaming the nupic repo to nupic.py. So I think the names eventually should be:

So even if we start with just nupic.core and nupic.py and keep the binding code in nupic.py, we can always extract that code into nupic.bindings.py at a later date and adjust our build pipeline.

And the way Github does repo renaming will keep the old name and let it redirect to the new one. So the nupic :arrow_right: nupic.py change should not be an immediate breaker of our tooling (although we'll want to update all the names anyway).

david-ragazzi commented 10 years ago
    nupic.core
    nupic.bindings.<lang>
    nupic.<lang>

+1 I'm fine with this..

But I'm fine renaming the nupic repo to nupic.py.

@rhyolight As you are a GG could you make this change to us poor mortals? I have no idea about what kind of tools, documentation, needs be updated..

PS: GG=God of the Git.. :smile:

rhyolight commented 10 years ago

@david-ragazzi Sure, but I want to talk to @subutai and @scottpurdy first beforehand to make sure there won't be any unknown repercussions.

subutai commented 10 years ago
nupic.core
nupic.bindings.<lang>
nupic.<lang>

This makes a lot of sense to me too. I'm definitely not a GG so not sure of the repercussions of it all! But as an eventual goal this seems very clean.

scottpurdy commented 10 years ago

Let's not do "nupic.py" as that is obvious confusing. If we are married to the "project.subproject" notation then "nupic.python" would be ok.

rhyolight commented 10 years ago

"nupic.python" would be ok

That's ok by me.

david-ragazzi commented 10 years ago

"nupic.python" would be ok

That's ok by me.

No problem to me too.. I suggested py suffix because it is used in everywhere in the project.. This said, we should avoid py in favor of python suffix.

breznak commented 9 years ago

Bump? nupic.python sounds fine. It's not that difficult at all: https://help.github.com/articles/renaming-a-repository/

cogmission commented 9 years ago

I have to ask. Why dots in the names? :-)

On Thu, Oct 9, 2014 at 12:38 PM, breznak notifications@github.com wrote:

Bump? nupic.python sounds fine. It's not that difficult at all: https://help.github.com/articles/renaming-a-repository/

— Reply to this email directly or view it on GitHub https://github.com/numenta/nupic/issues/1001#issuecomment-58547356.

We find it hard to hear what another is saying because of how loudly "who one is", speaks...

rhyolight commented 9 years ago

I want to wait until after the hackathon to do this.

It's not that difficult at all: https://help.github.com/articles/renaming-a-repository/

That part is easy. But I'm sure there will be unforeseen repercussions, so I want to do it when I can dedicate my full attention to it.

I have to ask. Why dots in the names? :-)

That's just the convention we choose in the beginning. It's not uncommon.

oxtopus commented 9 years ago

The python convention would be "nupic-python" (https://pypi.python.org/pypi?%3Aaction=search&term=%22-python%22&submit=search for examples). "nupic.python" implies a python namespace and could get confusing.

rhyolight commented 9 years ago

The repo name doesn't need to be the same as the python namespace. I would prefer to keep the python namespace simply nupic.

david-ragazzi commented 9 years ago

Agreed. Keep the same namespace allows better consistency and less work.

Sent from my iPhone

On 19/11/2014, at 14:17, Matthew Taylor notifications@github.com wrote:

The repo name doesn't need to be the same as the python namespace. I would prefer to keep the python namespace simply nupic.

— Reply to this email directly or view it on GitHub.

rhyolight commented 8 years ago

I'm having 2nd thoughts about this. Until we have another set of language bindings, I don't think it matters.

oxtopus commented 8 years ago

👎

Also, 👎 in general for prefixing w/ "nupic." as a standard.

utensil commented 8 years ago

👎

The context has changed greatly since this proposal. At that time, there were few(or no) nupic.* projects (which are now all side projects, not language bindings), also there were few (or no) htm.* projects(which are mostly reimplementations in other languages, not language bindings). So this proposal was a possible choice back then but is simply outdated now.

IMHO, this issue can be safely closed. I guess @david-ragazzi would agree. 😉

cogmission commented 8 years ago

Extending @oxtopus' sentiment - also in general for having "dots" in the names... :-P (I really regret the non-standard Java name of HTM.Java)

rhyolight commented 8 years ago

If you guys want to talk about standardizing our repo names, bring it up on the forum.