Git Product home page Git Product logo

recommender's Introduction

Recommender


Recommender is a recommendation application using either item-based or user-based approaches.

Recommender is at version v0.3.0, also see change log for more details on release history.

Build Build Status Coverage Status
Quality Maintainability
Platform pyversion implementation

Table of contents

  1. Usage
  2. Contribution
  3. License

Usage

Install with pip

$ pip install recommender-engine

API

make_recommendation(person_to_recommend, preference_space, recommender_approach='user_based', number_of_items_to_recommend=10, similarity_measure='euclidean_distance')

	Return list of recommendation items based on the chosen approach and similarity emasure

	Parameters
	--------------
	person_to_recommend (str): user id/name to recommend to

	preference_space (dict):  keys are user id/name and values are dictionary of items and ratings

	recommender_approach (str): support 'user_based' (default) or 'item_based'

	number_of_items_to_recommend (int): number of items to recommend (default=10)

	similarity_measure (str): similarity measurement method , support 'euclidean_distance' (default), 'cosine' or 'pearson_correlation'

Example

>>> from recommender_engine import make_recommendation
>>>	result = make_recommendation(person_to_recommend = "userA",
                                 preference_space = preference_space,
                                 recommender_approach = 'user_based',
                                 number_of_items_to_recommend = 10,
                                 similarity_measure = 'euclidean_distance')

The preference space is dictionary data structure where keys are users and values are dictionary of items and ratings

preference_space = { 'userA : { 'item1' : 'ratingA1, 
                                 'item2' : 'ratingA2',
                                 ...}, 
                     ... 
                     'userZ: { 'item1' : 'ratingZ1,
                              'item2' : 'ratingZ2',
							  ...}
                    }

Tested Datasets

The project has been tested on these Datasets

  1. Jester
  2. MovieLens

Contribution

Please follow our contribution convention at contribution instruction and code of conduct

Please check out the issue file for list of issues that required helps.

Appreciation

Feel free to add your name into the list of contributors.

If you like this project, you can buy buy me a pizza to motivate me improve on the project.


License

See the LICENSE file for license rights and limitations (Apache License 2.0).

recommender's People

Contributors

akshaygupta8 avatar tranlv avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

recommender's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.