瀏覽代碼

Update 'README.md' in preparation for sharing

nschense 2 月之前
父節點
當前提交
c48455a8d7
共有 1 個文件被更改,包括 8 次插入4 次删除
  1. 8 4
      README.md

+ 8 - 4
README.md

@@ -1,6 +1,10 @@
 # Alzheimers Diagnosis Neural Net Project Rewrite
 
-## TODO
-- [ ] Implement config saving for ensembles
-- [ ] Run more models
-- [ ] 
+This code is the current version for the Alzheimers CNN uncertanity estimation project. The project consists of a set of main scripts (in the root folder) and some utilities. In order to use the project:
+
+1. Edit "config.toml" with the details of the ensemble that you would like to train (size, name, epochs etc). Make sure that the model name and ensemble name are the same if you'd like to run the ensemble analysis later.
+2. Run "train_cnn.py". This will train and save a new ensemble of CNN models using the name and congfiguration options given in the config file.
+3. Run "ensemble_predict.py". This will generate the predictions of the models on the test and validation datasets and save them to the model ensemble folder. 
+4. Run "threshold.py". This run some analysis on the ensemble and generates a set of graphs and statistics. 
+
+"bayesian.py" is unfinished and does not currently work.