/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.mahout.cf.taste.impl.recommender;
import org.apache.mahout.cf.taste.common.TasteException;
import org.apache.mahout.cf.taste.impl.TasteTestCase;
import org.apache.mahout.cf.taste.impl.neighborhood.NearestNUserNeighborhood;
import org.apache.mahout.cf.taste.impl.similarity.PearsonCorrelationSimilarity;
import org.apache.mahout.cf.taste.model.DataModel;
import org.apache.mahout.cf.taste.neighborhood.UserNeighborhood;
import org.apache.mahout.cf.taste.recommender.RecommendedItem;
import org.apache.mahout.cf.taste.recommender.Recommender;
import org.apache.mahout.cf.taste.recommender.UserBasedRecommender;
import org.apache.mahout.cf.taste.similarity.UserSimilarity;
import org.junit.Test;
import java.util.List;
/** <p>Tests {@link GenericUserBasedRecommender}.</p> */
public final class GenericUserBasedRecommenderTest extends TasteTestCase {
@Test
public void testRecommender() throws Exception {
Recommender recommender = buildRecommender();
List<RecommendedItem> recommended = recommender.recommend(1, 1);
assertNotNull(recommended);
assertEquals(1, recommended.size());
RecommendedItem firstRecommended = recommended.get(0);
assertEquals(2, firstRecommended.getItemID());
assertEquals(0.1f, firstRecommended.getValue(), EPSILON);
recommender.refresh(null);
assertEquals(2, firstRecommended.getItemID());
assertEquals(0.1f, firstRecommended.getValue(), EPSILON);
}
@Test
public void testHowMany() throws Exception {
DataModel dataModel = getDataModel(
new long[] {1, 2, 3, 4, 5},
new Double[][] {
{0.1, 0.2},
{0.2, 0.3, 0.3, 0.6},
{0.4, 0.4, 0.5, 0.9},
{0.1, 0.4, 0.5, 0.8, 0.9, 1.0},
{0.2, 0.3, 0.6, 0.7, 0.1, 0.2},
});
UserSimilarity similarity = new PearsonCorrelationSimilarity(dataModel);
UserNeighborhood neighborhood = new NearestNUserNeighborhood(2, similarity, dataModel);
Recommender recommender = new GenericUserBasedRecommender(dataModel, neighborhood, similarity);
List<RecommendedItem> fewRecommended = recommender.recommend(1, 2);
List<RecommendedItem> moreRecommended = recommender.recommend(1, 4);
for (int i = 0; i < fewRecommended.size(); i++) {
assertEquals(fewRecommended.get(i).getItemID(), moreRecommended.get(i).getItemID());
}
recommender.refresh(null);
for (int i = 0; i < fewRecommended.size(); i++) {
assertEquals(fewRecommended.get(i).getItemID(), moreRecommended.get(i).getItemID());
}
}
@Test
public void testRescorer() throws Exception {
DataModel dataModel = getDataModel(
new long[] {1, 2, 3},
new Double[][] {
{0.1, 0.2},
{0.2, 0.3, 0.3, 0.6},
{0.4, 0.5, 0.5, 0.9},
});
UserSimilarity similarity = new PearsonCorrelationSimilarity(dataModel);
UserNeighborhood neighborhood = new NearestNUserNeighborhood(2, similarity, dataModel);
Recommender recommender = new GenericUserBasedRecommender(dataModel, neighborhood, similarity);
List<RecommendedItem> originalRecommended = recommender.recommend(1, 2);
List<RecommendedItem> rescoredRecommended =
recommender.recommend(1, 2, new ReversingRescorer<Long>());
assertNotNull(originalRecommended);
assertNotNull(rescoredRecommended);
assertEquals(2, originalRecommended.size());
assertEquals(2, rescoredRecommended.size());
assertEquals(originalRecommended.get(0).getItemID(), rescoredRecommended.get(1).getItemID());
assertEquals(originalRecommended.get(1).getItemID(), rescoredRecommended.get(0).getItemID());
}
@Test
public void testIncludeKnownItems() throws Exception {
DataModel dataModel = getDataModel(
new long[] {1, 2, 3},
new Double[][] {
{0.1, 0.2},
{0.2, 0.3, 0.3, 0.6},
{0.4, 0.5, 0.5, 0.9},
});
UserSimilarity similarity = new PearsonCorrelationSimilarity(dataModel);
UserNeighborhood neighborhood = new NearestNUserNeighborhood(2, similarity, dataModel);
Recommender recommender = new GenericUserBasedRecommender(dataModel, neighborhood, similarity);
List<RecommendedItem> originalRecommended = recommender.recommend(1, 4, null, true);
List<RecommendedItem> rescoredRecommended = recommender.recommend(1, 4, new ReversingRescorer<Long>(), true);
assertNotNull(originalRecommended);
assertNotNull(rescoredRecommended);
assertEquals(4, originalRecommended.size());
assertEquals(4, rescoredRecommended.size());
assertEquals(originalRecommended.get(0).getItemID(), rescoredRecommended.get(3).getItemID());
assertEquals(originalRecommended.get(3).getItemID(), rescoredRecommended.get(0).getItemID());
}
@Test
public void testEstimatePref() throws Exception {
Recommender recommender = buildRecommender();
assertEquals(0.1f, recommender.estimatePreference(1, 2), EPSILON);
}
@Test
public void testBestRating() throws Exception {
Recommender recommender = buildRecommender();
List<RecommendedItem> recommended = recommender.recommend(1, 1);
assertNotNull(recommended);
assertEquals(1, recommended.size());
RecommendedItem firstRecommended = recommended.get(0);
// item one should be recommended because it has a greater rating/score
assertEquals(2, firstRecommended.getItemID());
assertEquals(0.1f, firstRecommended.getValue(), EPSILON);
}
@Test
public void testMostSimilar() throws Exception {
UserBasedRecommender recommender = buildRecommender();
long[] similar = recommender.mostSimilarUserIDs(1, 2);
assertNotNull(similar);
assertEquals(2, similar.length);
assertEquals(2, similar[0]);
assertEquals(3, similar[1]);
}
@Test
public void testIsolatedUser() throws Exception {
DataModel dataModel = getDataModel(
new long[] {1, 2, 3, 4},
new Double[][] {
{0.1, 0.2},
{0.2, 0.3, 0.3, 0.6},
{0.4, 0.4, 0.5, 0.9},
{null, null, null, null, 1.0},
});
UserSimilarity similarity = new PearsonCorrelationSimilarity(dataModel);
UserNeighborhood neighborhood = new NearestNUserNeighborhood(3, similarity, dataModel);
UserBasedRecommender recommender = new GenericUserBasedRecommender(dataModel, neighborhood, similarity);
long[] mostSimilar = recommender.mostSimilarUserIDs(4, 3);
assertNotNull(mostSimilar);
assertEquals(0, mostSimilar.length);
}
private static UserBasedRecommender buildRecommender() throws TasteException {
DataModel dataModel = getDataModel();
UserSimilarity similarity = new PearsonCorrelationSimilarity(dataModel);
UserNeighborhood neighborhood = new NearestNUserNeighborhood(2, similarity, dataModel);
return new GenericUserBasedRecommender(dataModel, neighborhood, similarity);
}
}