sadrasabouri commited on
Commit
4aedc02
1 Parent(s): d757b00

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +20 -26
README.md CHANGED
@@ -25,7 +25,7 @@ pretty_name: ShahNegar
25
 
26
  # ShahNegar (A Plotted version of The Shahnameh)
27
 
28
- This dataset is a plotted version of Ferdousi's Shahnameh generated using DALL-E mini (aka [craiyon](https://www.craiyon.com/)). You can use this dataset using the code below:
29
 
30
  ```python
31
  from datasets import load_dataset
@@ -44,8 +44,6 @@ dataset = load_dataset("sadrasabouri/ShahNegar")
44
  - [Data Fields](#data-fields)
45
  - [Data Splits](#data-splits)
46
  - [Dataset Creation](#dataset-creation)
47
- - [Curation Rationale](#curation-rationale)
48
- - [Source Data](#source-data)
49
  - [Annotations](#annotations)
50
  - [Personal and Sensitive Information](#personal-and-sensitive-information)
51
  - [Considerations for Using the Data](#considerations-for-using-the-data)
@@ -65,47 +63,43 @@ dataset = load_dataset("sadrasabouri/ShahNegar")
65
 
66
  ### Dataset Summary
67
 
68
- This dataset contains more than 30K images with their corresponding text from the Shahnameh. For each Shahnameh paragraph, we generated at most 9 images. Images corresponding to the same paragraphs have the same `id` field.
69
 
70
  ### Supported Tasks and Leaderboards
71
 
72
- [More Information Needed]
 
 
73
 
74
  ### Languages
75
 
76
- [More Information Needed]
77
 
78
  ## Dataset Structure
79
 
80
- ### Data Instances
81
 
82
- [More Information Needed]
83
 
84
- ### Data Fields
 
 
 
 
 
 
 
 
 
85
 
86
- [More Information Needed]
87
 
88
  ### Data Splits
89
 
90
- [More Information Needed]
91
 
92
  ## Dataset Creation
93
 
94
- + The translated version of the shahnameh was generally derived from the [satoor](https://www.sattor.com/english/Shahnameh.pdf) website.
95
-
96
- ### Curation Rationale
97
-
98
- [More Information Needed]
99
-
100
- ### Source Data
101
-
102
- #### Initial Data Collection and Normalization
103
-
104
- [More Information Needed]
105
-
106
- #### Who are the source language producers?
107
-
108
- [More Information Needed]
109
 
110
  ### Annotations
111
 
 
25
 
26
  # ShahNegar (A Plotted version of The Shahnameh)
27
 
28
+ This dataset is a plotted version of Ferdowsi's Shahnameh (which is a highly-regarded ancient set of Farsi poems) generated using DALL-E mini (aka [craiyon](https://www.craiyon.com/)). You can use this dataset using the code below:
29
 
30
  ```python
31
  from datasets import load_dataset
 
44
  - [Data Fields](#data-fields)
45
  - [Data Splits](#data-splits)
46
  - [Dataset Creation](#dataset-creation)
 
 
47
  - [Annotations](#annotations)
48
  - [Personal and Sensitive Information](#personal-and-sensitive-information)
49
  - [Considerations for Using the Data](#considerations-for-using-the-data)
 
63
 
64
  ### Dataset Summary
65
 
66
+ This dataset contains more than 30K images with their corresponding text from the Shahnameh. For each Shahnameh paragraph, we generated at most 9 images. Images corresponding to the same paragraphs have the same `id` field. There was a human annotation post-process in which we removed some harmful/private generated images from the dataset.
67
 
68
  ### Supported Tasks and Leaderboards
69
 
70
+ The main purpose of making this dataset open source is because of its artistic value, but it can also be used for the below tasks:
71
+ + text-to-image
72
+ + image-to-text (image captioning)
73
 
74
  ### Languages
75
 
76
+ The Shahnameh was generally written in Farsi (Persian) but the translated version we used for this dataset - [satoor](https://www.sattor.com/english/Shahnameh.pdf) - was completely in English with no alignments for the corresponding Farsi poem. We are planning to add another field to dataset entries which is the corresponding Farsi poem as soon as possible.
77
 
78
  ## Dataset Structure
79
 
80
+ ### Data Fields
81
 
82
+ Here is an instance of our dataset:
83
 
84
+ ```json
85
+ {
86
+ "image": <PIL Image Byte>,
87
+ "id": 0,
88
+ "text": "He took up his abode in the mountains, and clad himself and his people in tiger-skins, and from him sprang all kindly nurture and the arts of clothing, till then unknown."
89
+ }
90
+ ```
91
+ + `image`: the image for given text.
92
+ + `id`: the id for the text (**Not for the image**).
93
+ + `text`: the English text for the image.
94
 
 
95
 
96
  ### Data Splits
97
 
98
+ This dataset has only a split (`train` split).
99
 
100
  ## Dataset Creation
101
 
102
+ The translated version of the Shahnameh was generally derived from the [satoor](https://www.sattor.com/english/Shahnameh.pdf) website.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
103
 
104
  ### Annotations
105