Improve model card metadata and content

#1
by nielsr HF Staff - opened
Files changed (1) hide show
  1. README.md +29 -16
README.md CHANGED
@@ -1,7 +1,8 @@
1
  ---
2
- license: apache-2.0
3
  language:
4
  - en
 
 
5
  tags:
6
  - physics
7
  - PDEs
@@ -9,10 +10,10 @@ tags:
9
  - FoundationModels
10
  - AI4Sci
11
  ---
 
12
  <p align="center">
13
  <a href="https://github.com/tum-pbs/Tadpole">
14
- <img src="assets/images/tadpole_colorful.png" width="100"/>
15
- </a>
16
  </a>
17
  </p>
18
  <h4 align="center">Autoencoders as Foundation Models for 3D PDEs with Online Learning</h4>
@@ -20,7 +21,6 @@ tags:
20
  <a href="https://arxiv.org/abs/2605.15284">
21
  <img src="https://img.shields.io/badge/arXiv-2605.15284-b31b1b?logo=arxiv" alt="Read on arXiv"/>
22
  </a>
23
- </a>
24
  <a href="https://github.com/tum-pbs/Tadpole">
25
  <img src="https://img.shields.io/badge/Github-Tadpole-181717?logo=github" alt="Github project"/>
26
  </a>
@@ -28,17 +28,15 @@ tags:
28
 
29
  ## About
30
 
31
- This repository contains pre-trained weights of **Tadpole**, a foundation model for three-dimensional partial differential equations (PDEs).
32
 
33
  Tadpole distinguishes itself from existing PDE foundation models in three key aspects:
34
 
35
- (1) Tadpole is pre-trained as an autoencoder to learn the inherent representation of PDE solutions, which is more generalizable than the traditional paradigm of training PDE foundation models directly on the dynamics evolution of PDE solutions.
36
 
37
- (2) Tadpole is pretrained with online learning. which utilize a GPU-based solver to generate diverse data distribution without IO or storage bottlenecks induced by 3D PDE data.
38
 
39
- (3) Tadpole is able to process multiple downstream tasks, including autoencoding, dynamics prediction, and generative modeling.
40
-
41
- For more details, please refer to our [research paper](https://arxiv.org/abs/2605.15284):
42
 
43
  ## Installation and Loading Pre-trained Weights
44
 
@@ -48,18 +46,33 @@ Tadpole can be installed via pip:
48
  pip install git+https://github.com/tum-pbs/Tadpole
49
  ```
50
 
51
- The pre-trained weights are named as `tadpole_{SIZE}_{TYPE}.safetensors`, where `{SIZE}` can be `S`, `B`, or `L` indicating the model size, and `{TYPE}` can be `encoder` or `decoder` indicating the model type. Weights can be loaded through `weight_{TYPE}` arguments in Tadpole model classes:
52
 
53
  ```python
54
  from huggingface_hub import hf_hub_download
55
- ae=TadpoleAutoencoder(
 
 
56
  size="B",
57
- weight_encoder=hf_hub_download(repo_id="thuerey-group/Tadpole",filename="tadpole_b_encoder.safetensors"),
58
  # or you can also download the weights from Hugging Face and load it locally
59
- weight_decoder=hf_hub_download(repo_id="thuerey-group/Tadpole",filename="tadpole_b_decoder.safetensors"),
60
  )
61
  ```
62
 
63
- Please refer to our [github repository](https://github.com/tum-pbs/Tadpole) for more details and tutorials.
 
 
 
 
64
 
65
- Note: Currently, we only provide pre-trained weights for the B-size model; S- and L-size models will be released in the near future. Please stay tuned😊!
 
 
 
 
 
 
 
 
 
 
1
  ---
 
2
  language:
3
  - en
4
+ license: apache-2.0
5
+ pipeline_tag: other
6
  tags:
7
  - physics
8
  - PDEs
 
10
  - FoundationModels
11
  - AI4Sci
12
  ---
13
+
14
  <p align="center">
15
  <a href="https://github.com/tum-pbs/Tadpole">
16
+ <img src="https://huggingface.co/thuerey-group/Tadpole/resolve/main/assets/images/tadpole_colorful.png" width="100"/>
 
17
  </a>
18
  </p>
19
  <h4 align="center">Autoencoders as Foundation Models for 3D PDEs with Online Learning</h4>
 
21
  <a href="https://arxiv.org/abs/2605.15284">
22
  <img src="https://img.shields.io/badge/arXiv-2605.15284-b31b1b?logo=arxiv" alt="Read on arXiv"/>
23
  </a>
 
24
  <a href="https://github.com/tum-pbs/Tadpole">
25
  <img src="https://img.shields.io/badge/Github-Tadpole-181717?logo=github" alt="Github project"/>
26
  </a>
 
28
 
29
  ## About
30
 
31
+ This repository contains pre-trained weights of **Tadpole**, a foundation model for three-dimensional partial differential equations (PDEs) introduced in the paper [Tadpole: Autoencoders as Foundation Models for 3D PDEs with Online Learning](https://huggingface.co/papers/2605.15284).
32
 
33
  Tadpole distinguishes itself from existing PDE foundation models in three key aspects:
34
 
35
+ (1) **Autoencoder Pre-training**: Tadpole is pre-trained to learn the inherent representation of PDE solutions, which is more generalizable than the traditional paradigm of training models directly on temporal dynamics.
36
 
37
+ (2) **Online Learning**: It utilizes a GPU-based solver to generate diverse data on-the-fly, avoiding storage and I/O bottlenecks associated with massive 3D PDE datasets.
38
 
39
+ (3) **Multi-functionality**: Tadpole can be applied to multiple downstream tasks, including autoencoding, dynamics prediction, and generative modeling.
 
 
40
 
41
  ## Installation and Loading Pre-trained Weights
42
 
 
46
  pip install git+https://github.com/tum-pbs/Tadpole
47
  ```
48
 
49
+ The pre-trained weights are named as `tadpole_{SIZE}_{TYPE}.safetensors`, where `{SIZE}` can be `S`, `B`, or `L` indicating the model size, and `{TYPE}` can be `encoder` or `decoder`. Weights can be loaded through `weight_{TYPE}` arguments in Tadpole model classes:
50
 
51
  ```python
52
  from huggingface_hub import hf_hub_download
53
+
54
+ # Example: loading the B-size model
55
+ ae = TadpoleAutoencoder(
56
  size="B",
57
+ weight_encoder=hf_hub_download(repo_id="thuerey-group/Tadpole", filename="tadpole_b_encoder.safetensors"),
58
  # or you can also download the weights from Hugging Face and load it locally
59
+ weight_decoder=hf_hub_download(repo_id="thuerey-group/Tadpole", filename="tadpole_b_decoder.safetensors"),
60
  )
61
  ```
62
 
63
+ Please refer to the [GitHub repository](https://github.com/tum-pbs/Tadpole) for more details and tutorials.
64
+
65
+ Note: Currently, pre-trained weights for the B-size model are provided; S- and L-size models will be released in the future.
66
+
67
+ ## Citation
68
 
69
+ ```latex
70
+ @article{Liu2026Tadpole,
71
+ author = {Qiang Liu, Felix Koehler, Benjamin Holzschuh, and Nils Thuerey},
72
+ title = {Tadpole: Autoencoders as Foundation Models for 3D PDEs with Online Learning},
73
+ eprint={2605.15284},
74
+ archivePrefix={arXiv},
75
+ primaryClass={cs.LG},
76
+ url={https://arxiv.org/abs/2605.15284}
77
+ }
78
+ ```