Menorah
Menorah is a NuPIC experiment framework for River View.
Goal
This project aims to make it easy to feed multiple streams of data into a NuPIC HTM model using live data already availale in River View. With a simple python script, you can run and plot predictions for River View data using many input streams that might contribute to the target prediction.
Tutorial
Check out the video tutorial!
Installation
First, you must install NuPIC however you wish. Then you can run:
pip install menorah
Data delivered directly to NuPIC
To stream data from River View into NuPIC, you need to know the river
, stream
, and field
for each data feed.
Take the data feed http://data.numenta.org/ercot-demand/system_wide_demand/data.html
:
The pattern is /<river>/<stream>/data.html
. To find the field
, look at River View HTML interface to decide what data field is desired.
Each one is a list [river, stream, field]
, and they are provided to the Menora
constructor in a list. For example:
from menorah import Menorah
sources = [
["ercot-demand", "system_wide_demand", "Demand"],
]
menorah = Menorah(sources, "experiments/ercot")
menorah.swarm()
menorah.runModel()
Working Directory
Menorah needs a working directory for its second constructor parameter, because NuPIC writes artifacts to the file system. Pass in a path to a working folder for menorah experiments.
Run multiple fields
I recommend running less than 8 fields in a single model, but you can configure as many as you wish. The example below attempts to better predict the number of "tree debris" 311 calls in Chicago and incorporates data from local weather stations. It also shows an example of aggregating a geospatial data feed to get event counts within an aggregation period.
from datetime import datetime
from menorah import Menorah
sources = [
["chicago-311", "Tree Debris", "aggregate=1 day"],
["chicago-beach-weather", "Foster Weather Station", "humidity"],
["chicago-beach-weather", "Foster Weather Station", "interval_rain"],
["chicago-beach-water-quality", "Osterman Beach", "wave_height"],
]
menorah = Menorah(
sources,
"work/example5-multifield-aggregated",
since=datetime(2015, 5, 20)
)
menorah.swarm(swarmParams={"swarmSize":"large"})
menorah.runModel(plot=True)
View the predictions
You can find a predictions.csv
file in the working directory you specified. Or you can call runModel(plot=True)
to plot with matplotlib.
Pro Tips
- For
geospatial
data streams like portland-911, you can aggregate counts of events by providing an aggregation string instead of afield
name. See example5.py andaggregate=1 day
in thesources
list. - Once you've swarmed once on a particular experiment, you can comment out the call to
swarm()
on subsequent runs.
TODO
- Save
Menorah
instances, which should save the underlying model and the data cursors so the may be continued from the point where they left off.