search

htm-community / flink-htm

Distributed, streaming anomaly detection and prediction with HTM in Apache Flink
GNU Affero General Public License v3.0
136 stars 37 forks source link

Rename `learn` function #10

Closed EronWright closed 8 years ago

EronWright commented 8 years ago

The learn function that flink-htm adds to DataStream is the primary API that inserts HTM into a dataflow graph. I consider the name of the function to be an open issue, since learn has another meaning in an HTM context.

The function name must be a verb, similar to existing functions like map, filter, and groupBy.

I suggest that the function name be grok.

Old:

val anomalyScores = env
      .addSource(nycTraffic)
      .keyBy("streamId")
      .learn(network)
      .select(...)

New:

val anomalyScores = env
      .addSource(nycTraffic)
      .keyBy("streamId")
      .grok(network)
      .select(...)
cogmission commented 8 years ago

Another suggestion could be infer() or simply compute()?

rhyolight commented 8 years ago

I think grok is an already overloaded term in Numenta history. I prefer compute.

EronWright commented 8 years ago

I think compute is too generic; any library could be said to compute. Let's sit on this for a while then.

rhyolight commented 8 years ago

setupHtm()

EronWright commented 8 years ago

I'm looking for a word that would fit into this sentence: "I filtered the stream then I blahed the stream."

My latest suggestion is analyze.

rhyolight commented 8 years ago

I like analyze the best so far.

EronWright commented 8 years ago

Maybe we should leave this as-is.