danielladiaz commited on
Commit
ec3de02
·
verified ·
1 Parent(s): 080b776

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +79 -3
README.md CHANGED
@@ -1,3 +1,79 @@
1
- ---
2
- license: mit
3
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: mit
3
+ ---
4
+ ## CoLA Text Classification RCL Dataset
5
+
6
+ ### Overview
7
+
8
+ This dataset contains textual data structured explicitly for standard text classification tasks using Lumina AI's Random Contrast Learning (RCL) algorithm via the PrismRCL application. Unlike LLM datasets, standard text classification datasets contain individual .txt files organized by class.
9
+
10
+ ### Dataset Structure
11
+
12
+ The dataset structure for text classification training:
13
+
14
+ ```
15
+ CoLA.Classification/
16
+ train/
17
+ [class_1]/
18
+ sample_001.txt
19
+ sample_002.txt
20
+ ...
21
+ [class_2]/
22
+ sample_001.txt
23
+ sample_002.txt
24
+ ...
25
+ test/
26
+ [class_1]/
27
+ sample_001.txt
28
+ sample_002.txt
29
+ ...
30
+ [class_2]/
31
+ sample_001.txt
32
+ sample_002.txt
33
+ ...
34
+ ```
35
+
36
+ - **Classes:** Folder names represent distinct text classes.
37
+ - **Text Samples:** Each `.txt` file represents a single textual data sample.
38
+
39
+ ### Text Data Preparation
40
+
41
+ For standard text classification datasets, PrismRCL has specific preparation requirements:
42
+
43
+ - Text samples must be in `.txt` format.
44
+ - Each file should contain a single data sample.
45
+ - File names must be unique across all class folders.
46
+
47
+ ### Usage (Text Classification-specific)
48
+
49
+ Use PrismRCL for training with text data:
50
+
51
+ ```
52
+ C:\PrismRCL\PrismRCL.exe naivebayes rclticks=10 directional ^
53
+ data=C:\path\to\CoLA.Classification\train testdata=C:\path\to\CoLA.Classification\test ^
54
+ savemodel=C:\path\to\models\cola_text_model.classify ^
55
+ log=C:\path\to\log_files stopwhendone
56
+ ```
57
+
58
+ ### Explanation of Command
59
+
60
+ - **naivebayes:** Specifies Naive Bayes as the evaluation method for text classification.
61
+ - **rclticks:** Number of RCL iterations during training.
62
+ - **directional:** Maintains the order of words, essential for text classification.
63
+ - **data & testdata:** Paths to training and testing text datasets.
64
+ - **savemodel:** Output path for the trained classification model.
65
+ - **log:** Directory for storing log files.
66
+ - **stopwhendone:** Automatically terminates the session after training completion.
67
+
68
+ ### License
69
+
70
+ This dataset is licensed under the MIT License.
71
+
72
+ ### Original Source
73
+
74
+ Prepared explicitly by Lumina AI for RCL-based text classification training. Please credit Lumina AI when using this dataset in research or applications.
75
+
76
+ ### Additional Information
77
+
78
+ Refer to the PrismRCL Technical Documentation v2.6.2 for more detailed guidance on text classification data preparation and parameter specifications.
79
+