From 56d8243d1a1e14180e979807478251c69129a54e Mon Sep 17 00:00:00 2001 From: Zezhi Shao <864453277@qq.com> Date: Tue, 3 Sep 2024 18:36:05 +0800 Subject: [PATCH] temp cmt --- tutorial/config_design.md | 24 ++++++++++++------------ tutorial/dataset_design.md | 2 +- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/tutorial/config_design.md b/tutorial/config_design.md index f8042f2..ff8fd1c 100644 --- a/tutorial/config_design.md +++ b/tutorial/config_design.md @@ -12,18 +12,18 @@ The configuration file typically includes the following sections: - **Scaler Options**: Specifies `NAME`, `TYPE` (Scaler Class), `PARAMS` (Scaler Parameters), etc. - **Model Options**: Specifies `NAME`, `TYPE` (Model Class), `PARAMS` (Model Parameters), etc. - **Metrics Options**: Includes `FUNCS` (Metric Functions), `TARGET` (Target Metrics), `NULL_VALUE` (Handling of Missing Values), etc. -- **TRAIN Options**: - - **GENERAL**: Specifies settings like `EPOCHS`, `LOSS`, `EARLY_STOPPING`, etc. - - **OPTIMIZER**: Specifies `TYPE` (Optimizer Class), `PARAMS` (Optimizer Parameters), etc. - - **SCHEDULER**: Specifies `TYPE` (Scheduler Class), `PARAMS` (Scheduler Parameters), etc. - - **CURRICULUM_LEARNING**: Includes settings like `CL_EPOHS`, `WARMUP_EPOCHS`, `STEP_SIZE`, etc. - - **DATA**: Specifies settings like `BATCH_SIZE`, `NUM_WORKERS`, `PIN_MEMORY`, etc. -- **VALID Options**: - - **GENERAL**: Includes `INTERVAL` for validation frequency. - - **DATA**: Specifies settings like `BATCH_SIZE`, `NUM_WORKERS`, `PIN_MEMORY`, etc. -- **TEST Options**: - - **GENERAL**: Includes `INTERVAL` for testing frequency. - - **DATA**: Specifies settings like `BATCH_SIZE`, `NUM_WORKERS`, `PIN_MEMORY`, etc. +- **Train Options**: + - **General**: Specifies settings like `EPOCHS`, `LOSS`, `EARLY_STOPPING`, etc. + - **Optimizer**: Specifies `TYPE` (Optimizer Class), `PARAMS` (Optimizer Parameters), etc. + - **Schduler**: Specifies `TYPE` (Scheduler Class), `PARAMS` (Scheduler Parameters), etc. + - **Curriculum Learning**: Includes settings like `CL_EPOHS`, `WARMUP_EPOCHS`, `STEP_SIZE`, etc. + - **Data**: Specifies settings like `BATCH_SIZE`, `NUM_WORKERS`, `PIN_MEMORY`, etc. +- **Valid Options**: + - **General**: Includes `INTERVAL` for validation frequency. + - **Data**: Specifies settings like `BATCH_SIZE`, `NUM_WORKERS`, `PIN_MEMORY`, etc. +- **Test Options**: + - **General**: Includes `INTERVAL` for testing frequency. + - **Data**: Specifies settings like `BATCH_SIZE`, `NUM_WORKERS`, `PIN_MEMORY`, etc. For a complete guide on all configuration options and examples, refer to [examples/complete_config.py](../examples/complete_config.py). diff --git a/tutorial/dataset_design.md b/tutorial/dataset_design.md index 2743151..1e71a2e 100644 --- a/tutorial/dataset_design.md +++ b/tutorial/dataset_design.md @@ -41,7 +41,7 @@ Each dataset contains at least two essential files: `data.dat` and `desc.json`: ## 🧑‍💻 Dataset Class Design
- +
In time series forecasting, datasets are typically generated from raw time series data using a sliding window approach. As illustrated above, the raw time series is split into training, validation, and test sets along the time dimension, and samples are generated using a sliding window of size `inputs + targets`. Most datasets adhere to this structure.