:mod:`capreolus.task.base`
==========================

.. py:module:: capreolus.task.base


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   capreolus.task.base.Task
   capreolus.task.base.ModulesTask



.. py:class:: Task

   Bases: :class:`profane.ModuleBase`

   .. attribute:: module_type
      :annotation: = task

      

   .. attribute:: commands
      :annotation: = []

      

   .. attribute:: help_commands
      :annotation: = ['describe', 'print_config', 'print_paths', 'print_pipeline']

      

   .. attribute:: default_command
      :annotation: = describe

      

   .. attribute:: requires_random_seed
      :annotation: = True

      

   .. method:: print_config(self)


   .. method:: print_paths(self)


   .. method:: print_pipeline(self)


   .. method:: describe(self)


   .. method:: get_results_path(self)

      Return an absolute path that can be used for storing results.
      The path is a function of the module's config and the configs of its dependencies.



.. py:class:: ModulesTask

   Bases: :class:`capreolus.task.base.Task`

   .. attribute:: module_name
      :annotation: = modules

      

   .. attribute:: commands
      :annotation: = ['list_modules']

      

   .. attribute:: default_command
      :annotation: = list_modules

      

   .. method:: list_modules(self)