jimjunior commited on
Commit
7fd9416
·
verified ·
1 Parent(s): 06f0c14

ft: add dataset card

Browse files
Files changed (1) hide show
  1. README.md +57 -0
README.md ADDED
@@ -0,0 +1,57 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: mit
3
+ task_categories:
4
+ - question-answering
5
+ language:
6
+ - en
7
+ tags:
8
+ - sunbird
9
+ - sunbirdai
10
+ pretty_name: Sunbird Salt Documentation
11
+ size_categories:
12
+ - n<1K
13
+ configs:
14
+ - config_name: default
15
+ data_files:
16
+ - split: train
17
+ path: chunks/*.json
18
+ ---
19
+
20
+ # COCIS WEB INFO
21
+
22
+ ## Dataset Summary
23
+ This dataset contains text chucks scraped from its official website and corresponding websites.
24
+ The dataset consists of **JSON chunks**, designed for high-performance streaming and parallel processing. Each chunk represents a discrete unit of data structured for machine learning tasks.
25
+
26
+ By sharding the data into chuck files, this repository supports the `datasets` library's streaming mode, allowing users to train models without downloading the entire dataset into RAM—a critical feature for resource-constrained environments or high-concurrency CI/CD pipelines.
27
+
28
+ ## Repository Structure
29
+ The data is organized into a `chunks/` directory to maintain a clean root level:
30
+
31
+ ```text
32
+ .
33
+ ├── README.md # This file
34
+ └── chunks/ # Directory containing JSON files
35
+ ├── chunk_1.json
36
+ ├── chunk_2.json
37
+ └── ...
38
+ ```
39
+
40
+ ## Usage
41
+
42
+ You can load this dataset directly using the Hugging Face datasets library:
43
+
44
+ ```python
45
+ from datasets import load_dataset
46
+
47
+ # Standard loading
48
+ dataset = load_dataset("jimjunior/sunbird_salt_docs")
49
+
50
+ # Streaming mode (Recommended for many shards)
51
+ streamed_dataset = load_dataset("jimjunior/sunbird_salt_docs", streaming=True)
52
+ print(next(iter(streamed_dataset["train"])))
53
+ ```
54
+
55
+ ## Maintenance and Contributions
56
+
57
+ This dataset was created as part of the Sunbird AI Internship 2026. Its actively mantained by [Beingana Jim Junior](https://www.linkedin.com/in/jim-junior-beingana/).