capreolus.run

Module Contents

Functions

parse_task_string(s)

prepare_task(fullcommand, config)

Attributes

logger

help

arguments

capreolus.run.logger[source]
capreolus.run.parse_task_string(s)[source]
capreolus.run.prepare_task(fullcommand, config)[source]
capreolus.run.help = Multiline-String[source]
Show Value
 1Usage:
 2    capreolus COMMAND [(with CONFIG...)] [options]
 3    capreolus help [COMMAND]
 4    capreolus (-h | --help)
 5
 6
 7    Options:
 8      -h --help                     Print this help message and exit.
 9      -l VALUE --loglevel=VALUE     Set the log level: DEBUG, INFO, WARNING, ERROR, or CRITICAL.
10      -p VALUE --priority=VALUE     Sets the priority for a queued up experiment. No effect without -q flag.
11      -q --queue                    Queue this run, and do not start it.
12
13
14    Arguments:
15      PIPELINE  Name of pipeline to run, which consists of a Task and a command (see below for a list)
16      CONFIG    Configuration assignments of the form foo.bar=17
17
18
19    Tasks and their commands:
20      rank.search             search a collection using queries from a benchmark
21      rank.evaluate           evaluate the result of rank.search
22      rank.searcheval         run rank.search followed by rank.evaluate
23
24      rerank.train            run rank.search and train a model to rerank the results
25      rerank.evaluate         evaluate the result of rerank.train
26      rerank.traineval        run rerank.train followed by rerank.evaluate
27
28      rererank.train          run rerank.train and train a (second) model to rerank the results
29      rererank.evaluate       evaluate the result of rererank.train
30      rererank.traineval      run rererank.train followed by rererank.evaluate
31
32      tutorial.run            task from the "Getting Started" tutorial
33
34    All tasks additionally support the following help commands: describe, print_config, print_pipeline
35      e.g., capreolus rank.print_config with searcher=BM25
capreolus.run.arguments[source]