From 2b0b7321aaa3e918b00af4e9248925902b34693f Mon Sep 17 00:00:00 2001
From: Andrew Yates <andrew.yates@gmail.com>
Date: Sat, 13 Jun 2020 16:01:31 +0200
Subject: [PATCH] Tutorial task from Getting Started guide

---
 capreolus/task/tutorial.py | 47 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)
 create mode 100644 capreolus/task/tutorial.py

diff --git a/capreolus/task/tutorial.py b/capreolus/task/tutorial.py
new file mode 100644
index 000000000..1df31c4e6
--- /dev/null
+++ b/capreolus/task/tutorial.py
@@ -0,0 +1,47 @@
+from capreolus import evaluator, Dependency, ConfigOption
+from capreolus.searcher import Searcher
+from capreolus.task import Task
+from capreolus.utils.loginit import get_logger
+
+logger = get_logger(__name__)  # pylint: disable=invalid-name
+
+
+@Task.register
+class TutorialTask(Task):
+    module_name = "tutorial"
+    config_spec = [ConfigOption("optimize", "map", "metric to maximize on the validation set")]
+    dependencies = [
+        Dependency(
+            key="benchmark", module="benchmark", name="robust04.yang19", provide_this=True, provide_children=["collection"]
+        ),
+        Dependency(key="searcher1", module="searcher", name="BM25RM3"),
+        Dependency(key="searcher2", module="searcher", name="SDM"),
+    ]
+
+    commands = ["run"] + Task.help_commands
+    default_command = "run"
+
+    def run(self):
+        output_dir = self.get_results_path()
+
+        # read the title queries from the chosen benchmark's topic file
+        results1 = self.searcher1.query_from_file(self.benchmark.topic_file, output_dir / "searcher1")
+        results2 = self.searcher2.query_from_file(self.benchmark.topic_file, output_dir / "searcher2")
+        searcher_results = [results1, results2]
+
+        # using the benchmark's folds, which each contain train/validation/test queries,
+        # choose the best run in `output_dir` for the fold based on the validation queries
+        # and return metrics calculated on the test queries
+        best_results = evaluator.search_best_run(
+            searcher_results, self.benchmark, primary_metric=self.config["optimize"], metrics=evaluator.DEFAULT_METRICS
+        )
+
+        for fold, path in best_results["path"].items():
+            shortpath = "..." + path[:-20]
+            logger.info("fold=%s best run: %s", fold, shortpath)
+
+        logger.info("cross-validated results when optimizing for '%s':", self.config["optimize"])
+        for metric, score in sorted(best_results["score"].items()):
+            logger.info("%15s: %0.4f", metric, score)
+
+        return best_results