aaroneasy commited on
Commit
8b7a5c4
·
verified ·
1 Parent(s): 3129c09

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +38 -66
README.md CHANGED
@@ -1,83 +1,63 @@
1
  ---
2
  license: cc-by-4.0
3
  ---
 
4
  # OctoNet Multi-Modal Dataset
 
 
 
 
 
 
 
 
5
 
6
  Welcome to the **OctoNet** multi-modal dataset! This dataset provides a variety of human activity recordings from multiple sensor modalities, enabling advanced research in activity recognition, pose estimation, multi-modal data fusion, and more.
7
 
8
- ---
9
-
10
  ## 1. Overview
11
-
12
- - **Name**: OctoNet
13
  - **Data**: Multi-modal sensor data, including:
14
- - Inertial measurement unit (IMU) data
15
- - Motion capture data in CSV and `.npy` formats
16
- - mmWave / Radar data (vayyar_pickle)
17
- - Multiple sensor nodes (`node_1`, `node_2`, etc.) capturing different data streams
18
  - **Use Cases**:
19
- - Human activity recognition
20
- - Human pose estimation
21
- - Multi-modal signal processing
22
- - Machine learning/deep learning model training
23
-
24
- ---
25
 
26
  ## 2. File Chunks
27
-
28
- Because of the large dataset size, it has been split into multiple chunks:
29
- ''
30
  Octonet_chunk_aa
31
  Octonet_chunk_ab
32
  ...
33
  Octonet_chunk_ap
34
- ''
35
-
36
  All chunks are required to reconstruct the full dataset.
37
 
38
- ---
39
-
40
 
41
- ## 3. Download & Merge Instructions
 
42
 
43
- ### 3.1 Download All Chunks at Once
44
 
45
- Below is an example **bash** snippet that downloads all chunks in sequence. Make sure you have `wget` installed:
46
 
47
  ```bash
48
- # Download all Octonet dataset chunks:
49
- for chunk in aa ab ac ad ae af ag ah ai aj ak al am an ao ap; do
50
- wget https://huggingface.co/datasets/hku-aiot/OctoNet/resolve/main/Octonet_chunk_${chunk}
51
- done
52
  ```
53
 
54
- ### 3.2 Merge Chunks into a Single Tar (Bash)
55
- ```bash
56
- cat Octonet_chunk_aa \
57
- Octonet_chunk_ab \
58
- Octonet_chunk_ac \
59
- Octonet_chunk_ad \
60
- Octonet_chunk_ae \
61
- Octonet_chunk_af \
62
- Octonet_chunk_ag \
63
- Octonet_chunk_ah \
64
- Octonet_chunk_ai \
65
- Octonet_chunk_aj \
66
- Octonet_chunk_ak \
67
- Octonet_chunk_al \
68
- Octonet_chunk_am \
69
- Octonet_chunk_an \
70
- Octonet_chunk_ao \
71
- Octonet_chunk_ap \
72
- > octonet.tar
73
- ```
74
- ### 3.3 Extract
75
- ```bash
76
- tar -xvf octonet.tar
77
- ```
78
 
79
  ## 4. Directory Structure
80
- After extracting octonet.tar, you should have a structure similar to:
81
  ```bash
82
  .
83
  └── octonet
@@ -92,21 +72,13 @@ After extracting octonet.tar, you should have a structure similar to:
92
  ├── vayyar_pickle # Vayyar mmWave radar data (.pickle)
93
  ├── cut_manual.csv # Manually curated data segments
94
  ```
95
- ## 5. Quick Start with Octonet Code
96
-
97
- For more details, refer to the original README in code repository in githublink.
98
-
99
- ## 6. License
100
- License: CC BY 4.0
101
 
102
- ## 7. Contact & Disclaimer
103
- Contact:
104
-
105
- Email: 1155177815@link.cuhk.edu.hk
106
 
107
- GitHub:
108
 
109
- Project page: https://aiot-lab.github.io/OctoNet/
 
110
 
111
  Disclaimer:
112
- This dataset is provided as is without warranties of any kind and is intended for research/educational purposes only. The creators assume no responsibility for any misuse or damages.
 
1
  ---
2
  license: cc-by-4.0
3
  ---
4
+
5
  # OctoNet Multi-Modal Dataset
6
+ <div style="text-align:center;">
7
+ <a href="https://aiot-lab.github.io/OctoNet/" target="_blank">
8
+ <img src="https://img.shields.io/badge/Project%20Page-Visit-blue" alt="Project Page" style="margin-right:10px;">
9
+ </a>
10
+ <a href="https://github.com/hku-aiot/OctoNet" target="_blank">
11
+ <img src="https://img.shields.io/badge/GitHub-Visit-lightgrey" alt="GitHub" style="margin-right:10px;">
12
+ </a>
13
+ </div>
14
 
15
  Welcome to the **OctoNet** multi-modal dataset! This dataset provides a variety of human activity recordings from multiple sensor modalities, enabling advanced research in activity recognition, pose estimation, multi-modal data fusion, and more.
16
 
 
 
17
  ## 1. Overview
18
+ - **Name**: OctoNet
 
19
  - **Data**: Multi-modal sensor data, including:
20
+ - Inertial measurement unit (IMU) data
21
+ - Motion capture data in CSV and `.npy` formats
22
+ - mmWave / Radar data (vayyar_pickle)
23
+ - Multiple sensor nodes (`node_1`, `node_2`, etc.) capturing different data streams
24
  - **Use Cases**:
25
+ - Human activity recognition
26
+ - Human pose estimation
27
+ - Multi-modal signal processing
28
+ - Machine learning/deep learning model training
 
 
29
 
30
  ## 2. File Chunks
31
+ Because of the large dataset size (~768GB), it has been split into 16 chunks of approximately 48GB each:
32
+ ```
 
33
  Octonet_chunk_aa
34
  Octonet_chunk_ab
35
  ...
36
  Octonet_chunk_ap
37
+ ```
 
38
  All chunks are required to reconstruct the full dataset.
39
 
 
 
40
 
41
+ ## 3. Automated Download, Merge & Extract Script
42
+ Due to the large size and multiple steps involved, we provide a convenience script that handles downloading, merging, and extracting the dataset automatically.
43
 
44
+ **Important:** This process will download approximately **768GB** of data and at peak might require up to **~1.5TB+** of free disk space in the current directory during the merge and extraction phases. Please ensure you have enough space!
45
 
46
+ To download and process the data using the latest version of the script directly from Hugging Face, execute one of the following commands in your terminal. This will download the script and pipe it directly to `bash` for execution.
47
 
48
  ```bash
49
+ bash -c "$(wget -qO- https://huggingface.co/datasets/hku-aiot/OctoNet/resolve/main/download_octonet.sh)"
 
 
 
50
  ```
51
 
52
+ The script will:
53
+ 1. Download each chunk using `wget -c` (supports resuming).
54
+ 2. Merge all downloaded chunks into `octonet.tar`.
55
+ 3. **Remove** the individual chunk files (`Octonet_chunk_a*`) to save space.
56
+ 4. Extract the contents of `octonet.tar`.
57
+
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
58
 
59
  ## 4. Directory Structure
60
+ After extracting `octonet.tar`, you should have a directory named `octonet` with a structure similar to:
61
  ```bash
62
  .
63
  └── octonet
 
72
  ├── vayyar_pickle # Vayyar mmWave radar data (.pickle)
73
  ├── cut_manual.csv # Manually curated data segments
74
  ```
 
 
 
 
 
 
75
 
76
+ ## 5. Quick Start with Octonet Code
77
+ For more details on working with the dataset programmatically, refer to the original README in the OctoNet code repository on GitHub: [https://github.com/hku-aiot/OctoNet](https://github.com/hku-aiot/OctoNet).
 
 
78
 
 
79
 
80
+ ## 6. Contact & Disclaimer
81
+ Contact: [Dongsheng Yuan](mailto:1155177815@link.cuhk.edu.hk)
82
 
83
  Disclaimer:
84
+ This dataset is provided as is without warranties of any kind and is intended for research/educational purposes only. The creators assume no responsibility for any misuse or damages.