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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lenskit-specs Show documentation

JavaBeans describing various LensKit objects, used for serializing between Gradle and the CLI.

There is a newer version: 3.0-T5

/*
 * 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 com.fasterxml.jackson.annotation.JsonSubTypes;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.node.TextNode;
import org.lenskit.specs.AbstractSpec;
import org.lenskit.specs.DynamicSpec;

import java.nio.file.Path;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;

/**
 * Base type for eval task specifications.
 */
@JsonSubTypes({@JsonSubTypes.Type(value=PredictEvalTaskSpec.class, name="predict"),
        @JsonSubTypes.Type(value=RecommendEvalTaskSpec.class, name="recommend")})
@JsonTypeInfo(use= JsonTypeInfo.Id.NAME,
        include = JsonTypeInfo.As.PROPERTY,
        property = "type")
public abstract class EvalTaskSpec extends AbstractSpec {
    private List metrics = new ArrayList<>();

    /**
     * Get the output files for this task.
     * @return The task's output files.
     */
    @JsonIgnore
    public abstract Set getOutputFiles();

    /**
     * Get the user Top-N metrics.
     * @return The metrics
     */
    public List getMetrics() {
        return metrics;
    }

    /**
     * Set the user Top-N metrics.
     * @param ms The metrics.
     */
    public void setMetrics(List ms) {
        metrics = ms;
    }

    /**
     * Add a user Top-N metric.
     * @param metric The metric configuration.
     */
    public void addMetric(JsonNode metric) {
        metrics.add(new DynamicSpec(metric));
    }

    /**
     * Add a metric by name.  The metric will have no additional configuration.
     * @param metric The metric name.
     */
    public void addMetric(String metric) {
        addMetric(new TextNode(metric));
    }
}