eishatirraazia19 commited on
Commit
76b0bec
·
verified ·
1 Parent(s): 838c32c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +137 -212
README.md CHANGED
@@ -1,142 +1,141 @@
1
  ---
2
  license: cc-by-4.0
3
  configs:
4
- - config_name: lauzhack-2023
5
- data_files:
6
- - split: train
7
- path: lauzhack-2023/train-*
8
- - config_name: lauzhack-2024
9
- data_files:
10
- - split: train
11
- path: lauzhack-2024/train-*
12
- - config_name: lauzhack-2025
13
- data_files:
14
- - split: train
15
- path: lauzhack-2025/train-*
16
- - config_name: lauzhack-2025_lauzhack_projects
17
- data_files:
18
- - split: train
19
- path: lauzhack-2025_lauzhack_projects/train-*
20
  dataset_info:
21
- - config_name: lauzhack-2023
22
- features:
23
- - name: id
24
- dtype: int64
25
- - name: title
26
- dtype: large_string
27
- - name: description
28
- dtype: large_string
29
- - name: url
30
- dtype: large_string
31
- - name: team
32
- list: string
33
- - name: awards
34
- list: string
35
- - name: categories
36
- list: string
37
- - name: hackathon_name
38
- dtype: large_string
39
- - name: hackathon_year
40
- dtype: int64
41
- - name: hackathon_location
42
- dtype: large_string
43
- splits:
44
- - name: train
45
- num_bytes: 22974
46
- num_examples: 67
47
- download_size: 18646
48
- dataset_size: 22974
49
- - config_name: lauzhack-2024
50
- features:
51
- - name: id
52
- dtype: int64
53
- - name: title
54
- dtype: large_string
55
- - name: description
56
- dtype: large_string
57
- - name: url
58
- dtype: large_string
59
- - name: team
60
- list: string
61
- - name: awards
62
- list: string
63
- - name: categories
64
- list: string
65
- - name: hackathon_name
66
- dtype: large_string
67
- - name: hackathon_year
68
- dtype: int64
69
- - name: hackathon_location
70
- dtype: large_string
71
- splits:
72
- - name: train
73
- num_bytes: 28812
74
- num_examples: 79
75
- download_size: 21747
76
- dataset_size: 28812
77
- - config_name: lauzhack-2025
78
- features:
79
- - name: id
80
- dtype: int64
81
- - name: title
82
- dtype: large_string
83
- - name: description
84
- dtype: large_string
85
- - name: url
86
- dtype: large_string
87
- - name: team
88
- list: string
89
- - name: awards
90
- list: string
91
- - name: categories
92
- list: string
93
- - name: hackathon_name
94
- dtype: large_string
95
- - name: hackathon_year
96
- dtype: int64
97
- - name: hackathon_location
98
- dtype: large_string
99
- splits:
100
- - name: train
101
- num_bytes: 39525
102
- num_examples: 67
103
- download_size: 28942
104
- dataset_size: 39525
105
- - config_name: lauzhack-2025_lauzhack_projects
106
- features:
107
- - name: id
108
- dtype: int64
109
- - name: title
110
- dtype: large_string
111
- - name: description
112
- dtype: large_string
113
- - name: url
114
- dtype: large_string
115
- - name: team
116
- list: string
117
- - name: awards
118
- list: string
119
- - name: categories
120
- list: string
121
- - name: hackathon_name
122
- dtype: large_string
123
- - name: hackathon_year
124
- dtype: int64
125
- - name: hackathon_location
126
- dtype: large_string
127
- splits:
128
- - name: train
129
- num_bytes: 39525
130
- num_examples: 67
131
- download_size: 28942
132
- dataset_size: 39525
133
  language:
134
- - en
135
  tags:
136
- - hackathon
137
- - projects
138
- - lauzhack
139
- - switzerland
140
  ---
141
 
142
  # LauzHack Projects Dataset
@@ -217,7 +216,7 @@ print(projects[0])
217
  "url": "https://devpost.com/software/...",
218
  "team": ["Alice Dupont", "Bob Mueller"],
219
  "awards": ["Best Use of AI"],
220
- "categories": ["Machine Learning", "Education Tech"],
221
  "hackathon_name": "LauzHack 2025",
222
  "hackathon_year": 2025,
223
  "hackathon_location": "EPFL, Lausanne, Switzerland"
@@ -270,7 +269,7 @@ If you use this dataset, please cite:
270
  ```bibtex
271
  @dataset{lauzhack_projects_2026,
272
  author = {Tir Raazia, Eisha},
273
- title = {LauzHack Projects Dataset 2023-2025},
274
  year = {2026},
275
  license = {CC-BY-4.0},
276
  url = {https://huggingface.co/datasets/username/lauzhack-projects}
@@ -283,84 +282,10 @@ If you use this dataset, please cite:
283
 
284
  - [LauzHack Official Website](https://lauzhack.com/)
285
  - [EPFL Innovation Park](https://www.epfl.ch/)
286
- - [hackathon-analysis GitHub Repository](https://github.com/sdsc-ordes/open-pulse-hackathon-analysis)
287
 
288
  ### Dataset Maintenance
289
 
290
- This dataset is maintained by the open-pulse-hackathon-analysis project and
291
- updated annually after each LauzHack event.
292
 
293
- ---
294
-
295
- ## YAML Template Explanation (For Manual Implementation)
296
-
297
- If you were creating this from scratch, here's what each YAML section does:
298
-
299
- ### 1. **License**
300
-
301
- ```yaml
302
- license: cc-by-4.0
303
- ```
304
-
305
- - Specifies the legal license for your dataset
306
- - Users must attribute you when using the data
307
- - Other options: `mit`, `apache-2.0`, `openrail`, etc.
308
-
309
- ### 2. **Configs** (Most Important)
310
-
311
- ```yaml
312
- configs:
313
- - config_name: lauzhack-2023
314
- data_files:
315
- - split: train
316
- path: lauzhack-2023/train-*
317
- ```
318
-
319
- - Defines different dataset variations (different years here)
320
- - `config_name`: Users select this when loading
321
- (`load_dataset(..., "lauzhack-2023")`)
322
- - `split`: Data partition (train/test/validation)
323
- - `path`: Where files are stored (supports glob patterns with `*`)
324
-
325
- ### 3. **Dataset Info** (Describes the structure)
326
-
327
- ```yaml
328
- dataset_info:
329
- - config_name: lauzhack-2023
330
- features:
331
- - name: id
332
- dtype: int64
333
- - name: title
334
- dtype: large_string
335
- ```
336
-
337
- - Defines the schema (column names and types) for each configuration
338
- - `dtype` options: `int64`, `float32`, `large_string`, `bool`
339
- - `list: string` = array of strings
340
- - Helps Hugging Face validate your data
341
- - Pre-compute statistics (splits, num_examples, num_bytes, download_size)
342
-
343
- ### 4. **Language**
344
-
345
- ```yaml
346
- language:
347
- - en
348
- ```
349
-
350
- - ISO 639-1 code(s) for dataset language
351
- - Multi-language: `- en`, `- fr`, `- de`
352
-
353
- ### Steps to Deploy Manually:
354
-
355
- 1. **Create a Hugging Face Dataset account** at https://huggingface.co
356
- 2. **Create new dataset repository** (private or public)
357
- 3. **Prepare your data files**:
358
- - Convert to Parquet format (recommended): `datasets.Dataset.to_parquet()`
359
- - Or keep as CSV, JSON, etc.
360
- - Upload to `/lauzhack-2023/train-*.parquet`, `/lauzhack-2024/...`, etc.
361
- 4. **Create README.md** with this YAML frontmatter at the top
362
- 5. **Push to Hub** via `git` or Hugging Face interface
363
- 6. **Test loading** with `load_dataset("your-username/lauzhack-projects")`
364
-
365
- The YAML metadata helps the Hub automatically index, preview, and serve your
366
- dataset efficiently!
 
1
  ---
2
  license: cc-by-4.0
3
  configs:
4
+ - config_name: lauzhack-2023
5
+ data_files:
6
+ - split: train
7
+ path: lauzhack-2023/train-*
8
+ - config_name: lauzhack-2024
9
+ data_files:
10
+ - split: train
11
+ path: lauzhack-2024/train-*
12
+ - config_name: lauzhack-2025
13
+ data_files:
14
+ - split: train
15
+ path: lauzhack-2025/train-*
16
+ - config_name: lauzhack-2025_lauzhack_projects
17
+ data_files:
18
+ - split: train
19
+ path: lauzhack-2025_lauzhack_projects/train-*
20
  dataset_info:
21
+ - config_name: lauzhack-2023
22
+ features:
23
+ - name: id
24
+ dtype: int64
25
+ - name: title
26
+ dtype: large_string
27
+ - name: description
28
+ dtype: large_string
29
+ - name: url
30
+ dtype: large_string
31
+ - name: team
32
+ list: string
33
+ - name: awards
34
+ list: string
35
+ - name: categories
36
+ list: string
37
+ - name: hackathon_name
38
+ dtype: large_string
39
+ - name: hackathon_year
40
+ dtype: int64
41
+ - name: hackathon_location
42
+ dtype: large_string
43
+ splits:
44
+ - name: train
45
+ num_bytes: 22974
46
+ num_examples: 67
47
+ download_size: 18646
48
+ dataset_size: 22974
49
+ - config_name: lauzhack-2024
50
+ features:
51
+ - name: id
52
+ dtype: int64
53
+ - name: title
54
+ dtype: large_string
55
+ - name: description
56
+ dtype: large_string
57
+ - name: url
58
+ dtype: large_string
59
+ - name: team
60
+ list: string
61
+ - name: awards
62
+ list: string
63
+ - name: categories
64
+ list: string
65
+ - name: hackathon_name
66
+ dtype: large_string
67
+ - name: hackathon_year
68
+ dtype: int64
69
+ - name: hackathon_location
70
+ dtype: large_string
71
+ splits:
72
+ - name: train
73
+ num_bytes: 28812
74
+ num_examples: 79
75
+ download_size: 21747
76
+ dataset_size: 28812
77
+ - config_name: lauzhack-2025
78
+ features:
79
+ - name: id
80
+ dtype: int64
81
+ - name: title
82
+ dtype: large_string
83
+ - name: description
84
+ dtype: large_string
85
+ - name: url
86
+ dtype: large_string
87
+ - name: team
88
+ list: string
89
+ - name: awards
90
+ list: string
91
+ - name: categories
92
+ list: string
93
+ - name: hackathon_name
94
+ dtype: large_string
95
+ - name: hackathon_year
96
+ dtype: int64
97
+ - name: hackathon_location
98
+ dtype: large_string
99
+ splits:
100
+ - name: train
101
+ num_bytes: 39525
102
+ num_examples: 67
103
+ download_size: 28942
104
+ dataset_size: 39525
105
+ - config_name: lauzhack-2025_lauzhack_projects
106
+ features:
107
+ - name: id
108
+ dtype: int64
109
+ - name: title
110
+ dtype: large_string
111
+ - name: description
112
+ dtype: large_string
113
+ - name: url
114
+ dtype: large_string
115
+ - name: team
116
+ list: string
117
+ - name: awards
118
+ list: string
119
+ - name: categories
120
+ list: string
121
+ - name: hackathon_name
122
+ dtype: large_string
123
+ - name: hackathon_year
124
+ dtype: int64
125
+ - name: hackathon_location
126
+ dtype: large_string
127
+ splits:
128
+ - name: train
129
+ num_bytes: 39525
130
+ num_examples: 67
131
+ download_size: 28942
132
+ dataset_size: 39525
133
  language:
134
+ - en
135
  tags:
136
+ - hackathon
137
+ - projects
138
+ - sdsc
 
139
  ---
140
 
141
  # LauzHack Projects Dataset
 
216
  "url": "https://devpost.com/software/...",
217
  "team": ["Alice Dupont", "Bob Mueller"],
218
  "awards": ["Best Use of AI"],
219
+ "categories": ["Machine Learning", "Education Tech", "Open Science"],
220
  "hackathon_name": "LauzHack 2025",
221
  "hackathon_year": 2025,
222
  "hackathon_location": "EPFL, Lausanne, Switzerland"
 
269
  ```bibtex
270
  @dataset{lauzhack_projects_2026,
271
  author = {Tir Raazia, Eisha},
272
+ title = {Hackalysis Dataset 2023-2025},
273
  year = {2026},
274
  license = {CC-BY-4.0},
275
  url = {https://huggingface.co/datasets/username/lauzhack-projects}
 
282
 
283
  - [LauzHack Official Website](https://lauzhack.com/)
284
  - [EPFL Innovation Park](https://www.epfl.ch/)
285
+ - [hackathon-analysis GitHub Repository](https://github.com/sdsc-ordes/open-pulse-hackalysis)
286
 
287
  ### Dataset Maintenance
288
 
289
+ This dataset is maintained by the open-pulse-hackalysis project
 
290
 
291
+ ---