Update README.md

README.md

@@ -2,15 +2,15 @@
 language: pt
 license: cc-by-4.0
 multilinguality:
-  - monolingual
+- monolingual
 task_categories:
-  - text-generation
-  - fill-mask
+- text-generation
+- fill-mask
 task_ids:
-  - language-modeling
-  - masked-language-modeling
+- language-modeling
+- masked-language-modeling
 size_categories:
-  - 100M<n<1B
+- 100M<n<1B
 dataset_info:
   features:
   - name: url
@@ -33,6 +33,7 @@ dataset_info:
     num_examples: 342818651
   download_size: 1087713663056
   dataset_size: 1087519823221
+pretty_name: Canarim
 ---
 
 <p align="center">
@@ -40,7 +41,7 @@ dataset_info:
 </p>
 
 <p align="center">
-  <a href="https://github.com/DominguesM/canarim">[🐱 Github]</a>
+  <a href="https://huggingface.co/datasets/dominguesm/canarim">[🐱 HuggingFace]</a>
 </p>
 
 <hr>
@@ -60,13 +61,13 @@ An example looks as follows:
 
 ```json
 {
-  'url': '...',
-  'content_languages': 'por',
-  'warc_filename': 'crawl-data/CC-MAIN-2023-06/segments/1674764500041.18/warc/CC-MAIN-20230202200542-20230202230542-00352.warc.gz',
-  'warc_record_offset': 971279893,
-  'warc_record_length': 3873,
-  'text': '...',
-  'crawl_timestamp': '2023-02-02T20:28:21Z'
+  "url": "...",
+  "content_languages": "por",
+  "warc_filename": "crawl-data/CC-MAIN-2023-06/segments/1674764500041.18/warc/CC-MAIN-20230202200542-20230202230542-00352.warc.gz",
+  "warc_record_offset": 971279893,
+  "warc_record_length": 3873,
+  "text": "...",
+  "crawl_timestamp": "2023-02-02T20:28:21Z"
 }
 ```
 
@@ -94,7 +95,71 @@ The Canarim database employs the [`Trafilatura`](https://trafilatura.readthedocs
   <a href="https://github.com/DominguesM/canarim/blob/main/assets/extracted_text.md" target="_blank">Extracted Text</a>
 </p>
 
+## Usage
 
+Below is an example of how to quickly explore just a few samples from a dataset using the `datasets` library.
 
+```python
+!pip install -q datasets
 
-WIP
+from datasets import load_dataset
+
+ds = load_dataset(
+    "dominguesm/canarim",
+    # Filter only the data from the `train split`
+    split="train",
+    # Filter only the files that contain the prefix `train/data-0019` and the suffix `-of-00192.arrow`
+    data_files="train/data-0019*-of-00192.arrow",
+    # Load the dataset without downloading the data (Streaming mode)
+    streaming=True
+)
+
+# From the returned data, filter only the data where the `url` value starts with `https://g1.globo.com/`
+ds_globo = ds.filter(
+    lambda example: example['url'].startswith("https://g1.globo.com/")
+)
+
+# Return the first 10 examples from the applied filter.
+data = list(ds_globo.take(10))
+
+print(data[0])
+
+# {
+#     "url": "https://g1.globo.com/ac/acre/(...)",
+#     "content_languages": "por",
+#     "warc_filename": "crawl-data/CC-MAIN-2023-06/segments/1674764499919.70/warc/CC-MAIN-20230201081311-20230201111311-00552.warc.gz",
+#     "warc_record_offset": 281625400,
+#     "warc_record_length": 192934,
+#     "text": "Parque Zoobotânico da Ufac guarda uma grande variedade espécies de árvores em Rio Branco — Foto: Arquivo/Ufac (...)",
+#     "crawl_timestamp": "2023-02-01T10:38:52Z"
+# }
+```
+
+## Dataset Statistics
+
+| Split  | # Samples | # Size (bytes) | # Size (GB) |
+| ------ | --------- | -------------- | ----------- |
+| Train  | 342,818,651 | 1,087,519,823,221 | 1087,51 |
+
+## Citing
+
+If you use Canarim in your research, please cite the following.
+  
+```bibtex
+  @misc {maicon_domingues_2024,
+    author       = { {Maicon Domingues} },
+    title        = { canarim (Revision 640e079) },
+    year         = 2024,
+    url          = { https://huggingface.co/datasets/dominguesm/canarim },
+    doi          = { 10.57967/hf/1605 },
+    publisher    = { Hugging Face }
+  }
+```
+
+## License
+
+This dataset is licensed under the [Creative Commons Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/). You can use the dataset for any purpose, but you must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
+
+## Contact
+
+For any questions or suggestions, please contact [Maicon Domingues](https://nlp.rocks/).