NAB

(β˜… 2,102)

The Numenta Anomaly Benchmark

  • .dockerignore
  • .gitignore
  • .travis.yml
  • .zenodo.json
  • build.gradle
  • CHANGELOG.md
  • CONTRIBUTING.md
  • Dockerfile.py27
  • environment.yml
  • juliacalldeps.json
  • LICENSE.txt
  • README.md
  • requirements.txt
  • run.py
  • setup.py

πŸš€ Installation Guide

1. Get the code
git clone https://github.com/numenta/NAB

Downloads the entire project code from GitHub to your computer.

cd NAB

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip install . --user

Installs the package published on PyPI directly β€” no need to clone the source.

pip install . --user --no-deps

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -f Dockerfile.py27 -t nab .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 nab

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Gradle (Java/Kotlin)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java/Kotlin projects.
  • Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
./gradlew build

Builds the project using Gradle.

βœ… A BUILD SUCCESSFUL message means it worked. The output is created under build/.

5. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install -r requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

pip install . --user

Installs the package published on PyPI directly β€” no need to clone the source.

pip install . --user --no-deps

Installs the package published on PyPI directly β€” no need to clone the source.

pip install -e . --install-option="--prefix=/some/other/path/"

Installs the Python libraries listed in requirements.txt (or similar).

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation