Improve dataset card: Add task categories, root GitHub link, and sample usage

#1
by nielsr HF Staff - opened
Files changed (1) hide show
  1. README.md +35 -2
README.md CHANGED
@@ -1,11 +1,26 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  # WiFall
2
 
 
 
3
  The description is generated by Grok3.
4
 
5
  ## Dataset Description
6
 
7
- - **Repository:** [KNN-MMD/WiFall at main · RS2002/KNN-MMD](https://github.com/RS2002/KNN-MMD/tree/main/WiFall)
8
- - **Paper:** [KNN-MMD: Cross Domain Wireless Sensing via Local Distribution Alignment](https://arxiv.org/abs/2412.04783)
9
  - **Contact:** [zzhaock@connect.ust.hk](mailto:zzhaock@connect.ust.hk)
10
  - **Collectors:** Zijian Zhao, Tingwei Chen
11
  - **Organization:** AI-RAN Lab (hosted by Prof. Guangxu Zhu) in SRIBD, CUHK(SZ)
@@ -13,6 +28,24 @@ The description is generated by Grok3.
13
  The WiFall dataset contains synchronized Channel State Information (CSI), Received Signal Strength Indicator (RSSI), and timestamp data collected using ESP32-S3 devices for WiFi-based fall detection, action recognition, and people identification in a meeting room scenario. The dataset includes actions (fall, jump, sit, stand, walk) performed by ten individuals.
14
  - **Tasks:** Fall Detection, Action Recognition, People Identification, Cross-Domain Tasks.
15
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
16
  ## Dataset Structure
17
 
18
  ### Data Instances
 
1
+ ---
2
+ task_categories:
3
+ - human-activity-recognition
4
+ - person-identification
5
+ - domain-adaptation
6
+ language: en
7
+ tags:
8
+ - wireless-sensing
9
+ - fall-detection
10
+ - action-recognition
11
+ - gesture-recognition
12
+ - esp32
13
+ - csi-data
14
+ ---
15
+
16
  # WiFall
17
 
18
+ [Paper](https://arxiv.org/abs/2412.04783) | [Code](https://github.com/RS2002/KNN-MMD)
19
+
20
  The description is generated by Grok3.
21
 
22
  ## Dataset Description
23
 
 
 
24
  - **Contact:** [zzhaock@connect.ust.hk](mailto:zzhaock@connect.ust.hk)
25
  - **Collectors:** Zijian Zhao, Tingwei Chen
26
  - **Organization:** AI-RAN Lab (hosted by Prof. Guangxu Zhu) in SRIBD, CUHK(SZ)
 
28
  The WiFall dataset contains synchronized Channel State Information (CSI), Received Signal Strength Indicator (RSSI), and timestamp data collected using ESP32-S3 devices for WiFi-based fall detection, action recognition, and people identification in a meeting room scenario. The dataset includes actions (fall, jump, sit, stand, walk) performed by ten individuals.
29
  - **Tasks:** Fall Detection, Action Recognition, People Identification, Cross-Domain Tasks.
30
 
31
+ ## Sample Usage
32
+
33
+ To run the model, follow these instructions based on the dataset you are using. For the WiGesture Dataset, use the `train.py` script, and for the WiFall Dataset, use the `train_fall.py` script. The steps to execute them are the same, and here we provide an example using `train.py`.
34
+
35
+ ```bash
36
+ python train.py --k <shot number> --n <neighbor number for KNN> --p <select the top p samples from testing set for MK-MMD (p<1)> --task <action or people> --lr <learning rate>
37
+ ```
38
+
39
+ Make sure to replace the following placeholders with the appropriate values:
40
+
41
+ - `<shot number>`: Specify the shot number.
42
+ - `<neighbor number for KNN>`: Specify the number of neighbors for KNN.
43
+ - `<select the top p samples from testing set for MK-MMD (p<1)>`: Specify the value for p (selecting the top p samples from the testing set for MK-MMD). Note that p should be less than 1.
44
+ - `<action or people>`: Specify the task name as either "action" or "people".
45
+ - `<learning rate>`: Specify the desired learning rate.
46
+
47
+ Once you have set the appropriate values, run the command in your terminal to start the training process.
48
+
49
  ## Dataset Structure
50
 
51
  ### Data Instances