<img src="http://numenta.org/87b23beb8a4b7dea7d88099bfb28d182.svg" alt="NuPIC Logo" width=100/>

htm.java

<br>

[![][license img]][license] [![docs-badge][]][docs]

<br>

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

<br>

---

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

---

<br>

Recent News Items...

• Updated README.md to reflect new site image source (09/15/2021)
• Updated Sync Report Table Here in README (06/02/2017)
• New Hot Fix Release v0.6.13-alpha (05/12/2017)
• Updated HTM.Java Examples! Now in sync with latest release (v0.6.12-alpha) (See the executable Jars!) (04/06/2017)
• New Feature Release! v0.6.12-alpha Network API Allows Multi-field inference! (04/04/2017)
• HTM.Java Release v0.6.11-alpha to tag sync state with NuPIC (10/16/2016)
• HTM.Java Receives new TemporalMemory - HTM.Java now fully in sync!! (10/13/2016)
• HTM.Java Receives new SpatialPooler - Fully Updated! (10/06/2016)
• HTM.Java Reaches 100% NuPIC Compatibility and operation within NAB <strike>will be offered (soon)</strike>! (09/29/2016)
• HTM.java Receives New SDRClassifier! (07/26/2016)

News Archives...

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

View the Change Log (Updated! 2017-04-05)

• 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 <b>htm.java</b> see: <BR>

• htm.java Wiki
• Java Docs

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

<a name="callToArms"></a>

Call to Arms: HTM.java needs you!

---

Versioning

(Tracked according to core algorithms)

| Core Algorithm | NuPIC Date |HTM.Java Date | Latest NuPIC SHA | Latest HTM.Java SHA | Status| | --------------- |:-------------:|:------------:|:----------------:|:-------------------:|:-----:| | SpatialPooler | 2016-12-11 | 2016-10-07 |commit|commit| *Behind NuPIC Merge #3411 | TemporalMemory | 2017-06-02 | 2016-10-13 |commit|commit| *Behind NuPIC Merge #3654

* May be one of: "Sync'd" or "Behind". "Behind" expresses a temporary lapse in synchronization while devs are implementing new changes.

_{^{NOTE: "Behind" status does not imply any lack of operational ability. The master branch of HTM.Java will always be fully operational. <br> Any fully critical feature addition to NuPIC will always be matched (sync'd) ASAP, however due to ongoing updates, the algortithms within NuPIC may reach ahead for a short period of time while the HTM Community is busy porting the difference(s). We are committed to keeping HTM.Java up to date with NuPIC at all times.}}

---

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:

• NuPIC Community
• New HTM Forum

---

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  (Faster! **Recommended**)

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

---

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.12'
}

Maven:  

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

How to get the latest SNAPSHOT build: (None yet for newest build...)

<dependency>
    <groupId>org.numenta</groupId>
    <