/*
* 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.grouplens.lenskit.eval.graph;
import com.google.common.io.Files;
import org.grouplens.grapht.Component;
import org.grouplens.grapht.Dependency;
import org.grouplens.grapht.ResolutionException;
import org.grouplens.grapht.graph.DAGNode;
import org.grouplens.grapht.util.Providers;
import org.grouplens.lenskit.RecommenderBuildException;
import org.grouplens.lenskit.core.LenskitConfiguration;
import org.grouplens.lenskit.core.RecommenderConfigurationException;
import org.grouplens.lenskit.data.dao.EventDAO;
import org.grouplens.lenskit.data.pref.PreferenceDomain;
import org.grouplens.lenskit.eval.AbstractTask;
import org.grouplens.lenskit.eval.TaskExecutionException;
import org.grouplens.lenskit.eval.algorithm.AlgorithmInstance;
import org.grouplens.lenskit.eval.algorithm.AlgorithmInstanceBuilder;
import org.grouplens.lenskit.inject.RecommenderGraphBuilder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.annotation.Nonnull;
import java.io.File;
import java.io.IOException;
import java.util.Map;
/**
* Command to dump a graph.
*
* @author <a href="http://www.grouplens.org">GroupLens Research</a>
*/
@SuppressWarnings("unused")
public class DumpGraphTask extends AbstractTask<File> {
private static final Logger logger = LoggerFactory.getLogger(DumpGraphTask.class);
private AlgorithmInstance algorithm;
private File output;
private PreferenceDomain domain = null;
public DumpGraphTask() {
this(null);
}
public DumpGraphTask(String name) {
super(name);
}
@Nonnull
@Override
public String getName() {
String name = super.getName();
if (name == null) {
name = algorithm.getName();
if (name == null) {
name = "algorithm";
}
}
return name;
}
public AlgorithmInstance getAlgorithm() {
return algorithm;
}
public DumpGraphTask setAlgorithm(AlgorithmInstance algorithm) {
this.algorithm = algorithm;
return this;
}
public DumpGraphTask setAlgorithm(Map<String,Object> attrs, File file) throws IOException, RecommenderConfigurationException {
algorithm = new AlgorithmInstanceBuilder().configureFromFile(attrs, file)
.build();
return this;
}
public DumpGraphTask setAlgorithm(Map<String,Object> attrs, String file) throws IOException, RecommenderConfigurationException {
algorithm = new AlgorithmInstanceBuilder().configureFromFile(attrs, new File(file))
.build();
return this;
}
public File getOutput() {
return output;
}
public DumpGraphTask setOutput(File f) {
output = f;
return this;
}
public DumpGraphTask setOutput(String fn) {
return setOutput(new File(fn));
}
public PreferenceDomain getDomain() {
return domain;
}
public DumpGraphTask setDomain(PreferenceDomain dom) {
domain = dom;
return this;
}
@Override
public File perform() throws TaskExecutionException {
if (output == null) {
logger.error("no output file specified");
throw new IllegalStateException("no graph output file specified");
}
LenskitConfiguration daoConfig = new LenskitConfiguration();
daoConfig.bind(EventDAO.class).toProvider(Providers.<EventDAO>of(null, EventDAO.class));
if (domain != null) {
daoConfig.bind(PreferenceDomain.class).to(domain);
}
RecommenderGraphBuilder rgb = new RecommenderGraphBuilder();
rgb.addConfiguration(daoConfig);
rgb.addConfiguration(algorithm.getConfig());
DAGNode<Component,Dependency> graph = null;
try {
graph = rgb.buildGraph();
} catch (ResolutionException e) {
throw new TaskExecutionException("Cannot resolve graph", e);
}
logger.info("dumping graph {}", getName());
try {
Files.createParentDirs(output);
GraphDumper.renderGraph(graph, output);
} catch (IOException e) {
throw new TaskExecutionException("error writing graph", e);
} catch (RecommenderBuildException e) {
throw new TaskExecutionException("error processing graph", e);
}
// TODO Support dumping the instantiated graph again
return output;
}
}