danielladiaz commited on
Commit
dd19842
1 Parent(s): db0f296

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +13 -12
README.md CHANGED
@@ -38,20 +38,21 @@ Cancer_Documents_Classification/
38
 
39
  ## Usage (not pre-split; optimal parameters)
40
  Here is an example of how to load the dataset using PrismRCL:
41
-
42
  ```bash
43
- C:\PrismRCL\PrismRCL.exe chisquared rclticks=15 boxdown=0 channelpick=5 data=C:\path\to\Cancer_Documents_Classification_mm testsize=0.1 savemodel=C:\path\to\models\mymodel.classify log=C:\path\to\log_files stopwhendone```
 
44
 
45
- Explanation:
46
- - `C:\PrismRCL\PrismRCL.exe`: classification application
47
- - `chisquared`: training evaluation method
48
- - `rclticks=15`: RCL training parameter
49
- - `boxdown=0`: RCL training parameter
50
- - `data=C:\path\to\Cancer_Documents_Classification\train_data`: path to training data
51
- - `testdata=C:\path\to\Cancer_Documents_Classification\test_data`: path to testing data
52
- - `savemodel=C:\path\to\models\mymodel.classify`: path to save resulting model
53
- - `log=C:\path\to\log_files`: path to logfiles
54
- - `stopwhendone`: ends the PrismRCL session when training is done
 
55
 
56
  ## License
57
  This dataset is licensed under the Creative Commons Attribution 4.0 International License. See the LICENSE file for more details.
 
38
 
39
  ## Usage (not pre-split; optimal parameters)
40
  Here is an example of how to load the dataset using PrismRCL:
 
41
  ```bash
42
+ C:\PrismRCL\PrismRCL.exe chisquared rclticks=15 boxdown=0 channelpick=5 data=C:\path\to\Cancer_Documents_Classification_mm testsize=0.1 savemodel=C:\path\to\models\mymodel.classify log=C:\path\to\log_files stopwhendone
43
+ ```
44
 
45
+ Explanation of Command:
46
+ - `C:\PrismRCL\PrismRCL.exe`: Path to the PrismRCL executable for classification
47
+ - `chisquared`: Specifies Chi-squared as the training evaluation method
48
+ - `rclticks=15`: Sets the number of RCL iterations during training to 15
49
+ - `boxdown=0`: Configuration parameter for training behavior
50
+ - `channelpick=5`: RCL training parameter
51
+ - `data=C:\path\to\Cancer_Documents_Classification_mm`: Path to the complete dataset for Cancer Documents Classification
52
+ - `testsize=0.1`: Specifies that 10% of the data should be used for testing
53
+ - `savemodel=C:\path\to\models\mymodel.classify`: Path to save the resulting trained model
54
+ - `log=C:\path\to\log_files`: Directory path for storing log files of the training process
55
+ - `stopwhendone`: Instructs PrismRCL to end the session once training is complete
56
 
57
  ## License
58
  This dataset is licensed under the Creative Commons Attribution 4.0 International License. See the LICENSE file for more details.