X-Git-Url: http://mj.ucw.cz/gitweb/?a=blobdiff_plain;ds=sidebyside;f=t%2Fdoc%2Ftimeline.rst;h=df67a09dc1393951880a8e1a945550b3f63ec121;hb=df430d8cc46be638ba60c3cd6d27dfba1caa0b5c;hp=4c5383e0c1fc76ae3653ca366d31898feb502bf5;hpb=750990d7dbbaf2740f290a26dab527ce4444cbfb;p=moe.git diff --git a/t/doc/timeline.rst b/t/doc/timeline.rst index 4c5383e..df67a09 100644 --- a/t/doc/timeline.rst +++ b/t/doc/timeline.rst @@ -1,12 +1,14 @@ .. _timeline: +.. currentmodule:: moe.eval + Evaluation timeline ==================== `Eval.init` ------------ -:func:`Eval.init ` is run before the main pipeline and does the following: +:func:`Eval.init` is run before the main pipeline and does the following: ======= ========== Time Action @@ -16,21 +18,21 @@ Time Action \ Fix `CONFIG` and load the config file `CONFIG` \ Fix `LOG`, `USER_LOG`, `VERBOSE`, `HOME`, `DEBUG_LEVEL`, `TDIR` \ Start logging system (to `LOG` and `USER_LOG`) -\ Check basic settings, directories and rights (currently checking only `TDIR`) -\ Insert predefined hooks ([m]) and `HOOKS` to main pipeline +\ Insert predefined hooks ([m]) and custom `HOOKS` to main pipeline ======= ========== Main pipeline ------------- -Ran by `Eval.run`. +Ran by :func:`Eval.run`. ======= ========== Time Action ======= ========== -10 [m] Task **must** be ready (rsynced, pulled). Locate and fix `PDIR` -15 [m] Load `TASK_CONFIG_FILE` (dep. on `PDIR`) -20 [m] Check `TASK_TYPE` and depending on that, initialize the module and insert future actions +5 [m :func:`Eval.hook_init_dirs`] Check basic settings and directories +10 *Task must be ready (rsynced, pulled)* +15 [m :func:`Eval.hook_load_task_config`] Load task config file +20 [m :func:`Eval.hook_init_tasktype`] Import and initialize the task-type module **For 'standard':** ------------------ 25 [tt] Locate the source @@ -44,11 +46,11 @@ Time Action 30 [tt] Initialize sandbox module (if needed) 40 [tt] Initialize judge module, insert its hooks 60 [tt] Run test pipeline for each `TEST` of `TESTS` -**Recovery** +**Cleanup** ------------------ 70 Any failure jumps to this time -80 [*] Cleanup must be finished -\ Write metafile +80 Cleanup *must* be finished +90 [m :func:`Eval.hook_write_metadata`] Write metafile ======= ========== Test pipeline @@ -71,7 +73,7 @@ Time Action 20 [tt] Locate the data file, copy to 40 [tt] Run judge (inside sandbox) 50 [tt] Read/parse judge result -**Recovery** +**Cleanup** -------------------------------- 70 Any failure jumps to this time 80 [*] Cleanup must be finished