BramVanroy commited on
Commit
c7b988c
·
verified ·
1 Parent(s): 5a5dd48

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +4 -3
README.md CHANGED
@@ -199,6 +199,8 @@ The licensing information is extracted from the web pages based on whether they
199
 
200
  I am very grateful to the Flemish Supercomputer to provide compute necessary to create this dataset, but as you can tell there is still a lot of data left to be processed. Therefore, I am happy to collaborate to process as many Common Crawl crawls as possible. [Shoot me a message](mailto:bram.vanroy@kuleuven.be) if you want to sponsor this project with compute! You can also simply run the code yourself if you'd like. You can find the whole code base, based on `datatrove`, on [Github](https://github.com/BramVanroy/CommonCrawl-CreativeCommons). If you use the code, please [reference my work](https://github.com/BramVanroy/CommonCrawl-CreativeCommons?tab=readme-ov-file#citation) accordingly and share your processed crawls with the rest of the world (or get in touch with me so I can add them to this repo).
201
 
 
 
202
  ## Usage
203
 
204
  ```python
@@ -265,14 +267,13 @@ Detailed number of tokens (Llama 3.3 tokenizer) and number of documents are give
265
 
266
  ## Fields
267
 
268
- In some cases, multiple licenses are found on a single page. All licenses are collected in `potential_licenses`. From these, the "best guess" is selected
269
- based on three criteria:
270
 
271
  1. location_preference_order: meta_tag, json-ld, link_tag, a_tag
272
  2. head_preference_order: True, False
273
  3. footer_preference_order: True, False
274
 
275
- Based on these criteria, the "best guessed" license is picked as the one in the `license_*` columns. Potential disagreement between multiple licenses is given in `license_disagreement`.
276
 
277
  - text: the extracted text (unmodified)
278
  - id: WARC-Record-ID
 
199
 
200
  I am very grateful to the Flemish Supercomputer to provide compute necessary to create this dataset, but as you can tell there is still a lot of data left to be processed. Therefore, I am happy to collaborate to process as many Common Crawl crawls as possible. [Shoot me a message](mailto:bram.vanroy@kuleuven.be) if you want to sponsor this project with compute! You can also simply run the code yourself if you'd like. You can find the whole code base, based on `datatrove`, on [Github](https://github.com/BramVanroy/CommonCrawl-CreativeCommons). If you use the code, please [reference my work](https://github.com/BramVanroy/CommonCrawl-CreativeCommons?tab=readme-ov-file#citation) accordingly and share your processed crawls with the rest of the world (or get in touch with me so I can add them to this repo).
201
 
202
+ The approach to creating this dataset is different from similar endeavors such as [common-pile/dolma-cccc](https://huggingface.co/datasets/common-pile/dolma-cccc) and the [C4Corpus](https://data.commoncrawl.org/contrib/c4corpus/CC-MAIN-2016-07/index.html). They rely on intricately crafted regular expressions to quickly extract potential licenses from a web page (string-based matching). However, doing so makes it hard to retrieve any structural meta information about the license such as where it was found on the page. In C5, the whole webpage is parsed into a programmatic structure, allowing for an iterative search through this parsed "tree". That makes it possible to track where licenses were found (in the head of a document, for instance). Such information is crucial to minimise false positives: if a license is referred in a `meta` tag in the `head` of an HTML page, it is more trustworthy than a "random link" referring to a copyright license in the middle of a web page, which might just be discussing the license in general or providing a license for a picture on the website. Metadata *about* the license is powerful to attach confidence to the extracted licenses, enabling robust filtering to avoid false positives. While I strongly believe this approach is valuable it also makes it very *slow* compared to a regex search!
203
+
204
  ## Usage
205
 
206
  ```python
 
267
 
268
  ## Fields
269
 
270
+ In some cases, multiple licenses are found on a single page. All licenses are collected in `potential_licenses`. These are then sorted based on three criteria (first option is most preferred, last option is least preferred, e.g. a license found in a `meta` tag is more trustworthy than a license in an `a` tag, a license in a footer is more trustworthy than a license not in the footer of a page).
 
271
 
272
  1. location_preference_order: meta_tag, json-ld, link_tag, a_tag
273
  2. head_preference_order: True, False
274
  3. footer_preference_order: True, False
275
 
276
+ Based on these criteria, the "best" license is picked as the one in the `license_*` columns. Potential disagreement between multiple licenses is given in `license_disagreement`.
277
 
278
  - text: the extracted text (unmodified)
279
  - id: WARC-Record-ID