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

Draft dataset card

Browse files
Files changed (1) hide show
  1. README.md +115 -0
README.md ADDED
@@ -0,0 +1,115 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Dataset Card for Fondant's free to use images
2
+
3
+
4
+ ![image/png](https://cdn-uploads.huggingface.co/production/uploads/6504a4d7ed19d8114b973b06/yPOhZVKYqBnklbbuAYrIq.png)
5
+
6
+ ## Table of Contents
7
+ - [Table of Contents](#table-of-contents)
8
+ - [Dataset Description](#dataset-description)
9
+ - [Changelog](#changelog)
10
+ - [Dataset Summary](#dataset-summary)
11
+ - [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards)
12
+ - [How to use it](#how-to-use-it)
13
+ - [Dataset Structure](#dataset-structure)
14
+ - [Data Instances](#data-instances)
15
+ - [Data Fields](#data-fields)
16
+ - [Dataset Creation](#dataset-creation)
17
+ - [Curation Rationale](#curation-rationale)
18
+ - [Source Data](#source-data)
19
+ - [Personal and Sensitive Information](#personal-and-sensitive-information)
20
+ - [Considerations for Using the Data](#considerations-for-using-the-data)
21
+ - [Social Impact of Dataset](#social-impact-of-dataset)
22
+ - [Discussion of Biases](#discussion-of-biases)
23
+ - [Other Known Limitations](#other-known-limitations)
24
+ - [Additional Information](#additional-information)
25
+ - [Dataset Curators](#dataset-curators)
26
+ - [Licensing Information](#licensing-information)
27
+ - [Citation Information](#citation-information)
28
+ - [Contributions](#contributions)
29
+ - [Terms of Use for Dataset](#terms-of-use-for-the-dataset)
30
+
31
+
32
+ ## Dataset Desricption
33
+ - **Homepage:** https://www.fondant.ai/
34
+ - **Repository:** https://github.com/ml6team/fondant
35
+ - **Paper:** N/A
36
+ - **Leaderboard:** N/A
37
+ - **Point of Contact:** info@fondant.ai
38
+
39
+ ## Changelog
40
+ |Release|Description|
41
+ |-|-|
42
+ |v1.0| Initial release of the [TODO:dataset name]
43
+
44
+ ## Dataset Summary
45
+ [Dataset name] contains 25 million image URLs available for use under [Creative Commons](https://creativecommons.org/) license obtained from the [Common Crawl web corpus](https://commoncrawl.org/). The dataset was created as part of [Fondant](https://fondant.ai), a open-source framework for building composable data preparation pipelines for training (and fine-tuning) foundation models.
46
+
47
+ ## Supported Tasks and Leaderboards
48
+
49
+ ## How to use it
50
+ ```python
51
+ from datasets import load_dataset
52
+
53
+ # full dataset (3TB of data)
54
+ ds = load_dataset("fondantai/cc-25m")
55
+
56
+ # dataset streaming (will only download the data as needed)
57
+ ds = load_dataset("fondantai/cc-25m", streaming=True)
58
+ print(next(iter(dataset))) #TODO: add int ids?
59
+ ```
60
+
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
67
+ - `license_type` (string): creative commons licence type of the image
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
76
+ #### Who are the source language producers?
77
+
78
+
79
+ ### Personal and Sensitive Information
80
+ The released dataset may contain sensitive information such as names, emails and addresses that have previously been published to the Internet. In the event that the dataset contains personal information, researchers should only use public, non-personal information in support of conducting and publishing their [open-access](https://en.wikipedia.org/wiki/Open_access) research. Personal information should not be used for spamming purposes, including sending unsolicited emails or selling of personal information. Complaints, removal requests, and "do not contact" requests can be sent to info@fondant.ai.
81
+
82
+ The PII filtering pipeline for this dataset is still a work in progress. Researchers that wish to contribute to the anonymization pipeline of the project can join [here](https://github.com/ml6team/fondant/tree/main#-contributing).
83
+
84
+
85
+ ### Opting out of [dataset name]
86
+ We are giving the public the ability to have their image removed from the dataset upon request. The process for submitting and enacting removal requests will keep evolving throughout the project as we receive feedback and build up more data governance tools.
87
+ If you'd like to have your data removed from the dataset, [contact us](mailto:info@fondant.ai).
88
+
89
+ ## Considerations for Using the Data
90
+ ### Discussion of Biases
91
+ ### Other Known Limitations
92
+
93
+ ## Additional Information
94
+
95
+ ### Dataset Curators
96
+ 1. Robbe Sneyders, ML6, robbe.sneyders@ml6.eu
97
+ 2. Sharon Grundmann, ML6, sharon.grundmann@ml6.eu
98
+ 3. Matthias Richter, ML6, matthias.richter@ml6.eu
99
+
100
+
101
+ ### Licensing Information
102
+ [Dataset name] is a collection of images with various Creative Commons licenses. Any use of all or part of the images gathered in [dataset name] must abide by the terms of the original licenses, including attribution clauses when relevant. We facilitate this by providing provenance information for each data point.
103
+
104
+ The list of Creative Commons license types included in the dataset can be found [here](https://creativecommons.org/about/cclicenses/).
105
+
106
+ ### Citation Information
107
+ ```
108
+ [TODO]
109
+ ```
110
+
111
+ ### Contributions
112
+
113
+ [More Information Needed]
114
+
115
+ ## Terms of Use for the [Dataset]