pszemraj commited on
Commit
b1f8f12
1 Parent(s): f7a9ded

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +68 -13
README.md CHANGED
@@ -201,41 +201,96 @@ configs:
201
  - split: test
202
  path: txt/test-*
203
  ---
204
- # govdocs1: by file extension
205
 
206
- Markdown-parsed versions of docs in [govdocs1](https://digitalcorpora.org/corpora/file-corpora/files/) with light filtering.
207
 
208
- ## usage
209
 
210
- This loads all the `.doc` files (parsed to markdown with `pandoc`):
 
 
211
 
212
  ```python
213
  from datasets import load_dataset
214
 
215
- # If the dataset is gated/private, make sure you have run huggingface-cli login
216
  dataset = load_dataset("BEE-spoke-data/govdocs1-by-extension", "doc")
217
  ```
218
 
219
- ## details
220
 
221
- Most documents ratain formatting capturing the original `.doc` (or similar file) like tables which is cool:
222
 
 
 
 
 
 
 
 
223
 
 
224
 
225
- ![image/png](https://cdn-uploads.huggingface.co/production/uploads/60bccec062080d33f875cd0c/dXJWcIUSPKN2y0b9RFT2a.png)
226
 
227
- ## info
 
 
 
228
 
229
- https://digitalcorpora.org/corpora/file-corpora/files/
230
 
 
231
 
232
- ```
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
233
  @inproceedings{garfinkel2009bringing,
234
  title={Bringing Science to Digital Forensics with Standardized Forensic Corpora},
235
- author={Garfinkel, Simson and Farrell, Paul and Roussev, Vassil and Dinolt, George},
236
  booktitle={Digital Forensic Research Workshop (DFRWS) 2009},
237
  year={2009},
238
  address={Montreal, Canada},
239
  url={https://digitalcorpora.org/corpora/file-corpora/files/}
240
  }
241
- ```
 
 
 
 
201
  - split: test
202
  path: txt/test-*
203
  ---
 
204
 
205
+ # govdocs1 Dataset: By File Extension
206
 
207
+ Markdown-parsed versions of documents in [govdocs1](https://digitalcorpora.org/corpora/file-corpora/files/) with light filtering.
208
 
209
+ ## Usage
210
+
211
+ Load specific file formats (e.g., `.doc` files) parsed to markdown with `pandoc`:
212
 
213
  ```python
214
  from datasets import load_dataset
215
 
216
+ # Replace "doc" with desired config name
217
  dataset = load_dataset("BEE-spoke-data/govdocs1-by-extension", "doc")
218
  ```
219
 
220
+ ## Configurations
221
 
222
+ This dataset includes multiple configurations, each corresponding to a different file extension:
223
 
224
+ - `doc`
225
+ - `docx`
226
+ - `logs`
227
+ - `ppt`
228
+ - `pptx`
229
+ - `rtf`
230
+ - `txt`
231
 
232
+ Each configuration contains `train`, `validation`, and `test` splits.
233
 
234
+ ## Dataset Details
235
 
236
+ - **Download Size**: Varies by configuration
237
+ - **Dataset Size**: Varies by configuration
238
+ - **Splits**: Train, Validation, Test
239
+ - **Features**: Section, Filename, Text
240
 
241
+ ### counts
242
 
243
+ Here's a summary of the number of examples for each configuration in the dataset (thus far):
244
 
245
+ 1. **DOC Configuration**
246
+ - Train Examples: 38,094
247
+ - Validation Examples: 1,002
248
+ - Test Examples: 1,003
249
+
250
+ 2. **DOCX Configuration**
251
+ - Train Examples: 141
252
+ - Validation Examples: 8
253
+ - Test Examples: 8
254
+
255
+ 3. **Logs Configuration**
256
+ - Train Examples: 9,223
257
+ - Validation Examples: 243
258
+ - Test Examples: 243
259
+
260
+ 4. **PPT Configuration**
261
+ - Train Examples: 13,865
262
+ - Validation Examples: 365
263
+ - Test Examples: 365
264
+
265
+ 5. **PPTX Configuration**
266
+ - Train Examples: 963
267
+ - Validation Examples: 53
268
+ - Test Examples: 54
269
+
270
+ 6. **RTF Configuration**
271
+ - Train Examples: 942
272
+ - Validation Examples: 52
273
+ - Test Examples: 53
274
+
275
+ 7. **TXT Configuration**
276
+ - Train Examples: 41,393
277
+ - Validation Examples: 1,089
278
+ - Test Examples: 1,090
279
+
280
+
281
+
282
+ ## Citation
283
+
284
+ ```bib
285
  @inproceedings{garfinkel2009bringing,
286
  title={Bringing Science to Digital Forensics with Standardized Forensic Corpora},
287
+ author={Garfinkel, Simson and others},
288
  booktitle={Digital Forensic Research Workshop (DFRWS) 2009},
289
  year={2009},
290
  address={Montreal, Canada},
291
  url={https://digitalcorpora.org/corpora/file-corpora/files/}
292
  }
293
+ ```
294
+
295
+ For more detailed information on each configuration, refer to the dataset documentation.
296
+