RecommendEvalTask (LensKit 3.0-SNAPSHOT)

java.lang.Object
- org.lenskit.eval.traintest.recommend.RecommendEvalTask

All Implemented Interfaces:

EvalTask
```
public class RecommendEvalTask
extends java.lang.Object
implements EvalTask
```
An eval task that attempts to recommend items for a test user.

Constructor Summary

Constructors
Constructor and Description

RecommendEvalTask()
Create a new recommend eval task.

Constructors
Constructor and Description
`RecommendEvalTask()` Create a new recommend eval task.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMetric(TopNMetric<?> metric)` Add a prediction metric.
`ConditionEvaluator`	`createConditionEvaluator(AlgorithmInstance algorithm, DataSet dataSet, RecommenderEngine rec)` Set up a measurement of a single recommender.
`void`	`finish()` Finalize this eval task.
`static RecommendEvalTask`	`fromJSON(com.fasterxml.jackson.databind.JsonNode json, java.net.URI base)` Parse a recommend task from JSON.
`java.util.List<Metric<?>>`	`getAllMetrics()` Get the list of all metrics.
`ItemSelector`	`getCandidateSelector()` Get the active candidate selector.
`ItemSelector`	`getExcludeSelector()` Get the active exclude selector.
`java.util.List<java.lang.String>`	`getGlobalColumns()` Get columns that will go in the aggregate output file.
`java.nio.file.Path`	`getItemOutputFile()` Get the output file for writing per-target-item results.
`java.lang.String`	`getLabelPrefix()` Get the prefix applied to column labels.
`int`	`getListSize()` Get the list size to use.
`java.nio.file.Path`	`getOutputFile()` Get the output file for writing recommendations.
`java.util.Set<java.lang.Class<?>>`	`getRequiredRoots()` Get the root types required by this evaluation.
`boolean`	`getSeparateItems()` Query whether this task will separate items.
`java.util.List<TopNMetric<?>>`	`getTopNMetrics()` Get the list of prediction metrics.
`java.util.List<java.lang.String>`	`getUserColumns()` Get columns that will go in the per-user output file.
`void`	`setCandidateSelector(ItemSelector sel)` Set the candidate selector.
`void`	`setExcludeSelector(ItemSelector sel)` Set the exclude selector.
`void`	`setItemOutputFile(java.nio.file.Path file)` Set the output file for per-target-item results.
`void`	`setLabelPrefix(java.lang.String prefix)` Set the prefix applied to column labels.
`void`	`setListSize(int n)` Set the list size to use.
`void`	`setOutputFile(java.nio.file.Path file)` Set the output file for recommendations.
`void`	`setSeparateItems(boolean sep)` Control whether this task will separate items.
`void`	`start(ExperimentOutputLayout outputLayout)` Do initial setup for this eval task.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RecommendEvalTask
```
public RecommendEvalTask()
```
    Create a new recommend eval task.
- Method Detail
  - fromJSON
```
public static RecommendEvalTask fromJSON(com.fasterxml.jackson.databind.JsonNode json,
                                         java.net.URI base)
                                  throws java.io.IOException
```
    Parse a recommend task from JSON.
    
    Parameters:
    
    json - The JSON data.
    
    base - The base URI (for resolving relative paths).
    
    Returns:
    
    The task.
    
    Throws:
    
    java.io.IOException - If there is an I/O error.
  - getOutputFile
```
public java.nio.file.Path getOutputFile()
```
    Get the output file for writing recommendations.
    
    Returns:
    
    The output file, or null if no file is configured.
  - setOutputFile
```
public void setOutputFile(java.nio.file.Path file)
```
    Set the output file for recommendations.
    
    Parameters:
    
    file - The output file for writing predictions. Will get a CSV file.
  - getItemOutputFile
```
public java.nio.file.Path getItemOutputFile()
```
    Get the output file for writing per-target-item results.
    
    Returns:
    
    The output file, or null if no file is configured.
  - setItemOutputFile
```
public void setItemOutputFile(java.nio.file.Path file)
```
    Set the output file for per-target-item results.
    
    Parameters:
    
    file - The output file for writing predictions. Will get a CSV file.
  - getLabelPrefix
```
public java.lang.String getLabelPrefix()
```
    Get the prefix applied to column labels.
    
    Returns:
    
    The column label prefix.
  - setLabelPrefix
```
public void setLabelPrefix(java.lang.String prefix)
```
    Set the prefix applied to column labels. If provided, it will be prepended to column labels from this task, along with a “.”.
    
    Parameters:
    
    prefix - The label prefix.
  - getListSize
```
public int getListSize()
```
    Get the list size to use.
    
    Returns:
    
    The number of items to recommend per user.
  - setListSize
```
public void setListSize(int n)
```
    Set the list size to use.
    
    Parameters:
    
    n - The number of items to recommend per user.
  - getSeparateItems
```
public boolean getSeparateItems()
```
    Query whether this task will separate items.
    
    Returns:
    
    true if test items are evaluated separately.
  - setSeparateItems
```
public void setSeparateItems(boolean sep)
```
    Control whether this task will separate items.
    
    Parameters:
    
    sep - true to evaluate test items separately.
  - getCandidateSelector
```
public ItemSelector getCandidateSelector()
```
    Get the active candidate selector.
    
    Returns:
    
    The candidate selector to use.
  - setCandidateSelector
```
public void setCandidateSelector(ItemSelector sel)
```
    Set the candidate selector.
    
    Parameters:
    
    sel - The candidate selector.
  - getExcludeSelector
```
public ItemSelector getExcludeSelector()
```
    Get the active exclude selector.
    
    Returns:
    
    The exclude selector to use.
  - setExcludeSelector
```
public void setExcludeSelector(ItemSelector sel)
```
    Set the exclude selector.
    
    Parameters:
    
    sel - The exclude selector.
  - getTopNMetrics
```
public java.util.List<TopNMetric<?>> getTopNMetrics()
```
    Get the list of prediction metrics.
    
    Returns:
    
    The list of prediction metrics. This list is live, not copied, so it can be modified or cleared.
  - getAllMetrics
```
public java.util.List<Metric<?>> getAllMetrics()
```
    Get the list of all metrics.
    
    Returns:
    
    A list containing all metrics used by this task.
  - addMetric
```
public void addMetric(TopNMetric<?> metric)
```
    Add a prediction metric.
    
    Parameters:
    
    metric - The metric to add.
  - getRequiredRoots
```
public java.util.Set<java.lang.Class<?>> getRequiredRoots()
```
    Description copied from interface: EvalTask
    
    Get the root types required by this evaluation.
    
    Specified by:
    
    getRequiredRoots in interface EvalTask
    
    Returns:
    
    The root types required by this evaluation.
  - getGlobalColumns
```
public java.util.List<java.lang.String> getGlobalColumns()
```
    Description copied from interface: EvalTask
    
    Get columns that will go in the aggregate output file.
    
    Specified by:
    
    getGlobalColumns in interface EvalTask
    
    Returns:
    
    The list of column names that this task will contribute to the aggregate output file.
  - getUserColumns
```
public java.util.List<java.lang.String> getUserColumns()
```
    Description copied from interface: EvalTask
    
    Get columns that will go in the per-user output file.
    
    Specified by:
    
    getUserColumns in interface EvalTask
    
    Returns:
    
    The list of column names that this task will contribute to the per-user output file.
  - start
```
public void start(ExperimentOutputLayout outputLayout)
```
    Description copied from interface: EvalTask
    
    Do initial setup for this eval task. This should create any per-task output files, etc.
    
    Specified by:
    
    start in interface EvalTask
    
    Parameters:
    
    outputLayout - The output layout for experiment results.
  - finish
```
public void finish()
```
    Description copied from interface: EvalTask
    
    Finalize this eval task. This should finish writing and close any per-task output files, etc.
    
    Specified by:
    
    finish in interface EvalTask
  - createConditionEvaluator
```
public ConditionEvaluator createConditionEvaluator(AlgorithmInstance algorithm,
                                                   DataSet dataSet,
                                                   RecommenderEngine rec)
```
    Description copied from interface: EvalTask
    
    Set up a measurement of a single recommender.
    
    Specified by:
    
    createConditionEvaluator in interface EvalTask
    
    Parameters:
    
    algorithm - The algorithm being evaluated.
    
    dataSet - The data set being evaluated.
    
    rec - The recommender engine that will be measured.
    
    Returns:
    
    A condition evaluator that will measure the recommender’s performance on the algorithm and data set.

Class RecommendEvalTask

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RecommendEvalTask

Method Detail

fromJSON

getOutputFile

setOutputFile

getItemOutputFile

setItemOutputFile

getLabelPrefix

setLabelPrefix

getListSize

setListSize

getSeparateItems

setSeparateItems

getCandidateSelector

setCandidateSelector

getExcludeSelector

setExcludeSelector

getTopNMetrics

getAllMetrics

addMetric

getRequiredRoots

getGlobalColumns

getUserColumns

start

finish

createConditionEvaluator