Skip to content

Latest commit

 

History

History
256 lines (221 loc) · 5.43 KB

README.md

File metadata and controls

256 lines (221 loc) · 5.43 KB
Raw

Reel Algorithm

Source code for the Reel movie recommender algorithm and movie recommendation server are contained in this repository.

The movie recommender algorithm uses the MovieLens dataset as past data to derive new recommendations. This dataset is not included with this repository. Instructions on how to obtain this dataset are included in the obtaining data subsection.

Setup

  • Install Python 3.4.3 (and pip)
    • On Ubuntu: sudo apt-get install python3
  • Install virtualenv and virtualenvwrapper
    • On Ubuntu: sudo pip install virtualenv virtualenvwrapper
  • Add the following to your bashrc (accessed by typing sudo nano ~/.bashrc)
    • export WORKON_HOME=~/Envs
    • source /usr/local/bin/virtualenvwrapper.sh
  • Recompile your bashrc
    • source ~/.bashrc or close and re-open terminal
  • If this is the first time cloning the repository, create a new virtualenv
    • mkvirtualenv venv
  • If you have previously cloned the repository, re-use the existing virtualenv from the previous step
    • workon venv
  • Install the python dependencies
    • pip install -r requirements.txt
  • To run the flask server
    • python run.py
  • When you are done, close the virtualenv
    • deactivate

If you run into any questions, consult this article.

Running Server

If you have already completed all setup instructions at least once, simply follow the following instructions to run the server in detached mode:

workon venv
python run.py &

Obtaining Data

The data we use to make movie recommendations is compiled by researchers in the University of Minnesota GroupLens Research group.

Alternatively, download all the datasets at once by typing bash data-download.sh from the root of this repository.

API

Send all queries to localhost port 5000 as POST requests with a corresponding JSON file in the data section.

Group Recommendations

URL:

http://localhost:5000/recommendations

JSON:

{
	"quantity": 2,
	"min_year": 2006,
	"method": "disagreement_variance",
	"users": [
		{
			"user": "data/sample_users/andrew.txt",
			"ratings": [
				{
					"rating": "5.0",
					"imdb": "tt0106611"
				},
				{
					"rating": "3.0",
					"imdb": "tt0268380"
				}
			]
		},
		{
			"user": "data/sample_users/galen.txt",
			"ratings": [
				{
					"rating": "4.5",
					"imdb": "tt0468569"
				},
				{
					"rating": "5",
					"imdb": "tt0482571"
				}
			]
		}
	]
}

Return JSON:

For each genre of movie in the movielens dataset, returns a list of the top "quantity" movies of that genre ordered by score

{
	"(no genres listed)": [
		"tt0113112"
	],
	"Action": [
		"tt0133093",
		"tt0076759"
	],
	"Adventure": [
		"tt0076759",
		"tt0092513"
	],
	"Animation": [
		"tt0448694",
		"tt1482459"
	],
	"Children": [
		"tt0041890",
		"tt0057063"
	],
	"Comedy": [
		"tt0056923",
		"tt0025878"
	],
	"Crime": [
		"tt0056923",
		"tt0025878"
	],
	"Documentary": [
		"tt0386032",
		"tt0322802"
	],
	"Drama": [
		"tt0117247",
		"tt0101787"
	],
	"Fantasy": [
		"tt0448694",
		"tt0037988"
	],
	"Film-Noir": [
		"tt0041959",
		"tt0038787"
	],
	"Horror": [
		"tt0037988",
		"tt0286106"
	],
	"IMAX": [
		"tt0448694",
		"tt1055369"
	],
	"Musical": [
		"tt0061015",
		"tt0080716"
	],
	"Mystery": [
		"tt0056923",
		"tt0046912"
	],
	"Romance": [
		"tt0056923",
		"tt0117247"
	],
	"Sci-Fi": [
		"tt0133093",
		"tt0076759"
	],
	"Thriller": [
		"tt0133093",
		"tt0056923"
	],
	"Top": [
		"tt0133093",
		"tt0076759"
	],
	"War": [
		"tt0080310",
		"tt0031381"
	],
	"Western": [
		"tt0040897",
		"tt0039152"
	]
}

Similar Movies

URL:

http://localhost:5000/similar_movies

JSON:

{
	"quantity": 10,
	"min_year": 2006,
	"movies": [
		"tt0106611",
		"tt0268380",
		"tt0374900",
		"tt0361748",
		"tt0445922"
	]
}

Return JSON:

Returns a list of keys for similar movies

[
	"tt0110912",
	"tt0137523",
	"tt0111161",
	"tt0109830",
	"tt0120737",
	"tt0167260",
	"tt0133093",
	"tt0076759",
	"tt0080684",
	"tt0068646"
]

Data Description

The MovieLens datasets contains 3 csv files that we are using data from.

  • movies.csv (3 fields)
    • movieId: unique integer identifer for each movie
    • title: the title of the movie (with release year in parenthesis)
    • genres: a pipe separated list of genres
  • ratings.csv (4 fields)
    • userId: unique integer identifier for each user
    • movieId: cross-references the movie ids in movies.csv
    • rating: star rating (in half-star increments from .5 to 5.0)
    • timestamps: when the user made the rating (in seconds since 1970)
  • links.csv (3 fields)
    • movieId: cross-references the movie ids in movies.csv
    • imdbId: imdb identifier for given movie
    • tmdbId: tmdb identifier for given movie

Development

  • Do all development work inside of a virtualenv. Instructions for setup of virtualenv are descried above.

    • After installing new dependencies with pip on your local machine, update the requirements.txt file so that your environment will be reproducible.
      • pip freeze > requirements.txt

  • This project mainly utilizes flask to create REST API endpoints, and scipy for recommending movies.