Skip to content
Snippets Groups Projects
Commit 4fa68402 authored by leufen1's avatar leufen1
Browse files

use new table format for defaults

parent 10446114
No related branches found
No related tags found
5 merge requests!319add all changes of dev into release v1.4.0 branch,!318Resolve "release v1.4.0",!299Draft: Merge default data handler and preprocessing support parameter use_multiprocessing....,!285enhanced multiprocessing switch for debugging,!259Draft: Resolve "WRF-Datahandler should inherit from SingleStationDatahandler"
Pipeline #64980 passed
...@@ -4,74 +4,8 @@ Defaults ...@@ -4,74 +4,8 @@ Defaults
In this section, we explain which parameters are set by MLAir during the :py:`ExperimentSetup` if not specified by the In this section, we explain which parameters are set by MLAir during the :py:`ExperimentSetup` if not specified by the
user. This is important information for example if a new :ref:`Custom Data Handler` is implemented. user. This is important information for example if a new :ref:`Custom Data Handler` is implemented.
================================= ======================== ============================================================
parameter default comment
================================= ======================== ============================================================
batch_path
batch_size :py:`512`
bootstrap_path
competitor_path
competitors :py:`[]`
create_new_bootstraps :py:`False`
create_new_model :py:`True`
data_handler :py:`DefaultDataHandler`
data_origin
data_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
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
forecast_path
fraction_of_training
hostname
hpc_hosts
interpolation_limit :py:`1`
interpolation_method :py:`"linear"`
logging_path
login_nodes
model_class
model_path
neighbors
number_of_bootstraps
overwrite_local_data
permute_data :py:`False`
plot_list
plot_path
start ``"1997-01-01"``
stations
statistics_per_var
target_dim
target_var
test_start
test_end
test_min_length
time_dim
train_model
train_end
train_min_length
train_start
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
upsampling
val_end
val_min_length
val_start
variables
window_history_size :py:`13`
window_lead_time :py:`3`
================================= ======================== ============================================================
.. list-table:: Defaults Overview
.. list-table:: Title
:widths: 25 25 50 :widths: 25 25 50
:header-rows: 1 :header-rows: 1
...@@ -84,6 +18,171 @@ window_lead_time :py:`3` ...@@ -84,6 +18,171 @@ window_lead_time :py:`3`
* - batch_size * - batch_size
- :py:`512` - :py:`512`
- -
* - bootstrap_path
-
-
* - competitor_path
-
-
* - competitors
- :py:`[]`
-
* - create_new_bootstraps
- :py:`False`
-
* - create_new_model
- :py:`True`
-
* - data_handler
- :py:`DefaultDataHandler`
-
* - data_origin
-
-
* - data_path
-
-
* - debug * - debug
- ``-`` - ``-``
- MLAir checks if it is running in debug mode and stores this - 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
* - evaluate_bootstraps
- :py:`True`
- Bootstrapping may take some time.
* - experiment_name
-
-
* - experiment_path
-
-
* - extreme_values
- :py:`None`
-
* - extremes_on_right_tail_only
- :py:`False`
- Could be used for skewed distributions
* - forecast_path
-
-
* - fraction_of_training
-
-
* - hostname
-
-
* - hpc_hosts
-
-
* - interpolation_limit
- :py:`1`
-
* - interpolation_method
- :py:`"linear"`
-
* - logging_path
-
-
* - login_nodes
-
-
* - model_class
-
-
* - model_path
-
-
* - neighbors
-
-
* - number_of_bootstraps
-
-
* - overwrite_local_data
-
-
* - permute_data
- :py:`False`
-
* - plot_list
-
-
* - plot_path
-
-
* - start
- :py:`"1997-01-01"`
-
* - stations
-
-
* - statistics_per_var
-
-
* - target_dim
-
-
* - target_var
-
-
* - test_start
-
-
* - test_end
-
-
* - test_min_length
-
-
* - time_dim
-
-
* - train_model
-
-
* - train_end
-
-
* - train_min_length
-
-
* - train_start
-
-
* - 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
* - upsampling
-
-
* - val_end
-
-
* - val_min_length
-
-
* - val_start
-
-
* - variables
-
-
* - window_history_size
- :py:`13`
-
* - window_lead_time
- :py:`3`
-
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment