capreolus.task.rank

Module Contents

Classes

RankTask

Base class for Task modules. The purpose of a Task is to describe a Capreolus pipeline and serve as the pipeline’s entry point. Tasks provide one or more commands that provide entry points while sharing the Task’s configuration options and dependencies.

Attributes

logger

capreolus.task.rank.logger[source]
class capreolus.task.rank.RankTask(config=None, provide=None, share_dependency_objects=False, build=True)[source]

Bases: capreolus.task.Task

Base class for Task modules. The purpose of a Task is to describe a Capreolus pipeline and serve as the pipeline’s entry point. Tasks provide one or more commands that provide entry points while sharing the Task’s configuration options and dependencies.

Modules should provide:
  • a commands attribute containing the names of methods that can serve as pipeline entry points (Task commands). Each command will be accessible via the CLI using the syntax capreolus <task name>.<command name> ...

  • a default_command attribute containing the name of a command to run if none is given

  • methods (taking only the self argument) that correspond to each command defined

module_name = rank[source]
requires_random_seed = False[source]
config_spec[source]
config_keys_not_in_path = ['optimize', 'metrics'][source]
dependencies[source]
commands[source]
default_command = describe[source]
searcheval(self)[source]
search(self)[source]
evaluate(self)[source]