net.librec.eval.RecommenderEvaluator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of librec-core Show documentation

A repackaged librec-core fork

The newest version!

/**
 * Copyright (C) 2016 LibRec
 * 
 * This file is part of LibRec.
 * LibRec is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 

 * LibRec is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * 

 * You should have received a copy of the GNU General Public License
 * along with LibRec. If not, see .
 */
package net.librec.eval;

import net.librec.conf.Configuration;
import net.librec.data.DataModel;
import net.librec.recommender.RecommenderContext;
import net.librec.recommender.item.RecommendedList;

/**
 * 

 * Implementations of this interface evaluate the quality of a
 * {@link net.librec.recommender.Recommender}'s recommendations.
 * 
 *
 * @author WangYuFeng
 */
public interface RecommenderEvaluator {

    /**
     * Evaluate on the recommender context with the recommended list.
     *
     * @param context          RecommenderContext object
     * @param recommendedList  RecommendedList object
     * @return  evaluate result
     */
    double evaluate(RecommenderContext context, RecommendedList groundTruthList, RecommendedList recommendedList);

    /**
     * Evaluate on the evaluate context
     * @param evalContext evaluate context, including conf, groundTruthList, recommendedList, and other things used
     *                    in the evaluation
     * @return evaluate result
     */
    double evaluate(EvalContext evalContext);
    /**
     * Set the number of recommended items.
     *
     * @param topN the number of recommended items
     */
    void setTopN(int topN);

    void setDataModel(DataModel dataModel);
    Configuration getConf();
    DataModel getDataModel();
}