SIKAI-C commited on
Commit
d496cf8
·
verified ·
1 Parent(s): 0e0f42a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +74 -6
README.md CHANGED
@@ -10,8 +10,8 @@ license: apache-2.0
10
 
11
  # CSI-4CAST Organization
12
 
13
- Welcome to the CSI-4CAST organization on Hugging Face! This organization hosts datasets for CSI prediction research.
14
- This dataset is originally created for our research paper: [CSI-4CAST: A Hybrid Deep Learning Model for CSI Prediction with Comprehensive Robustness and Generalization Testing](https://arxiv.org/abs/2510.12996). The corresponding code and implementation are available in our [GitHub repo](https://github.com/AI4OPT/CSI-4CAST).
15
 
16
  ## TL;DR
17
 
@@ -19,6 +19,7 @@ This dataset is originally created for our research paper: [CSI-4CAST: A Hybrid
19
 
20
  - **For specific datasets**: Use the `snapshot_download` command to download individual datasets you need
21
  - **For all datasets with original structure**: Run [`download.py`](https://huggingface.co/spaces/CSI-4CAST/README/blob/main/download.py) followed by [`reconstruction.py`](https://huggingface.co/spaces/CSI-4CAST/README/blob/main/reconstruction.py) to get the complete, well-structured dataset
 
22
 
23
  See the **Usage** section below for detailed instructions.
24
 
@@ -113,6 +114,69 @@ snapshot_download(repo_id="CSI-4CAST/stats", repo_type="dataset")
113
  snapshot_download(repo_id="CSI-4CAST/test_regular_cm_A_ds_030_ms_001", repo_type="dataset")
114
  ```
115
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
116
  ### Downloading All Datasets
117
 
118
  To download all available datasets at once, use the provided [`download.py`](https://huggingface.co/spaces/CSI-4CAST/README/blob/main/download.py) script:
@@ -160,6 +224,10 @@ Each dataset folder contains:
160
  - `H_U_hist.pt`: Historical H_U values (PyTorch tensor)
161
  - `H_U_pred.pt`: Predicted H_U values (PyTorch tensor)
162
 
 
 
 
 
163
  ## Questions & Contributions
164
 
165
  For further questions or any contribution suggestions, you can create pull requests here or to the [GitHub homepage](https://github.com/AI4OPT/CSI-4CAST) of this organization.
@@ -167,13 +235,13 @@ For further questions or any contribution suggestions, you can create pull reque
167
  ## Citation
168
 
169
  ```bibtex
170
- @misc{cheng2025csi4casthybriddeeplearning,
171
  title={CSI-4CAST: A Hybrid Deep Learning Model for CSI Prediction with Comprehensive Robustness and Generalization Testing},
172
  author={Sikai Cheng and Reza Zandehshahvar and Haoruo Zhao and Daniel A. Garcia-Ulloa and Alejandro Villena-Rodriguez and Carles Navarro Manchón and Pascal Van Hentenryck},
173
- year={2025},
174
  eprint={2510.12996},
175
  archivePrefix={arXiv},
176
  primaryClass={cs.LG},
177
- url={https://arxiv.org/abs/2510.12996},
178
  }
179
- ```
 
10
 
11
  # CSI-4CAST Organization
12
 
13
+ Welcome to the CSI-4CAST organization on Hugging Face. This organization hosts both **datasets** and **model weights** for CSI prediction research.
14
+ These resources are released as part of our paper [CSI-4CAST: A Hybrid Deep Learning Model for CSI Prediction with Comprehensive Robustness and Generalization Testing](https://arxiv.org/abs/2510.12996v2). The corresponding code and implementation are available in our [GitHub repo](https://github.com/AI4OPT/CSI-4CAST).
15
 
16
  ## TL;DR
17
 
 
19
 
20
  - **For specific datasets**: Use the `snapshot_download` command to download individual datasets you need
21
  - **For all datasets with original structure**: Run [`download.py`](https://huggingface.co/spaces/CSI-4CAST/README/blob/main/download.py) followed by [`reconstruction.py`](https://huggingface.co/spaces/CSI-4CAST/README/blob/main/reconstruction.py) to get the complete, well-structured dataset
22
+ - **For trained checkpoints**: Download model weights from [`CSI-4CAST/weights`](https://huggingface.co/CSI-4CAST/weights)
23
 
24
  See the **Usage** section below for detailed instructions.
25
 
 
114
  snapshot_download(repo_id="CSI-4CAST/test_regular_cm_A_ds_030_ms_001", repo_type="dataset")
115
  ```
116
 
117
+ ### Downloading Model Weights
118
+
119
+ All trained checkpoints are available in the model repository [`CSI-4CAST/weights`](https://huggingface.co/CSI-4CAST/weights).
120
+
121
+ Download the full weights repository:
122
+
123
+ ```python
124
+ from huggingface_hub import snapshot_download
125
+
126
+ snapshot_download(repo_id="CSI-4CAST/weights")
127
+ ```
128
+
129
+ Download only one scenario or model:
130
+
131
+ ```python
132
+ from huggingface_hub import snapshot_download
133
+
134
+ # Download one scenario (e.g. FDD)
135
+ snapshot_download(
136
+ repo_id="CSI-4CAST/weights",
137
+ allow_patterns=["fdd/*"],
138
+ )
139
+
140
+ # Download one checkpoint directory
141
+ snapshot_download(
142
+ repo_id="CSI-4CAST/weights",
143
+ allow_patterns=["tdd/llm4cp/*"],
144
+ )
145
+ ```
146
+
147
+ The weights repository is organized as:
148
+
149
+ ```text
150
+ fdd/
151
+ abl_no_arl/
152
+ abl_no_subcarrier_arl/
153
+ cnn/
154
+ llm4cp/
155
+ model/
156
+ rnn/
157
+ stemgnn/
158
+ wiener/
159
+ tdd/
160
+ abl_add_subcarrier_arl/
161
+ abl_lstm_replace_pred/
162
+ abl_mlp_replace_embed/
163
+ abl_mlp_replace_pred/
164
+ abl_mobilenet_replace_embed/
165
+ abl_no_arl/
166
+ abl_no_denoiser/
167
+ abl_no_idft/
168
+ abl_norm_replace_arl/
169
+ ar/
170
+ cnn/
171
+ llm4cp/
172
+ model/
173
+ rnn/
174
+ stemgnn/
175
+ wiener/
176
+ ```
177
+
178
+ Neural models store checkpoints as `model.ckpt`. Statistical baselines store parameters as `params.npz`.
179
+
180
  ### Downloading All Datasets
181
 
182
  To download all available datasets at once, use the provided [`download.py`](https://huggingface.co/spaces/CSI-4CAST/README/blob/main/download.py) script:
 
224
  - `H_U_hist.pt`: Historical H_U values (PyTorch tensor)
225
  - `H_U_pred.pt`: Predicted H_U values (PyTorch tensor)
226
 
227
+ The weights repository contains:
228
+ - `model.ckpt`: PyTorch Lightning checkpoint for trained neural models
229
+ - `params.npz`: Saved parameter arrays for statistical baselines such as AR and Wiener filters
230
+
231
  ## Questions & Contributions
232
 
233
  For further questions or any contribution suggestions, you can create pull requests here or to the [GitHub homepage](https://github.com/AI4OPT/CSI-4CAST) of this organization.
 
235
  ## Citation
236
 
237
  ```bibtex
238
+ @misc{cheng2026csi4casthybriddeeplearning,
239
  title={CSI-4CAST: A Hybrid Deep Learning Model for CSI Prediction with Comprehensive Robustness and Generalization Testing},
240
  author={Sikai Cheng and Reza Zandehshahvar and Haoruo Zhao and Daniel A. Garcia-Ulloa and Alejandro Villena-Rodriguez and Carles Navarro Manchón and Pascal Van Hentenryck},
241
+ year={2026},
242
  eprint={2510.12996},
243
  archivePrefix={arXiv},
244
  primaryClass={cs.LG},
245
+ url={https://arxiv.org/abs/2510.12996v2},
246
  }
247
+ ```