Skip to content

Commit

Permalink
temp cmt
Browse files Browse the repository at this point in the history
  • Loading branch information
zezhishao committed Sep 3, 2024
1 parent e842788 commit 56d8243
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
24 changes: 12 additions & 12 deletions tutorial/config_design.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion tutorial/dataset_design.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Each dataset contains at least two essential files: `data.dat` and `desc.json`:
## 🧑‍💻 Dataset Class Design

<div align="center">
<img src="figures/DatasetDesign.jpeg" height=250>
<img src="figures/DatasetDesign.jpeg" height=350>
</div>

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.
Expand Down

0 comments on commit 56d8243

Please sign in to comment.