diff --git a/docs/_source/defaults.rst b/docs/_source/defaults.rst index 3a25ae617c2124e01f1a63e3a6aff467e5074c07..89a113f13b8f1829beac9d7793cbdb7783e8720a 100644 --- a/docs/_source/defaults.rst +++ b/docs/_source/defaults.rst @@ -21,11 +21,11 @@ debug ``-`` MLAir checks if it is dimensions end :py:`"2017-12-31"` epochs :py:`20` This is just a placeholder to prevent unintended longish training -evaluate_bootstraps :py:`True` Bootstrapping can take some time. +evaluate_bootstraps :py:`True` Bootstrapping can take some time. experiment_name experiment_path extreme_values :py:`None` -extremes_on_right_tail_only :py:`False` Could be used for skew distributions +extremes_on_right_tail_only :py:`False` Could be used for skew distributions forecast_path fraction_of_training hostname @@ -55,11 +55,11 @@ train_model train_end train_min_length train_start -transformation :py:`{}` implement all further transformation functionality - inside your custom data handler +transformation :py:`{}` implement all further transformation functionality + inside your custom data handler use_all_stations_on_all_data_sets -use_multiprocessing :py:`True` is used if MLAir is not running in debug mode -use_multiprocessing_on_debug :py:`False` is used if MLAir is running in debug mode +use_multiprocessing :py:`True` is used if MLAir is not running in debug mode +use_multiprocessing_on_debug :py:`False` is used if MLAir is running in debug mode upsampling val_end val_min_length @@ -67,22 +67,23 @@ val_start variables window_history_size :py:`13` window_lead_time :py:`3` -================================= ==================== ============================================================ - +================================= ======================== ============================================================ -Test Table +.. list-table:: Title + :widths: 25 25 50 + :header-rows: 1 -+---------+---------+---------+ -| parameter | default | comment | -+---------+---------+---------+ -| batch_path | | -| batch_size | :py:`512` | | -| bootstrap_path | | -| competitor_path | | -| debug | ``-`` | MLAir checks if it is running in debug mode and stores this | -| dimensions | | -| end | :py:`"2017-12-31"` | | -| epochs | :py:`20` | This is just a placeholder to prevent unintended longish training | -+---------+---------+---------+ \ No newline at end of file + * - parameter + - default + - comment + * - batch_path + - + - + * - batch_size + - :py:`512` + - + * - debug + - ``-`` + - MLAir checks if it is running in debug mode and stores this