Skip to content

Commit

Permalink
docs: ✏️ update README
Browse files Browse the repository at this point in the history
  • Loading branch information
zezhishao committed Nov 13, 2023
1 parent 69eddb2 commit b13179b
Showing 1 changed file with 11 additions and 21 deletions.
32 changes: 11 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,34 +155,24 @@ BasicTS is built on PyTorch 1.9.1 or 1.10.0, while other versions have not been

### Run It!

An example of a start script can be found in [experiments/train.py](experiments/train.py).
You can run your model by the following command:

```bash
python experiments/train.py -c /path/to/your/config/file.py --gpus '0'
```
- **Reproducing Built-in Models**

BasicTS provides a wealth of built-in models. You can reproduce these models by running the following command:

## 📌 Examples
```bash
python experiments/train.py -c baselines/${MODEL_NAME}/${DATASET_NAME}.py --gpus '0'
```

### Reproducing Built-in Models
Replace `${DATASET_NAME}` and `${MODEL_NAME}` with any supported models and datasets. For example, you can run Graph WaveNet on METR-LA dataset by:

BasicTS provides a wealth of built-in models. You can find all the built-in models and their corresponding runners in [`basicts/archs/arch_zoo`](basicts/archs/arch_zoo/) and [`basicts/runners/runner_zoo`](basicts/runners/runner_zoo/), respectively. You can reproduce these models by running the following command:
```bash
python experiments/train.py -c baselines/GWNet/METR-LA.py --gpus '0'
```

```bash
python experiments/train.py -c baselines/${MODEL_NAME}/${DATASET_NAME}.py --gpus '0'
```

Replace `${DATASET_NAME}` and `${MODEL_NAME}` with any supported models and datasets. For example, you can run Graph WaveNet on METR-LA dataset by:

```bash
python experiments/train.py -c baselines/GWNet/METR-LA.py --gpus '0'
```
- **Customized Your Own Model**

### Customized Your Own Model
[Example: Multi-Layer Perceptron (MLP)](baselines/MLP)

- [Multi-Layer Perceptron (MLP)](baselines/MLP)
- More...

## ❤️ Contributors

Expand Down

0 comments on commit b13179b

Please sign in to comment.