net.librec.recommender.Recommender Maven / Gradle / Ivy

Go to download
/**
 * 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.recommender;

import net.librec.common.LibrecException;
import net.librec.data.DataModel;
import net.librec.eval.Measure.MeasureValue;
import net.librec.eval.RecommenderEvaluator;
import net.librec.recommender.item.RecommendedItem;

import java.util.List;
import java.util.Map;

/**
 * General recommenders
 *
 * @author WangYuFeng
 */
public interface Recommender {
    /**
     * recommend
     *
     * @param context  recommender context
     * @throws LibrecException if error occurs during recommending
     */
    void recommend(RecommenderContext context) throws LibrecException;

    /**
     * evaluate
     *
     * @param  evaluator recommender evaluator
     * @return evaluate result
     * @throws LibrecException if error occurs during evaluating
     */
    double evaluate(RecommenderEvaluator evaluator) throws LibrecException;

    /**
     * evaluate Map
     *
     * @return evaluate map
     * @throws LibrecException if error occurs during constructing evaluate map
     */
    Map evaluateMap() throws LibrecException;

    /**
     * get DataModel
     *
     * @return data model
     */
    DataModel getDataModel();

    /**
     * load Model
     *
     * @param filePath file path
     */
    void loadModel(String filePath);

    /**
     * save Model
     *
     * @param filePath file path
     */
    void saveModel(String filePath);

    /**
     * get Recommended List
     *
     * @return  recommended list
     */
    List getRecommendedList();


    /**
     * set Context
     *
     * @param context recommender context
     */
    void setContext(RecommenderContext context);
}