Skip to content

Commit

Permalink
added command line option
Browse files Browse the repository at this point in the history
  • Loading branch information
mickaelleclercq committed Jun 19, 2019
1 parent 365b022 commit fe410ec
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,15 @@ https://github.com/mickaelleclercq/BioDiscML/
REQUIRES JAVA 8

## Program usage
### Config file
BioDiscML can be started either by creating a config file or using command line

### By config file
Before executing BioDiscML, a config file must be created. Use the template to
create your own. Everything is detailled in the config.conf file. Examples are
available in the Test_datasets at:
https://github.com/mickaelleclercq/BioDiscML/tree/master/release/Test_datasets

### Train a new model
#### Train a new model
```Bash
java -jar biodiscml.jar -config config.conf -train
```
Expand All @@ -50,7 +52,7 @@ numberOfBestModels=1
numberOfBestModelsSortingMetric=TRAIN_TEST_RH_MCC
```

### Choose best model(s)
#### Choose best model(s)
```Bash
java -jar biodiscml.jar -config config_example.conf -bestmodel
```
Expand All @@ -65,7 +67,19 @@ the command. Example:
java -jar biodiscml.jar -config config.conf -bestmodel modelID_1 modelID_2
```

### Output files
### By command line
The same parameters from config file can be used to be inputed in a command line.
Example:
time java -jar biodiscml.jar -train -project=myProject -excluded=excludedColumn
-doClassification=true -classificationClassName=class -trainFile=data.csv
-debug=true -bootstrapFolds=10 -loocv=false -cpus=10 -computeBestModel=false
-classificationFastWay=true -ccmd=bayes.AveragedNDependenceEstimators.A1DE -F 1 -M 1.0 -W

Note that the option -ccmd must stay at the end of the command line when classifier
parameters follows it.


## Output files
Note: {project_name} is set in the config.conf file

- {project_name}_a.*
Expand Down

0 comments on commit fe410ec

Please sign in to comment.