From f55a6a3ea87e5e1d2253a1e87d3167a3c7b81101 Mon Sep 17 00:00:00 2001 From: DavidRagazzi Date: Mon, 16 Dec 2013 15:21:29 -0200 Subject: [PATCH 1/2] Update README.md Note that I eliminated env variables because this makes the understanding easier for newbies and avoid create several variables for folders related each another. --- README.md | 66 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 38 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 16e9d53e5c..5d4c605200 100644 --- a/README.md +++ b/README.md @@ -37,62 +37,72 @@ Currently supported platforms: Dependencies: * Python (2.6-2.7) (with development headers) * GCC (4.6-4.8), or Clang - * Make + * Make or any IDE supported by CMake (Visual Studio, Eclipse, XCode, KDevelop, etc) The dependencies are included in platform-specific repositories for convenience: * [nupic-linux64](https://github.com/numenta/nupic-linux64) for 64-bit Linux systems * [nupic-darwin64](https://github.com/numenta/nupic-darwin64) for 64-bit OS X systems -Add the following to your .bashrc file. Change the paths as needed. - - # Installation path - export NTA=$HOME/nta/eng - # Target source/repo path. Defaults to $PWD - export NUPIC=/path/to/repo - # Convenience variable for temporary build files - export BUILDDIR=/tmp/ntabuild - # Number of jobs to run in parallel (optional) - export MK_JOBS=3 - - # Set up the rest of the necessary env variables. Must be done after - # setting $NTA. - source $NUPIC/env.sh - Complete set of python requirements are documented in [requirements.txt](/external/common/requirements.txt), compatible with [pip](http://www.pip-installer.org/en/latest/cookbook.html#requirements-files): pip install -r external/common/requirements.txt -Build and install NuPIC: +## Build and test NuPIC: + +### Using command line + +Generate build files: + + mkdir (source)/build + cd (source)/build + ccmake ../(source) + +Build: + + cd (source)/build + make + +Run the C++ tests: + + cd (source)/bin + htmtest + testeverything + +### Using graphical interface - $NUPIC/build.sh +Generate the IDE solution: -NuPIC should now be installed in $NTA! + * Open CMake executable. + * Specify the source folder. + * Specify the build folder, ie where IDE solution will be created (ex: /(source)/build). + * Click 'Generate'. + * Choose the IDE that interest you (remember that IDE choice is limited to your OS, ie Visual Studio is available only on CMake for Windows). -## Try it out! +Build: -### Tests + * Open 'Nupic.*proj' solution file located on build folder. + * Run 'ALL_BUILD' project from your IDE. Run the C++ tests: - $NTA/bin/htmtest - $NTA/bin/testeverything + * Run 'HtmTest' and 'TestEverything' projects from your IDE (check 'output' panel to see the results). -Run the Python unit tests: +### Run the Python unit tests: - cd $NTA - ./bin/run_tests.sh + cd (source)/bin + run_tests.sh ### Examples You can run the examples using the OpfRunExperiment OPF client: - python $NUPIC/examples/opf/bin/OpfRunExperiment.py $NUPIC/examples/opf/experiments/multistep/hotgym/ + python (source)/examples/opf/bin/OpfRunExperiment.py $NUPIC/examples/opf/experiments/multistep/hotgym/ There are also some sample OPF clients. You can modify these to run your own data sets. One example is the hotgym prediction client: - python $NUPIC/examples/opf/clients/hotgym/hotgym.py + python (source)/examples/opf/clients/hotgym/hotgym.py Also check out other uses of the CLA on the [Getting Started](https://github.com/numenta/nupic/wiki/Getting-Started#next-steps) wiki page. From ea6fd3d8c7495d0374678a41c2e7be18f6570b75 Mon Sep 17 00:00:00 2001 From: Matthew Taylor Date: Mon, 16 Dec 2013 09:42:42 -0800 Subject: [PATCH 2/2] A few formatting changes to README. --- README.md | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 5d4c605200..2b745173e3 100644 --- a/README.md +++ b/README.md @@ -16,25 +16,27 @@ Issue tracker at [issues.numenta.org](https://issues.numenta.org/browse/NPC). For more detailed documentation, see the [OPF wiki page](https://github.com/numenta/nupic/wiki/Online-Prediction-Framework). -__Encoders__ turn raw values into sparse distributed representations (SDRs). A good encoder will capture the semantics of the data type in the SDR using overlapping bits for semantically similar values. +*__Encoders__* turn raw values into sparse distributed representations (SDRs). A good encoder will capture the semantics of the data type in the SDR using overlapping bits for semantically similar values. -__Models__ take sequences of SDRs and make predictions. The CLA is implemented as an OPF model. +*__Models__* take sequences of SDRs and make predictions. The CLA is implemented as an OPF model. -__Metrics__ take input values and predictions and output scalar representations of the quality of the predictions. Different metrics are suitable for different problems. +*__Metrics__* take input values and predictions and output scalar representations of the quality of the predictions. Different metrics are suitable for different problems. -__Clients__ take input data and feed it through encoders, models, and metrics and store or report the resulting predictions or metric results. +*__Clients__* take input data and feed it through encoders, models, and metrics and store or report the resulting predictions or metric results. ## Installation For all installation options, see the [Getting Started](https://github.com/numenta/nupic/wiki/Getting-Started) wiki page. -Currently supported platforms: +#### Currently supported platforms: + * Linux (32/64bit) * Mac OSX * Raspberry Pi (ARMv6) * [VM images](https://github.com/numenta/nupic/wiki/Running-Nupic-in-a-Virtual-Machine) -Dependencies: +#### Dependencies: + * Python (2.6-2.7) (with development headers) * GCC (4.6-4.8), or Clang * Make or any IDE supported by CMake (Visual Studio, Eclipse, XCode, KDevelop, etc) @@ -53,18 +55,18 @@ compatible with [pip](http://www.pip-installer.org/en/latest/cookbook.html#requi ### Using command line -Generate build files: +#### Generate build files: mkdir (source)/build cd (source)/build ccmake ../(source) -Build: +#### Build: cd (source)/build make -Run the C++ tests: +#### Run the C++ tests: cd (source)/bin htmtest @@ -72,7 +74,7 @@ Run the C++ tests: ### Using graphical interface -Generate the IDE solution: +#### Generate the IDE solution: * Open CMake executable. * Specify the source folder. @@ -80,12 +82,12 @@ Generate the IDE solution: * Click 'Generate'. * Choose the IDE that interest you (remember that IDE choice is limited to your OS, ie Visual Studio is available only on CMake for Windows). -Build: +#### Build: * Open 'Nupic.*proj' solution file located on build folder. * Run 'ALL_BUILD' project from your IDE. -Run the C++ tests: +#### Run the C++ tests: * Run 'HtmTest' and 'TestEverything' projects from your IDE (check 'output' panel to see the results).