Keymotek commited on
Commit
9e0b122
Β·
verified Β·
1 Parent(s): 69c5e14

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +52 -0
README.md ADDED
@@ -0,0 +1,52 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: apache-2.0
3
+ task_categories:
4
+ - autonomous-driving
5
+ language:
6
+ - en
7
+ tags:
8
+ - simulation
9
+ - ad
10
+ - mini-dataset
11
+ ---
12
+
13
+ # πŸš— simData-Mini (Preview Version)
14
+
15
+ <div align="center">
16
+
17
+ | **Current Version** | **Full Dataset** |
18
+ |:-------------------:|:----------------:|
19
+ | 🟒 **Mini / Preview** | [πŸ”— Click Here for Full Version](https://huggingface.co/datasets/Keymotek/simData-Dataset) |
20
+
21
+ </div>
22
+
23
+ ---
24
+
25
+ ## πŸ‡¬πŸ‡§ English Description
26
+
27
+ ### πŸ“’ Important Notice
28
+ This dataset (`simData_mini`) is a **lightweight subset** of the complete `simData` dataset.
29
+ **Please Note:**
30
+ 1. **Purpose:** This mini version is intended **strictly for small-scale testing, pipeline debugging, and quick verification**.
31
+ 2. **Performance:** Results obtained from this mini dataset **cannot** represent the performance of the model on the full dataset.
32
+ 3. **Link:** To access the complete training and validation data, please visit the [Full Dataset Page]([[PUT_YOUR_LINK_HERE](https://huggingface.co/datasets/Keymotek/simData-Dataset)]).
33
+
34
+ ### πŸ“ Dataset Summary
35
+ `simData` is a dataset designed for [Insert brief description, e.g., Autonomous Driving Simulation ].
36
+ This mini version contains approximately `[Insert Number, e.g., 10%]` of the original data samples, allowing developers to:
37
+ * Quickly download and inspect the data structure.
38
+ * Debug code without downloading terabytes of data.
39
+ * Run CI/CD tests.
40
+
41
+ ### πŸš€ Quick Start
42
+ You can download this dataset using the Hugging Face CLI or Python.
43
+
44
+ **Using Python:**
45
+ ```python
46
+ from huggingface_hub import snapshot_download
47
+
48
+ snapshot_download(
49
+ repo_id="Keymotek/simData_mini-Dataset",
50
+ repo_type="dataset",
51
+ local_dir="./data/simData_mini"
52
+ )