htm.java

![Gitter](https://badges.gitter.im/Join
Chat.svg)

Official Java™ version of...

Hierarchical Temporal Memory (HTM)

Community-supported & ported from the Numenta Platform for Intelligent Computing (NuPIC) python project.

NOTE: Minimum JavaSE version is 8

For Demos & Examples: see the HTM.java-examples repository

News Archives...

See a glimpse of htm.java's history and read about significant events in its development.

View the Change Log (Updated! 2016-05-02)

Change log itemizes the release history.
Contains an "Unreleased" section which lists changes coming in the next release as they're being worked on - (should help users keep in touch with the current evolution of htm.java)

For a more detailed discussion of htm.java see:

See the Test Coverage Reports - For more information on where you can contribute! Extend the tests and get your name in bright lights!

For answers to more detailed questions, post to the HTM Forum (can be used via email too), or chat with us on Gitter.

For more detailed discussions regarding HTM.java specifically, come chat with us here:

See the blog: Join the Cogmission

Call to Arms: HTM.java needs you!

Project Goals

The primary goal of this library development is to provide a Java version of NuPIC that has a 1-to-1 correspondence to all systems, functionality and tests provided by Numenta's open source implementation; while observing the tenets, standards and conventions of Java language best practices and development.

By working closely with Numenta and receiving their enthusiastic support and guidance, it is intended that this library be maintained as a viable Java language alternative to Numenta's C++ and Python offerings. However it must be understood that "official" support is (for the time being) currently limited to community resources such as the maintainers of this library and Numenta Forums / Message Lists and IRC:

How Do I Get The Code?

(A) Instructions for developers who would like to contribute code back to the community. (Fork)
(B) Instructions for those who would like to "fiddle around" with the code in thier own github repo. (Clone)
(C) How to download Zipped or Tar'd Tagged Releases (Download Zip or Tar)

A. Developers who wish to make contributions are required to Fork the htm.java repo and then clone from their personal "Fork" of htm.java...

your_git_directory% git clone https://github.com/<your_github_username>/htm.java.git

B. Anybody who just wants to "play" with the code...

your_git_directory% git clone https://github.com/numenta/htm.java.git

C. Proceed here to download the latest tagged release (or older if you like)

The instructions on the above link (Fork the htm.java repo) provide detail about how to fork github repos...

In addition: a video is provided that explains Numenta's contributor rules and plenty of helpful tips on using git and other commands.

Does My Code Work?

After download by clone or fork, execute a quick sanity check by running all the tests from within the /<path to git repo>/htm.java

gradle check  # Executes the tests and runs the benchmarks

--or--

gradle -Pskipbench check  # Executes the tests w/o running the benchmarks

Note: Info on installing gradle can be found on the wiki (look at #3.) here

Linux Gradle Issues? see the wiki here.

A wiki with full build instructions for building HTM.java is available here: Build Instructions (This includes a no-java/gradle-guaranteed-build using the provided Docker File as a reference build.)

For Developers: Usage & Project Integration

(use this stuff within my own stuff)

NOTE: The Java version of NuPIC requires no installation - just USE it!

I Just Want A Simple Build!
Using Build Managers

Simple Build: For convenience, the libs directory contains all the dependency jars for those who just want to have a simple build.

...

Build Managers: Binary distributions may be included in your project using Gradle or Maven

Gradle:  

dependencies {
    compile group: 'org.numenta', name: 'htm.java', version:'0.6.8'
}

Maven:  

<dependency>
    <groupId>org.numenta</groupId>
    <artifactId>htm.java</artifactId>
    <version>0.6.8</version>
</dependency>

How to get the latest SNAPSHOT build:

<dependency>
    <groupId>org.numenta</groupId>
    <artifactId>htm.java</artifactId>
    <version>0.6.9-SNAPSHOT</version>
</dependency>

You also may need to include a repositories entry:

<repository>
    <id>oss-sonatype</id>
    <name>oss-sonatype</name>
    <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
    <snapshots>
        <enabled>true</enabled>
    </snapshots>
</repository>

Coding With htm.java

The easiest way to use the code is to use htm.java's Network API

Please refer to the Network API Quick Start Guide to get an idea of how to quickly and simply create your own network.

...and for more in-depth answers see:

NAPI Overview

Development Environment Installation

The following instructions are for setting up a development environment.

NOTE: For simple intructions see: INSTALL.txt

Eclipse Environment Setup Wiki

An Eclipse IDE .project and .classpath file are provided so that the cloned project can be easily set up inside of Eclipse. For the time being, the Eclipse IDE is the only "pre-made" project configuration.

In addition, there are "launch configurations" for all of the tests and any runnable entities off of the "htm.java" main directory. These may be run directly in Eclipse by right-clicking them and choosing "run".

The "Fancy Stuff" - Clustering and Parallelization

Some NuPIC Community members have created interesting projects which use htm.java's Network API to run Engine-Type clusters of multiple networks using streaming distributed libraries like Akka and Flink. See them here:

htm-moclu (Akka)
flink-htm (Flink - some say it's a better Spark)

To Follow Our Updates On Twitter

#HtmJavaDevUpdates

vova616/htm.java