A recommendation engine based on an embedded https://github.com/zond/god

It opens up a port listening for JSON encoded UDP messages containing mutating commands. Use this to let your app modify the recommendation state without incurring lots of extra dependencies or costs.

It also opens up a port listening serving JSON over HTTP to inspect the recommendation state, or to fetch recommendations.

Install Go, gcc, git, mercurial.

Run go get github.com/zond/commendable/commendable_server

$GOPATH/bin/commendable_server

• -listenIp=ADDRESS: The ip address to listen to requests at, defaults to 127.0.0.1.
• -broadcastIp=ADDRESS: The ip address to advertise to the cluster, defaults to 127.0.0.1.
• -port=PORT: The port to use when talking to the cluster, defaults to 9191.
• -joinIp=ADDRESS: The address to contact to join the cluster, no default.
• -joinPort=PORT: The port to contact to join the cluster, defaults to 9191.
• -udpPort=PORT: The port to listen for UDP messages at, defaults to 29191.
• -jsonPort=PORT: The port to listen for JSON HTTP requests at, defaults to 29192.
• -dir=DIR: The directory to look for and store the persistence files in, defaults to 127.0.0.1:9191.
• -timeout=DAYS: The number of days before active objects get automatically deactivated, defaults to 14.

Send UDP messages looking like

{
  "Type": "like",
  "User": USERID,
  "Object": OBJECTID,
  "Weight": WEIGHT,
  "DontActivate": true,
}

for each known like in the database to the -udpPort=PORT port.

Send UDP messages looking like

{
  "Type": "like",
  "User": USERID,
  "Object": OBJECTID,
  "Weight": WEIGHT,
}

to the -udpPort=PORT port. The object will also be considered active until -timeout=DAYS have passed, or it gets deactivated.

Send UDP messages looking like

{
  "Type": "view",
  "User": USERID,
  "Object": OBJECTID,
}

to the -udpPort=PORT port. The object will also be considered active until -timeout=DAYS have passed, or it gets deactivated.

Send UDP messages looking like

{
  "Type": "deactivate",
  "Object": OBJECTID,
}

to the -udpPort=PORT port.

POST /recommend/USERID messages looking like

{
  "Num": WANTED_NUMBER_OF_RECOMMENDATIONS
  "Actives": "reject" or "intersect" or not at all,
  "Viewed": "reject" or "intersect" or not at all,
}

to the -jsonPort=PORT.

Rejecting Actives will show only non active objects. Intersecting Actives will show only active objects.

Rejecting Viewed will show only objects not viewed by the user. Intersecting Viewed will show only objects viewed by the user.