janvanlooy commited on
Commit
46c23b7
1 Parent(s): 73213f7

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +17 -12
README.md CHANGED
@@ -52,27 +52,29 @@ size_categories:
52
  |v0.1| Release of the Fondant-cc-25m dataset
53
 
54
  ## Dataset Summary
55
- Fondant-cc-25m contains 25 million image URLs available for use under [Creative Commons](https://creativecommons.org/) license collected 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.
 
 
 
56
 
57
  ## Supported Tasks and Leaderboards
58
 
59
- [TODO]?
60
 
61
  ## How to use it
62
 
63
- We have prepared a sample fondant pipeline that limits the dataset to PNG files and subsequently
64
- downloads the images.
65
 
66
- To execute the pipeline locally, you must have [docker compose](https://docs.docker.com/compose/) installed on your local
67
  system.
68
 
69
- Furthermore, you will need to install Fondant by running:
70
 
71
  ```
72
  pip install fondant[pipelines]
73
  ```
74
 
75
- Then you can clone the GitHub repository, navigate to the `examples/pipelines/filter-cc-25m`, and initiate the
76
  pipeline by executing:
77
 
78
  ```bash
@@ -87,18 +89,20 @@ fondant explore --base_path ./data
87
 
88
  ## Dataset Structure
89
  ### Data Instances
90
- 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.
 
91
 
92
  ### Data Fields
93
  - `image_url` (string): image url to download the image
94
  - `alt_text` (string): alternative text of the image
95
  - `webpage_url` (string): webpage source of the image
96
- - `license_type` (string): creative commons licence type of the image
97
  - `license_location` (string): location of the license on the webpage
98
- - `surt_url` (string): sort friendly image url with top level domain as the prefix
99
 
100
  ## Data Splits
101
- 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.
 
102
 
103
 
104
  ## Dataset Creation
@@ -111,7 +115,8 @@ This dataset is the first step towards our final goal of a 500M Creative Commons
111
  ### Source Data
112
  #### Initial Data Collection and Normalization
113
  ##### License detection
114
- Permissive licenses have minimal restrictions on how the image can be copied, modified, and redistributed. The full list of licenses can be found [here](https://creativecommons.org/about/cclicenses/).
 
115
 
116
  We examined HTML tags of the webpages for the presence of Creative Commons license URLs. A webpage was marked permissive if only a license URL was found in its footer, aside or sidebar. Subsequently, all the image URLs present on the web page were collected together with the license information.
117
  This approach achieved a 96.32% accuracy in an earlier test where we investigated the scope of licenses. More information on our approach can be found in [this blogpost](https://blog.ml6.eu/ai-image-generation-without-copyright-infringement-a9901b64541c).
 
52
  |v0.1| Release of the Fondant-cc-25m dataset
53
 
54
  ## Dataset Summary
55
+ Fondant-cc-25m contains 25 million image URLs available under different [Creative Commons](https://creativecommons.org/)
56
+ licenses collected from the [Common Crawl web corpus](https://commoncrawl.org/).
57
+ The dataset was created using [Fondant](https://fondant.ai), an open-source framework for building composable data
58
+ preparation pipelines for training (and fine-tuning) foundation models.
59
 
60
  ## Supported Tasks and Leaderboards
61
 
62
+ This dataset can be used for training or fine-tuning image generation or computer vision models.
63
 
64
  ## How to use it
65
 
66
+ We have prepared a sample fondant pipeline that limits the dataset to PNG files and downloads the images.
 
67
 
68
+ To execute the pipeline locally, you must have [docker compose](https://docs.docker.com/compose/) installed on your
69
  system.
70
 
71
+ You can then install Fondant by running:
72
 
73
  ```
74
  pip install fondant[pipelines]
75
  ```
76
 
77
+ Then you can clone the GitHub repository, navigate to `examples/pipelines/filter-cc-25m`, and initiate the
78
  pipeline by executing:
79
 
80
  ```bash
 
89
 
90
  ## Dataset Structure
91
  ### Data Instances
92
+ 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
93
+ metadata. Note that images have been deduplicated only based on their URLs.
94
 
95
  ### Data Fields
96
  - `image_url` (string): image url to download the image
97
  - `alt_text` (string): alternative text of the image
98
  - `webpage_url` (string): webpage source of the image
99
+ - `license_type` (string): creative commons license type of the image
100
  - `license_location` (string): location of the license on the webpage
101
+ - `sort_url` (string): sort friendly image url with top level domain as the prefix
102
 
103
  ## Data Splits
104
+ 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
105
+ beware that the dataset may contain duplicates which can cause leakage into the test split.
106
 
107
 
108
  ## Dataset Creation
 
115
  ### Source Data
116
  #### Initial Data Collection and Normalization
117
  ##### License detection
118
+ Permissive licenses have minimal restrictions on how the image can be copied, modified, and redistributed.
119
+ The full list of licenses can be found [here](https://creativecommons.org/about/cclicenses/).
120
 
121
  We examined HTML tags of the webpages for the presence of Creative Commons license URLs. A webpage was marked permissive if only a license URL was found in its footer, aside or sidebar. Subsequently, all the image URLs present on the web page were collected together with the license information.
122
  This approach achieved a 96.32% accuracy in an earlier test where we investigated the scope of licenses. More information on our approach can be found in [this blogpost](https://blog.ml6.eu/ai-image-generation-without-copyright-infringement-a9901b64541c).