Salman95s commited on
Commit
31e281b
1 Parent(s): a1a8c66

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +4 -74
README.md CHANGED
@@ -1,5 +1,5 @@
1
  ---
2
- license: apache-2.0
3
  task_categories:
4
  - text-classification
5
  - token-classification
@@ -9,7 +9,7 @@ task_categories:
9
  tags:
10
  - dataset
11
  - balochi
12
- - baluchi
13
  size_categories:
14
  - 100K<n<1M
15
  ---
@@ -49,50 +49,7 @@ The dataset includes monolingual Balochi text, multilingual translation corpora,
49
 
50
  ---
51
 
52
- ## Folder Structure
53
-
54
- ```
55
- C:.
56
- ├───dataset
57
- │ │ Balochi Multilingual Corpus-v2.json
58
- │ │ Balochi_english-translation_corpus.json
59
- │ ├───splits
60
- │ │ │ balochi_to_english.json
61
- │ │ │ balochi_to_persian.json
62
- │ │ │ balochi_to_urdu.json
63
- │ └───text files
64
- │ balochi-only.csv
65
- │ monolingual_balochi.txt
66
- ├───tokenizer
67
- │ tokenizer-balochi-v2.json
68
- └───tools used to create this dataset
69
- Bal_Tokenizer.py
70
- create-json-format.py
71
- ```
72
 
73
- ---
74
-
75
- ## Custom Tokenizer
76
-
77
- This dataset includes a custom tokenizer tailored to the Balochi language. The tokenizer has been optimized for encoding Balochi text effectively for generative tasks.
78
-
79
- ### Sample Outputs:
80
-
81
- **Original**: تو کہاں گئے؟
82
-
83
- **Encoded**: `[0, 54, 42, 8, 4559, 3, 1]`
84
-
85
- **Original**: یہ کنغ پسند کنئے؟
86
-
87
- **Encoded**: `[0, 6, 14, 8997, 2066, 2094, 3, 1]`
88
-
89
- **Original**: بلی شتگ کور ء اے کسہ ء دمی کارست اتمان ء کسہ ء دمی بهر انت انچو کہ من اول سرا گشتگ ات کہ اے کسہ دو بهر ء انت یکے نبشتہ کار ء وتی کیز ء بندانی سر گوستیں اے بهر ء اولی کسہ پلی مین ء کپتگ ات ء دمی بهر انت
90
-
91
- **Encoded**: `[0, 1516, 575, 430, 5, 91, 1053, 5, 11332, 2940, 18035, 5, 1053, 5, 11332, 1234, 32, 1133, 42, 53, 709, 246, 1410, 29, 42, 91, 1053, 63, 1234, 5, 32, 662, 539, 67, 5, 122, 73, 34, 5, 7822, 43, 545, 10, 91, 1234, 5, 618, 1053, 2504, 636, 5, 579, 29, 5, 11332, 1234, 32, 1]`
92
-
93
- The tokenizer supports tokenized outputs for various use cases, ensuring compatibility with machine learning frameworks such as Hugging Face.
94
-
95
- ---
96
 
97
  ## Dataset Highlights
98
 
@@ -129,35 +86,8 @@ The dataset is released under the **CC-BY-SA 4.0** license. This means you can u
129
 
130
  ## Acknowledgments
131
 
132
- This dataset is a result of efforts to preserve and enhance computational resources for the Balochi language. The tools and scripts provided alongside this dataset were instrumental in its creation.
133
-
134
- ---
135
-
136
- ## Usage Instructions
137
-
138
- 1. **Download and Preprocess**:
139
- - Use the provided JSON files for training data.
140
- - Scripts in the `tools` folder can be used to preprocess the data.
141
-
142
- 2. **Tokenizer Integration**:
143
- - Load the custom tokenizer using the provided `tokenizer-balochi-v2.json`.
144
- - Example:
145
 
146
- ```python
147
- from transformers import PreTrainedTokenizerFast
148
-
149
- tokenizer = PreTrainedTokenizerFast(tokenizer_file="path/to/tokenizer-balochi-v2.json")
150
- encoded = tokenizer.encode("تو کہاں گئے؟")
151
- print(encoded)
152
- ```
153
-
154
- 3. **Model Training**:
155
- - Use frameworks like Hugging Face to fine-tune LLMs on this dataset.
156
-
157
- 4. **Applications**:
158
- - Develop chatbots, translation systems, or other generative applications in Balochi.
159
-
160
- ---
161
 
162
- For further details or contributions, feel free to reach out or submit issues to the project repository.
163
 
 
 
1
  ---
2
+ license: cc-by-sa-4.0
3
  task_categories:
4
  - text-classification
5
  - token-classification
 
9
  tags:
10
  - dataset
11
  - balochi
12
+ - baluchi
13
  size_categories:
14
  - 100K<n<1M
15
  ---
 
49
 
50
  ---
51
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
52
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
53
 
54
  ## Dataset Highlights
55
 
 
86
 
87
  ## Acknowledgments
88
 
89
+ This dataset is a result of efforts to preserve and enhance computational resources for the Balochi language.
 
 
 
 
 
 
 
 
 
 
 
 
90
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
91
 
 
92
 
93
+ For further details or contributions, feel free to reach out or submit issues to the project repository.