Merge pull request #171 from leondavi/onn600

Onn600 + display stats for multi-label experiments

NerlnetGetData.sh

@@ -5,9 +5,9 @@ NERLNET_PREFIX="[GET_DATA]"
 INPUT_DATA_DIR="inputDataDir"
 
 if [ -d "$INPUT_DATA_DIR" ]; then
-        echo "$NERLNET_PREFIX Input data directory of nerlnet is: $INPUT_DATA_DIR"
+        echo "$NERLNET_PREFIX Input data directory of nerlnet exists at: /$INPUT_DATA_DIR"
 else
-        echo "$NERLNET_PREFIX $INPUT_DATA_DIR is generated and is empty!"
+        echo "$NERLNET_PREFIX /$INPUT_DATA_DIR is being generated and filled with default data"
         wget https://github.com/halfway258/NerlnetData/archive/refs/heads/main.zip
         unzip main.zip -d $INPUT_DATA_DIR
         rm main.zip

NerlnetJupyterEnvGenerator.sh

@@ -59,12 +59,8 @@ echo "generate symbloic link: src_py/experiment.py --> $jdir/experiment.py"
 ln -s `pwd`/src_py/apiServer/experiment.py $jdir/experiment.py
 echo "generate symbloic link: src_py/jsonDirParser.py --> $jdir/jsonDirParser.py"
 ln -s `pwd`/src_py/apiServer/jsonDirParser.py $jdir/jsonDirParser.py
-echo "generate symbloic link: src_py/csvResult.py --> $jdir/csvResult.py"
-ln -s `pwd`/src_py/apiServer/csvResult.py $jdir/csvResult.py
 echo "generate symbloic link: src_py/workerResult.py --> $jdir/workerResult.py"
 ln -s `pwd`/src_py/apiServer/workerResult.py $jdir/workerResult.py
-echo "generate symbloic link: src_py/predictBatch.py --> $jdir/predictBatch.py"
-ln -s `pwd`/src_py/apiServer/predictBatch.py $jdir/predictBatch.py
 echo "generate symbloic link: inputDataDir --> $jdir/inputDataDir"
 ln -s `pwd`/inputDataDir $jdir/inputDataDir
 echo "generate symbloic link: NErlNet Directory --> $jdir/NErlNet"

README.md

@@ -52,29 +52,42 @@ Minimum gcc/g++ version 8.4 <br>
 
 On each machine that runs Nerlnet go through the following steps:
 
-1. Clone this repository with its subomdules ```git clone --recurse-submodules <link to this repo> NErlNet```
-2. Run ```sudo ./NerlnetInstall.sh```
-<br>    2.1  With argument -i script builds and installs Erlang, latest stable, and CMake.
-<br>    2.2  After running NerlnetInstall.sh, NErlNet directory can be accessed
-<br>&ensp;&ensp;&ensp;&nbsp;via the following path: ```/usr/local/lib/nerlnet-lib```
-3. Create json files of architecture, connection map and experiment flow.<br>
-   json configuration files names must follow the convention of prefixes:<br>
-   arch\_\<any\>.json, conn\_\<any\>, exp\_\<any\>. 
-4. Run ```./NerlnetRun.sh``` to start Nerlnet
+1. Clone this repository with its subomdules ```git clone --recurse-submodules <link to this repo> NErlNet```  
+2. Run ```sudo ./NerlnetInstall.sh```  
+<br>  2.1 With argument -i script builds and installs Erlang, latest stable, and CMake.  
+<br>  2.2 After running NerlnetInstall.sh, NErlNet directory can be accessed  
+<br>&ensp;&ensp;&ensp;&nbsp;via the following path: ```/usr/local/lib/nerlnet-lib```  
+3. Create json files of architecture, connection map and experiment flow.  
+  json configuration files names must follow the convention of prefixes:  
+  arch\_\<any\>.json, conn\_\<any\>, exp\_\<any\>.  
+Optional: Run ```./NerlnetGetData.sh``` to create or get default inputDataDir  
+4. Run ```./NerlnetRun.sh``` to start Nerlnet  
 
 
+On each machine that runs Nerlnet go through the following steps:
+
+1. Clone this repository with its subomdules ```git clone --recurse-submodules <link to this repo> NErlNet```  
+2. Run ```sudo ./NerlnetInstall.sh```  
+  2.1 With argument -i script builds and installs Erlang, latest stable, and CMake.  
+  2.2 After running NerlnetInstall.sh, NErlNet directory can be accessed  
+    via the following path: ```/usr/local/lib/nerlnet-lib```  
+3. Create json files of architecture, connection map and experiment flow.  
+json configuration files names must follow the convention of prefixes:  
+arch_<any>.json, conn_<any>.json, exp_<any>.json.  
+Optional: Run ```./NerlnetGetData.sh``` to create or get default inputDataDir  
+4. Run ```./NerlnetRun.sh``` to start Nerlnet  
 
 
-## Python API and Jupyter (For GUI Server): 
+## Python API and Jupyter (For UI Server): 
 Minimum Python version: 3.8
 
 1. Create and activate a virtual environment for Nerlnet: (https://docs.python.org/3/library/venv.html)  
-  ```python -m venv VENV_PATH/VENV_NAME  ==== then ===> source VENV/bin/acticvate``` 
+  ```python -m venv VENV_PATH/VENV_NAME ```  
+  ```source VENV/bin/activate``` 
 2. Install required modules while in venv ```pip install -r src_py/requirements.txt```
-3. Install Jupyter Notebook ```pip install jupyterlab```
-4. Call Jupyter environment creator script with an experiment directory ```./NerlnetJupyterEnvGenerator.sh --j <experiment_direcotry>```
-5. Run Jupyter notebook and import the ApiServer module to the notebook. 
-6. Follow the example: https://github.com/leondavi/NErlNet/blob/master/src_py/Deprecated/flow_example.ipynb 
+3. Call Jupyter environment creator script with an experiment directory ```./NerlnetJupyterEnvGenerator.sh --j <experiment_direcotry>```
+4. Run Jupyter notebook and import the ApiServer module to the notebook. 
+5. Follow the example: https://github.com/leondavi/NErlNet/blob/master/examples/example_run.ipynb 
 
 Contact Email: [email protected] 
 NerlnetJupyterEnvGenerator.sh