https://github.com/jhurliman/node-graph-suggestions
Provides "people you should follow" or other graph-based recommendations
https://github.com/jhurliman/node-graph-suggestions
Last synced: about 2 months ago
JSON representation
Provides "people you should follow" or other graph-based recommendations
- Host: GitHub
- URL: https://github.com/jhurliman/node-graph-suggestions
- Owner: jhurliman
- License: mit
- Created: 2015-04-27T00:10:45.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2015-04-27T05:40:00.000Z (about 10 years ago)
- Last Synced: 2025-04-11T01:42:18.847Z (about 2 months ago)
- Language: JavaScript
- Size: 141 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- License: LICENSE
Awesome Lists containing this project
README
# node-graph-suggestions #
[![NPM Version][npm-image]][npm-url]
[![NPM Downloads][downloads-image]][downloads-url]
[![Build Status][travis-image]][travis-url]
[![Test Coverage][coveralls-image]][coveralls-url]
Provides "people you should follow" or other graph-based recommendations. By
calling the suggest method and providing two data fetching methods for looking
up forward connections (ie "users followed by a user") and reverse connections
(ie "users following a user") you can get back a list of suggested friends,
products, or any other concept that can be represented as a graph.
## Installation ##
Use NPM to install:
npm install graph-suggestions
## Usage ##
A simple example showing the behavior of the forwardOnly option.
```javascript
var suggestions = require('graph-suggestions');
var DATA_STORE = {
Andrew: { friends: [ 'Ben' ] },
Ben: { friends: [ 'Andrew', 'Chuck' ] },
Chuck: { friends: [ 'Ben' ] },
Dennis: { friends: [ 'Andrew' ] }
};
var opts = { forwardOnly: true, forwardConnections: forwardFetcher };
suggestions.suggest('Andrew', opts, function(err, results) {
if (err) throw err;
// Forward-Only: [{"nodeID":"Chuck","score":0.0625}]
console.log('Forward-Only: ' + JSON.stringify(results));
});
opts = { forwardConnections: forwardFetcher, reverseConnections: reverseFetcher };
suggestions.suggest('Andrew', opts, function(err, results) {
if (err) throw err;
// Bi-Directional: [{"nodeID":"Dennis","score":0.111},{"nodeID":"Chuck","score":0.0417}]
console.log('Bi-Directional: ' + JSON.stringify(results));
});
function forwardFetcher(nodeID, callback) {
var node = DATA_STORE[nodeID];
callback(null, node ? node.friends : []);
}
function reverseFetcher(nodeID, callback) {
var array = [];
for (var curNodeID in DATA_STORE) {
var node = DATA_STORE[curNodeID];
if (node.friends.indexOf(nodeID) !== -1)
array.push(curNodeID);
}
callback(null, array);
}
```
## Additional Notes ##
The algorithm used under the hood is [Personalized PageRank](http://nlp.stanford.edu/projects/pagerank.shtml). Starting from a given node, the graph is traversed a given number of degrees outward (defaulting to three). There are many great resources online describing PageRank and Personalized PageRank, but a quick summary is that nodes will be scored based on your likelihood to stumble upon them on a random walk through your local graph. A `forwardOnly` setting (defaulting off) toggles whether this random walk can follow directed edges in the reverse direction or not. If you have an undirected graph such as a Facebook-style symmetric friendship graph, you'll want to set `forwardOnly` to true to avoid redundant work.
The implementation is based on a [blog post](http://blog.echen.me/2012/07/31/edge-prediction-in-a-social-graph-my-solution-to-facebooks-user-recommendation-contest-on-kaggle/) by Edwin Chen detailing a solution for Facebook's user recommendation challenge.
## License ##
[MIT](LICENSE)
[npm-image]: https://img.shields.io/npm/v/graph-suggestions.svg?style=flat
[npm-url]: https://npmjs.org/package/graph-suggestions
[travis-image]: https://img.shields.io/travis/jhurliman/node-graph-suggestions.svg?style=flat
[travis-url]: https://travis-ci.org/jhurliman/node-graph-suggestions
[coveralls-image]: https://img.shields.io/coveralls/jhurliman/node-graph-suggestions.svg?style=flat
[coveralls-url]: https://coveralls.io/r/jhurliman/node-graph-suggestions?branch=master
[downloads-image]: https://img.shields.io/npm/dm/graph-suggestions.svg?style=flat
[downloads-url]: https://npmjs.org/package/graph-suggestions