org.lenskit.specs.eval.TrainTestExperimentSpec Maven / Gradle / Ivy

Go to download
/*
 * LensKit, an open source recommender systems toolkit.
 * Copyright 2010-2014 LensKit Contributors.  See CONTRIBUTORS.md.
 * Work on LensKit has been funded by the National Science Foundation under
 * grants IIS 05-34939, 08-08692, 08-12148, and 10-17697.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of the
 * License, or (at your option) any later version.
 *
 * This program 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
 * this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */
package org.lenskit.specs.eval;

import com.fasterxml.jackson.annotation.JsonIgnore;
import org.lenskit.specs.AbstractSpec;

import java.nio.file.Path;
import java.util.*;

/**
 * Specification for train-test experiments.
 */
public class TrainTestExperimentSpec extends AbstractSpec {
    private Path outputFile;
    private Path userOutputFile;
    private Path cacheDirectory;
    private boolean shareModelComponents = true;
    private List dataSets = new ArrayList<>();
    private List algorithms = new ArrayList<>();
    private List tasks = new ArrayList<>();

    /**
     * Get the global output file.
     * @return The global output file.
     */
    public Path getOutputFile() {
        return outputFile;
    }

    /**
     * Set the global output file.
     * @param file The output file for global aggregate measurements.
     */
    public void setOutputFile(Path file) {
        outputFile = file;
    }

    /**
     * Get the per-user output file.
     * @return The output file for per-user measurements.
     */
    public Path getUserOutputFile() {
        return userOutputFile;
    }

    /**
     * Set the per-user output file.
     * @param file The output file for per-user measurements.
     */
    public void setUserOutputFile(Path file) {
        userOutputFile = file;
    }

    /**
     * Get the cache directory.
     * @return The directory to use for caching objects.
     */
    public Path getCacheDirectory() {
        return cacheDirectory;
    }

    /**
     * Set the cache directory.
     * @param dir The direcetory to use for caching objects.
     */
    public void setCacheDirectory(Path dir) {
        cacheDirectory = dir;
    }

    /**
     * Query whether model components will be shared.
     * @return `true` if model components will be shared (the default).
     */
    public boolean getShareModelComponents() {
        return shareModelComponents;
    }

    /**
     * Set whether model components will be shared.  The default is to share them.
     * @param share `true` to share model components, `false` to disable sharing.
     */
    public void setShareModelComponents(boolean share) {
        shareModelComponents = share;
    }

    /**
     * Get all output files for this experiment.
     * @return A set of all known output files.
     */
    @JsonIgnore
    public Set getOutputFiles() {
        Set files = new HashSet<>();
        if (outputFile != null) {
            files.add(outputFile);
        }
        if (userOutputFile != null) {
            files.add(userOutputFile);
        }
        for (EvalTaskSpec task: tasks) {
            files.addAll(task.getOutputFiles());
        }
        return files;
    }

    /**
     * Get the list of data sets.
     * @return The list of data sets.
     */
    public List getDataSets() {
        return dataSets;
    }

    /**
     * Set the list of data sets.
     * @param dss The list of data sets to use.
     */
    public void setDataSets(List dss) {
        dataSets = dss;
    }

    /**
     * Add a data set.
     * @param ds A data set to use.
     */
    public void addDataSet(DataSetSpec ds) {
        dataSets.add(ds);
    }

    /**
     * Add some data sets.
     * @param dss Data sets to add.
     */
    public void addDataSets(Collection dss) {
        dataSets.addAll(dss);
    }

    /**
     * Add some data sets.
     * @param dss Data sets to add.
     */
    public void addDataSets(DataSetSpec... dss) {
        dataSets.addAll(Arrays.asList(dss));
    }

    /**
     * Get the list of algorithms.
     * @return The list of algorithms.
     */
    public List getAlgorithms() {
        return algorithms;
    }

    /**
     * Set the list of algorithms.
     * @param dss The list of algorithms to use.
     */
    public void setAlgorithms(List dss) {
        algorithms = dss;
    }

    /**
     * Add a algorithm.
     * @param ds A algorithm to use.
     */
    public void addAlgorithm(AlgorithmSpec ds) {
        algorithms.add(ds);
    }

    /**
     * Add some algorithms.
     * @param dss Algorithms to add.
     */
    public void addAlgorithms(Collection dss) {
        algorithms.addAll(dss);
    }

    /**
     * Add some algorithms.
     * @param dss Algorithms to add.
     */
    public void addAlgorithms(AlgorithmSpec... dss) {
        algorithms.addAll(Arrays.asList(dss));
    }

    /**
     * Get the list of tasks.
     * @return The list of eval tasks.
     */
    public List getTasks() {
        return tasks;
    }

    /**
     * Set the list of eval tasks.
     * @param tasks The list of eval tasks to use.
     */
    public void setTasks(List tasks) {
        this.tasks = tasks;
    }

    /**
     * Add a evaltask.
     * @param ds A evaltask to use.
     */
    public void addTask(EvalTaskSpec ds) {
        tasks.add(ds);
    }

    /**
     * Add some evaltasks.
     * @param dss Evaltasks to add.
     */
    public void addTasks(Collection dss) {
        tasks.addAll(dss);
    }

    /**
     * Add some evaltasks.
     * @param dss Evaltasks to add.
     */
    public void addTasks(EvalTaskSpec... dss) {
        tasks.addAll(Arrays.asList(dss));
    }
}