fondantai commited on
Commit
f1a9f20
1 Parent(s): cff06be

Add dataset structure

Browse files
Files changed (1) hide show
  1. README.md +10 -0
README.md CHANGED
@@ -61,6 +61,10 @@ print(next(iter(dataset))) #TODO: add int ids?
61
  TODO: How to use in a fondant pipeline?
62
 
63
  ## Dataset Structure
 
 
 
 
64
  - `image_url` (string): image url to download the image
65
  - `alt_text` (string): alternative text of the image
66
  - `webpage_url` (string): webpage source of the image
@@ -68,8 +72,14 @@ TODO: How to use in a fondant pipeline?
68
  - `license_location` (string): location of the license on the webpage
69
  - `surt_url` (string): sort friendly image url with top level domain as the prefix
70
 
 
 
 
 
71
  ## Dataset Creation
72
  ### Curation Rationale
 
 
73
  ### Source Data
74
  #### Initial Data Collection and Normalization
75
  ##### License detection
 
61
  TODO: How to use in a fondant pipeline?
62
 
63
  ## Dataset Structure
64
+ ### Data Instances
65
+ Each data instance corresponds to one image. The URL of the image is in the `image_url` feature, and other features (`alt_text`, `webpage_url`, etc) provide some metadata. Note that images have been deduplicated only based on their URLs and not embeddings.
66
+
67
+ ### Data Fields
68
  - `image_url` (string): image url to download the image
69
  - `alt_text` (string): alternative text of the image
70
  - `webpage_url` (string): webpage source of the image
 
72
  - `license_location` (string): location of the license on the webpage
73
  - `surt_url` (string): sort friendly image url with top level domain as the prefix
74
 
75
+ ## Data Splits
76
+ The dataset has no splits and all data is loaded as a [TODO: check split name - train?] split by default. If you want to setup a custom train-test split beware that the dataset may contain duplicates which can cause leakage into the test split.
77
+
78
+
79
  ## Dataset Creation
80
  ### Curation Rationale
81
+ [TODO: insert intro from FAQ doc]
82
+
83
  ### Source Data
84
  #### Initial Data Collection and Normalization
85
  ##### License detection