Readme updates #6

Closed
wants to merge 4 commits into
from

Conversation

Projects
None yet
2 participants
@adamloving

I updated the readme with the key information I needed for running the "Fox eats" demo on my macbook.

fixes #7.

adamloving added some commits Dec 28, 2014

add notes to readme
With these additions, worked for me using python 2.7.6, pip 1.5.6, and
nltk 3.0.
-You'll also need 35MB (or more depending on what individual experiments you run) of space to store the text corpus from the NLTK and SDRs from CEPT.
+For some experiments, you'll need an app key from [Cortical.io](http://www.cortical.io/developers_apikey.html) for the usage of their API to get word SDRs and decode SDRs back into words.
+
+You'll also need 35MB (or more depending on what individual experiments you run) of space to store the text corpus from the NLTK and SDRs from Cortical.io (formerly CEPT).

This comment has been minimized.

@rhyolight

rhyolight Dec 29, 2014

Member

Cortical.IO is the correct capitalization.

@rhyolight

rhyolight Dec 29, 2014

Member

Cortical.IO is the correct capitalization.

+ pip install numpy
+
+
+clone [nupic](https://github.com/numenta/nupic) and [nupic.research](https://github.com/numenta/nupic.research) and add them to your PYTHONPATH so that the examples project can reference them.

This comment has been minimized.

@rhyolight

rhyolight Dec 29, 2014

Member

None of the examples rely on nupic.research to run as far as I know, so do we really need to reference it?

@rhyolight

rhyolight Dec 29, 2014

Member

None of the examples rely on nupic.research to run as far as I know, so do we really need to reference it?

This will bring up a GUI window for you to choose what texts to download. Choose them all and proceed. This will take a few minutes.
+Also, you'll want the nupic and nupic.research project paths on your PYTHONPATH if you see problems importing from them (for example, for TP10X2).
+

This comment has been minimized.

@rhyolight

rhyolight Dec 29, 2014

Member

Same comment about nupic.research.

@rhyolight

rhyolight Dec 29, 2014

Member

Same comment about nupic.research.

@@ -24,13 +30,18 @@ Before you have the NLTK text corpus available for local processing, you need to
>>> import nltk
>>> nltk.download()
+If you get `ImportError: No module named nltk`, set your PYTHONPATH.
+
+ $ export PYTHONPATH=$PYTHONPATH:/usr/local/lib/python2.7/site-packages

This comment has been minimized.

@rhyolight

rhyolight Dec 29, 2014

Member

This path is OS X - specific. It would be better if you could word this in a way that was generic.

@rhyolight

rhyolight Dec 29, 2014

Member

This path is OS X - specific. It would be better if you could word this in a way that was generic.

@rhyolight

This comment has been minimized.

Show comment
Hide comment
@rhyolight

rhyolight Dec 29, 2014

Member

Thanks for the PR, @adamloving. I have some comments above, but otherwise good initiative to clarify an aging README.

Member

rhyolight commented Dec 29, 2014

Thanks for the PR, @adamloving. I have some comments above, but otherwise good initiative to clarify an aging README.

@rhyolight

This comment has been minimized.

Show comment
Hide comment
Member

rhyolight commented Dec 31, 2014

Oh yeah, @adamloving can you sign our contributor license please?

@rhyolight

This comment has been minimized.

Show comment
Hide comment
@rhyolight

rhyolight Jan 14, 2015

Member

@adamloving Just a reminder, please sign our CL (see above).

Member

rhyolight commented Jan 14, 2015

@adamloving Just a reminder, please sign our CL (see above).

@adamloving

This comment has been minimized.

Show comment
Hide comment
@adamloving

adamloving Jan 14, 2015

Yeah, sorry - haven't had time to review fully. Will get back to this
eventually. Thanks!

On Wed, Jan 14, 2015 at 2:35 PM, Matthew Taylor notifications@github.com
wrote:

@adamloving https://github.com/adamloving Just a reminder, please sign
our CL (see above).


Reply to this email directly or view it on GitHub
#6 (comment)
.

Yeah, sorry - haven't had time to review fully. Will get back to this
eventually. Thanks!

On Wed, Jan 14, 2015 at 2:35 PM, Matthew Taylor notifications@github.com
wrote:

@adamloving https://github.com/adamloving Just a reminder, please sign
our CL (see above).


Reply to this email directly or view it on GitHub
#6 (comment)
.

@rhyolight

This comment has been minimized.

Show comment
Hide comment
@rhyolight

rhyolight Mar 20, 2015

Member

Ping!

Member

rhyolight commented Mar 20, 2015

Ping!

@rhyolight

This comment has been minimized.

Show comment
Hide comment
@rhyolight

rhyolight Apr 2, 2015

Member

ping!

Member

rhyolight commented Apr 2, 2015

ping!

@rhyolight

This comment has been minimized.

Show comment
Hide comment
@rhyolight

rhyolight Apr 17, 2015

Member

Closing for now. We have too many open PRs. @adamloving Let us know when you are ready to come back to this and I'll re-open.

Member

rhyolight commented Apr 17, 2015

Closing for now. We have too many open PRs. @adamloving Let us know when you are ready to come back to this and I'll re-open.

@rhyolight rhyolight closed this Apr 17, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment