realzL commited on
Commit
01cffdb
·
verified ·
1 Parent(s): f3ffd3f

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +37 -1
README.md CHANGED
@@ -17,4 +17,40 @@ configs:
17
  path: phd_webdataset/phd-icc.tar
18
  - split: phd_ccs
19
  path: phd_webdataset/phd-ccs.tar
20
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
17
  path: phd_webdataset/phd-icc.tar
18
  - split: phd_ccs
19
  path: phd_webdataset/phd-ccs.tar
20
+ ---
21
+
22
+ # PhD Webdataset
23
+
24
+ This repository contains the packaged version of [**PhD**](https://huggingface.co/datasets/AIMClab-RUC/PhD). For a detailed introduction to PhD, please visit the [official website](https://huggingface.co/datasets/AIMClab-RUC/PhD).
25
+
26
+ ## Overview
27
+
28
+ The PhD Webdataset is designed to facilitate easy access and usage of the PhD dataset. It includes various fields in 'json' key.
29
+
30
+ ## Installation
31
+
32
+ Ensure you have [Hugging Face's datasets library](https://github.com/huggingface/datasets) installed. You can install it via pip:
33
+
34
+ ```bash
35
+ pip install datasets
36
+ ```
37
+
38
+ ## Usage
39
+
40
+ To load and use the PhD dataset, simply run the following code:
41
+
42
+ ```python
43
+ from datasets import load_dataset
44
+
45
+ phd = load_dataset("AIMClab-RUC/PhD-package")['phd_base'] # options include (phd_base, phd_sec, phd_icc, phd_ccs)
46
+
47
+ # see phd[0]['json']['question']
48
+ ```
49
+
50
+ The loaded dataset includes the following fields:
51
+ - **question_id**
52
+ - **question**
53
+ - **answer**
54
+ - **image**
55
+ - **task**
56
+ - **mode**