Skip to content

Commit 9cb76a2

Browse files
committed
Updated the README for the Rscript example of use
1 parent b1a8449 commit 9cb76a2

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ Columns = embedding dimensions; rows = instances. The first line of the file cor
1414
## How to run BIR?
1515
In order to run BIR, execute all lines of BIR.R. Inputs (the embedding X and the features Fe for explaining it) should be located in the folder Datasets. The results will be provided in the folder called Results.
1616

17-
If you want to run BIR as a script (with Rscript), you can either use no argument (in this case, dataset.csv and embedding.csv should be in the folder Datasets) or 2 arguments (the first one is the path to the embedding file and the second one is the path to the dataset used to exeplain the embedding).
17+
If you want to run BIR as a script (with Rscript), you can either use no argument (in this case, dataset.csv and embedding.csv should be in the folder Datasets) or 3 arguments (the first one is the path to the embedding file, the second one is the path to the dataset used to exeplain the embedding and the third one is the path indicating where the results should be stored).
1818

19-
Here is one example of use: Rscript BIR.R a_path_to/my_embedding_file.csv another_path_to/my_dataset_file.csv
19+
Here is one example of use: Rscript BIR.R a_path_to/my_embedding_file.csv another_path_to/my_dataset_file.csv an_output_path/output_file.RData
2020

2121
## How long does it take to run BIR?
2222
The selection of lambda should be perform before running BIR for the last time. As lambda is selected by 10-fold cross validation and the optimization is performed using simulated annealing, running BIR will take (number of lambdas to test) * (number of folds in the cross validation) * (number of seconds for simulated annealing). In the current implementation, this means 10 lambdas * 10 folds * 2 seconds.

0 commit comments

Comments
 (0)