Skip to content

Commit f9fd131

Browse files
committed
minor revamp of readme
1 parent b76c9f1 commit f9fd131

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# PDEBench
22

33
The code repository for the NeurIPS 2022 paper
4-
[PDEBench: An Extensive Benchmark for Scientific Machine Learning](https://arxiv.org/abs/2210.07182) :tada: **SimTech Best Paper Award 2023** :confetti_ball:
4+
[PDEBench: An Extensive Benchmark for Scientific Machine Learning](https://arxiv.org/abs/2210.07182)
5+
6+
:tada: [**SimTech Best Paper Award 2023**](https://www.simtech.uni-stuttgart.de/press/SimTech-Best-Paper-Award-2023-Benchmark-for-ML-for-scientific-simulations) :confetti_ball:
57

68
PDEBench provides a diverse and comprehensive set of benchmarks for scientific machine learning, including challenging and realistic physical problems. This repository consists of the code used to generate the datasets, to upload and download the datasets from the data repository, as well as to train and evaluate different machine learning models as baselines. PDEBench features a much wider range of PDEs than existing benchmarks and includes realistic and difficult problems (both forward and inverse), larger ready-to-use datasets comprising various initial and boundary conditions, and PDE parameters. Moreover, PDEBench was created to make the source code extensible and we invite active participation from the SciML community to improve and extend the benchmark.
79

@@ -57,14 +59,14 @@ pip install ".[datagen39]" # locally
5759

5860
For GPU support there are additional platform-specific instructions:
5961

60-
For PyTorch, [see here](https://pytorch.org/get-started/locally/).
62+
For PyTorch, the latest version we support is v1.13.1 [see previous-versions/#linux - CUDA 11.7](https://pytorch.org/get-started/previous-versions/#linux-and-windows-2).
6163

62-
For JAX, which is approximately 6 times faster for simulations than PyTorch in our tests, [see here](https://github.com/google/jax#installation)
64+
For JAX, which is approximately 6 times faster for simulations than PyTorch in our tests, [see jax#pip-installation-gpu-cuda-installed-via-pip](https://github.com/google/jax#pip-installation-gpu-cuda-installed-via-pip-easier)
6365

6466

6567
## Installation using conda:
6668

67-
If you like you can also install dependencies using anaconda. We suggest using [miniforge](https://github.com/conda-forge/miniforge) (and possibly mamba) as distribution. Otherwise you may have to __enable the conda-forge__ channel for the following commands.
69+
If you like you can also install dependencies using anaconda, we suggest to use [mambaforge](https://github.com/conda-forge/miniforge#mambaforge) as a distribution. Otherwise you may have to __enable the conda-forge__ channel for the following commands.
6870

6971
Starting from a fresh environment:
7072

@@ -75,16 +77,24 @@ conda activate myenv
7577

7678
Install dependencies for model training:
7779
```
78-
conda install deepxde hydra-core h5py
80+
conda install deepxde hydra-core h5py -c conda-forge
7981
```
8082

81-
[Install PyTorch](https://pytorch.org/get-started/locally/) according to your hardware requirements:
83+
According to your hardware availability, either install PyTorch with CUDA support:
84+
85+
- [see previous-versions/#linux - CUDA 11.7](https://pytorch.org/get-started/previous-versions/#linux-and-windows-2).
8286

83-
E.g.
8487
```
85-
conda install pytorch torchvision torchaudio cudatoolkit=11.3 -c pytorch
88+
conda install pytorch==1.13.1 torchvision==0.14.1 torchaudio==0.13.1 pytorch-cuda=11.7 -c pytorch -c nvidia
8689
```
8790

91+
- [or CPU only binaries](https://pytorch.org/get-started/previous-versions/#linux-and-windows-2).
92+
93+
```
94+
conda install pytorch==1.13.1 torchvision==0.14.1 torchaudio==0.13.1 cpuonly -c pytorch
95+
```
96+
97+
8898
Optional dependencies for data generation:
8999
```
90100
conda install clawpack jax jaxlib python-dotenv

0 commit comments

Comments
 (0)