Released by School of Software Engineering, Chongqing University
RecQ is a Python library for recommender systems (Python 2.7.x). It implements a suit of state-of-the-art recommendations. To run RecQ easily (no need to setup packages used in RecQ one by one), the leading open data science platform Anaconda is strongly recommended. It integrates Python interpreter, common scientific computing libraries (such as Numpy, Pandas, and Matplotlib), and package manager, all of them make it a perfect tool for data science researcher.
To design it exquisitely, we brought some thoughts from another recommender system library LibRec, which is implemented with Java.
- Cross-platform: as a Python software, RecQ can be easily deployed and executed in any platforms, including MS Windows, Linux and Mac OS.
- Fast execution: RecQ is based on the fast scientific computing libraries such as Numpy and some light common data structures, which make it run much faster than other libraries based on Python.
- Easy configuration: RecQ configs recommenders using a configuration file.
- Easy expansion: RecQ provides a set of well-designed recommendation interfaces by which new algorithms can be easily implemented.
- Data visualization: RecQ can help visualize the input dataset without running any algorithm.
- 1.Configure the **xx.conf** file in the directory named config. (xx is the name of the algorithm you want to run)
- 2.Run the **main.py** in the project, and then input following the prompt.
| Entry | Example | Description |
|---|---|---|
| ratings | D:/MovieLens/100K.txt | Set the path to input dataset. Format: each row separated by empty, tab or comma symbol. |
| social | D:/MovieLens/trusts.txt | Set the path to input social dataset. Format: each row separated by empty, tab or comma symbol. |
| ratings.setup | -columns 0 1 2 | -columns: (user, item, rating) columns of rating data are used;
-header: to skip the first head line when reading data |
| social.setup | -columns 0 1 2 | -columns: (trustor, trustee, weight) columns of social data are used;
-header: to skip the first head line when reading data |
| recommender | UserKNN/ItemKNN/SlopeOne/etc. | Set the recommender to use. |
| evaluation.setup | -testSet ../dataset/testset.txt | Main option: -testSet, -ap, -cv -testSet path/to/test/file (need to specify the test set manually) -ap ratio (ap means that the ratings are automatically partitioned into training set and test set, the number is the ratio of test set. e.g. -ap 0.2) -cv k (-cv means cross validation, k is the number of the fold. e.g. -cv 5) Secondary option:-b -b val （binarizing the rating values. Ratings equal or greater than val will be changed into 1, and ratings lower than val will be changed into 0. e.g. -b 3.0） |
| item.ranking | off -topN -1 | Main option: whether to do item ranking -topN N: the length of the recommendation list for item recommendation, default -1 for full list; -threshold val: if the predicted score is greater than val, the item will appear in the recommendation list. |
| output.setup | on -dir ./Results/ | Main option: whether to output recommendation results -dir path: the directory path of output results. |
| similarity | pcc/cos | Set the similarity method to use. Options: PCC, COS; |
| num.shrinkage | 25 | Set the shrinkage parameter to devalue similarity value. -1: to disable simialrity shrinkage. |
| num.neighbors | 30 | Set the number of neighbors used for KNN-based algorithms such as UserKNN, ItemKNN. |
| num.factors | 5/10/20/number | Set the number of latent factors |
| num.max.iter | 100/200/number | Set the maximum number of iterations for iterative recommendation algorithms. |
| learnRate | -init 0.01 -max 1 | -init initial learning rate for iterative recommendation algorithms; -max: maximum learning rate (default 1); |
| reg.lambda | -u 0.05 -i 0.05 -b 0.1 -s 0.1 | -u: user regularizaiton; -i: item regularization; -b: bias regularizaiton; -s: social regularization |
- 1.Make your new algorithm generalize the proper base class.
- 2.Rewrite some of the following functions as needed.
- printAlgorConfig()
- initModel()
- buildModel()
- saveModel()
- loadModel()
- predict()
| Algorithm | Paper |
|---|---|
| SlopeOne | Lemire and Maclachlan, Slope One Predictors for Online Rating-Based Collaborative Filtering, SDM 2005. |
| PMF | Salakhutdinov and Mnih, Probabilistic Matrix Factorization, NIPS 2008. |
| SoRec | Ma et al., SoRec: Social Recommendation Using Probabilistic Matrix Factorization, SIGIR 2008. |
| SocialMF | Jamali and Ester, A Matrix Factorization Technique with Trust Propagation for Recommendation in Social Networks, RecSys 2010. |
| TrustMF | Yang et al., Social Collaborative Filtering by Trust, IJCAI 2013. |
| RSTE | Ma et al., Learning to Recommend with Social Trust Ensemble, SIGIR 2009. |
| SVD | Y. Koren, Collaborative Filtering with Temporal Dynamics, KDD 2009. |
| SoReg | Ma et al., Recommender systems with social regularization, WSDM 2011. |
| EE | Khoshneshin et al., Collaborative Filtering via Euclidean Embedding, RecSys2010. |
| CoFactor | Liang et al., Factorization Meets the Item Embedding: Regularizing Matrix Factorization with Item Co-occurrence, RecSys2016. |
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent