Update README.md

README.md

@@ -4,140 +4,57 @@ Due to the network conditions, the whole dataset is still uploading.
 license: cc
 ---
 
-# Dataset Card for Dataset Name
+## Data Format and Structure
 
-<!-- Provide a quick summary of the dataset. -->
+The data is organized under `./data/{username}/{action}`, where each action corresponds to a different handwriting task:
 
-This dataset card aims to be a base template for new datasets. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md?plain=1).
+- **Action 0:** Letters, hand raised
+- **Action 1:** Letters, hand not raised
+- **Action 2:** Words (connected), hand raised
+- **Action 3:** Words (connected), hand not raised
+- **Action 4:** Words (disconnected), hand raised
+- **Action 5:** Words (disconnected), hand not raised
 
-## Dataset Details
+Each action contains multiple data sets, consisting of data from a ring and a touchpad. Due to the size of the touchpad data, it's split into multiple parts. For example, for dataset with ID 1:
 
-### Dataset Description
+- Ring 0 data: `1_ring_0.bin`
+- Touchpad data: `1_board_{index}.gz`
+- Ring 1 data: `1_ring_1.bin` (Please ignore this.)
 
-<!-- Provide a longer summary of what this dataset is. -->
+### Ring Data Format
 
+The ring data is stored in numpy format as 64-bit floating point values. After reshaping with `data_ring0 = data_ring0.reshape(-1, 7)`, the columns represent:
 
+1. Acceleration X
+2. Acceleration Y
+3. Acceleration Z
+4. Angular velocity X
+5. Angular velocity Y
+6. Angular velocity Z
+7. Timestamp
 
-- **Curated by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
+The data is sampled at 200Hz.
 
-### Dataset Sources [optional]
+### Touchpad Data Format
 
-<!-- Provide the basic links for the dataset. -->
+The touchpad data is stored in gzipped format (`.gz`).
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+## Data Visualization
 
-## Uses
+### Ring Data Visualization
 
-<!-- Address questions around how the dataset is intended to be used. -->
+The `ring_plot.py` script can be used to visualize the ring data. It contains a function `plot_ring_data()`, which takes two parameters:
 
-### Direct Use
+1. Path to the ring data file
+2. A flag indicating whether to save the output
 
-<!-- This section describes suitable use cases for the dataset. -->
+The output is a plot that visualizes the ring data.
 
-[More Information Needed]
+### Touchpad Data Visualization
 
-### Out-of-Scope Use
+The `board_plot.py` script is used for visualizing touchpad data. It contains a function `plot_board_data()`, which takes two parameters:
 
-<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
+1. Path to the touchpad data file
+2. Username
 
-[More Information Needed]
-
-## Dataset Structure
-
-<!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
-
-[More Information Needed]
-
-## Dataset Creation
-
-### Curation Rationale
-
-<!-- Motivation for the creation of this dataset. -->
-
-[More Information Needed]
-
-### Source Data
-
-<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
-
-#### Data Collection and Processing
-
-<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
-
-[More Information Needed]
-
-#### Who are the source data producers?
-
-<!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
-
-[More Information Needed]
-
-### Annotations [optional]
-
-<!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
-
-#### Annotation process
-
-<!-- This section describes the annotation process such as annotation tools used in the process, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->
-
-[More Information Needed]
-
-#### Who are the annotators?
-
-<!-- This section describes the people or systems who created the annotations. -->
-
-[More Information Needed]
-
-#### Personal and Sensitive Information
-
-<!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
-
-## Dataset Card Authors [optional]
-
-[More Information Needed]
-
-## Dataset Card Contact
-
-[More Information Needed]
+The function randomly samples touchpad data and outputs a visualization showing the user's writing trajectory, with color representing the pressure applied. Additionally, the `visualize_touch_data()` function can be called to visualize touchpad data for a specific time range.