janvanlooy commited on
Commit
8a539fc
1 Parent(s): 9c6e082

added dataset name

Browse files
Files changed (1) hide show
  1. README.md +6 -6
README.md CHANGED
@@ -48,10 +48,10 @@ size_categories:
48
  ## Changelog
49
  |Release|Description|
50
  |-|-|
51
- |v1.0| Initial release of the [TODO:dataset name]
52
 
53
  ## Dataset Summary
54
- [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.
55
 
56
  ## Supported Tasks and Leaderboards
57
 
@@ -71,7 +71,7 @@ print(next(iter(dataset))) #TODO: add int ids?
71
  ### Utilizing the dataset in a fondant pipeline
72
 
73
 
74
- We have prepared a sample fondant pipeline that reduces the dataset to PNG files and subsequently
75
  downloads the images.
76
 
77
  To execute the pipeline locally, you must have [docker compose](https://docs.docker.com/compose/) installed on your local
@@ -83,7 +83,7 @@ Furthermore, you will need to install Fondant by running:
83
  pip install fondant[pipelines]
84
  ```
85
 
86
- Afterward, you can clone the GitHub repository, navigate to the `examples/pipelines/filter-cc-25m`, and initiate the
87
  pipeline by executing:
88
 
89
  ```bash
@@ -128,7 +128,7 @@ The released dataset may contain sensitive information such as names, emails and
128
  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).
129
 
130
 
131
- ### Opting out of [dataset name]
132
  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.
133
  If you'd like to have your data removed from the dataset, [contact us](mailto:info@fondant.ai).
134
 
@@ -145,7 +145,7 @@ If you'd like to have your data removed from the dataset, [contact us](mailto:in
145
 
146
 
147
  ### Licensing Information
148
- [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.
149
 
150
  The list of Creative Commons license types included in the dataset can be found [here](https://creativecommons.org/about/cclicenses/).
151
 
 
48
  ## Changelog
49
  |Release|Description|
50
  |-|-|
51
+ |v0.1| Release of the Fondant-cc-25m dataset
52
 
53
  ## Dataset Summary
54
+ 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.
55
 
56
  ## Supported Tasks and Leaderboards
57
 
 
71
  ### Utilizing the dataset in a fondant pipeline
72
 
73
 
74
+ We have prepared a sample fondant pipeline that limits the dataset to PNG files and subsequently
75
  downloads the images.
76
 
77
  To execute the pipeline locally, you must have [docker compose](https://docs.docker.com/compose/) installed on your local
 
83
  pip install fondant[pipelines]
84
  ```
85
 
86
+ Then you can clone the GitHub repository, navigate to the `examples/pipelines/filter-cc-25m`, and initiate the
87
  pipeline by executing:
88
 
89
  ```bash
 
128
  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).
129
 
130
 
131
+ ### Opting out of Fondant-cc-25m
132
  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.
133
  If you'd like to have your data removed from the dataset, [contact us](mailto:info@fondant.ai).
134
 
 
145
 
146
 
147
  ### Licensing Information
148
+ Fondant-cc-25m is a collection of images with various Creative Commons and other public licenses. Any use of all or part of the images gathered in Fondant-cc-25m 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.
149
 
150
  The list of Creative Commons license types included in the dataset can be found [here](https://creativecommons.org/about/cclicenses/).
151