Skip to content

Commit 80b334c

Browse files
updating readme
1 parent 95bb94a commit 80b334c

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

README_PROTONN_OSS.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -114,12 +114,14 @@ Most users should copy this section directly to all their ProtoNN execution scri
114114
- **Errors and warnings** are printed to **std::cerr**.
115115

116116
- Additional **parameter dumps**, **timer logs** and other **debugging logs** will be placed in the input folder `foo`. Hence, the user should have read-write permissions on `foo` (use chmod if necessary).
117-
- On execution, a folder called `ProtoNNResults` is created in `foo`. The results folder will have another folder whose name will indicate to the user the list of parameters with which the run was instantiated. In this folder, upto **6 files** will be created depending on which flags are set in `config.mk`:
118-
- **diagnosticLog**: Created on using the `LOGGER` or `LIGHT_LOGGER` flags. This file stores logging information such as the call flow of ProtoNN and the min, max, norms of various matrices. This is mainly for debugging/optimization purposes and requires a more detailed understanding of the code to interpret. It may contain useful information if your code did not run as expected. **The log file is populated synchronously while the ProtoNN optimization is executing.**
119-
- **timerLog**: Created on using the `TIMER` flag. This file stores proc time and wall time taken to execute various function calls in the code. Indicates the degree of parallelization and is useful for identifying bottlenecks to optimize the code. On specifying the `CONCISE` flag, timing information will only be printed if running time is higher than a threshold specified in `src/common/timer.cpp`.
117+
- On execution, a folder called `ProtoNNResults` is created in `foo`. The results folder will have another folder whose name will indicate to the user the list of parameters with which the run was instantiated. In this folder, upto **6 files** and **2 folders** will be created depending on which flags are set in `config.mk`:
120118
- **runInfo**: This file contains the hyperparameters and meta-information for the respective instantiation of ProtoNN. It also shows you the exact bash script call that was made, which is helpful for reproducing results purposes. Additionally, the training, testing accuracy and objective value at the end of each iteration is printed in a readable format. **This file is created at the end of the ProtoNN optimization.**
121119
- **W, B, Z**: These files contain the learnt parameter matrices $$W$$, $$B$$ and $$Z$$ in human-readable tsv format. The dimensions of storage are $$(d, D)$$, $$(d, m)$$ and $$(L, m)$$ respectively. **These files are created at the end of the ProtoNN optimization.**
122-
- **gamma**: This file contains a single number, the chosen value of $$\gamma$$, the RBF kernel parameter.
120+
- **gamma**: This file contains a single number, the chosen value of $$\gamma$$, the RBF kernel parameter. **This file is created at the end of the ProtoNN optimization.**
121+
- **diagnosticLog**: Created on using the `LOGGER` or `LIGHT_LOGGER` flags. This file stores logging information such as the call flow of ProtoNN and the min, max, norms of various matrices. This is mainly for debugging/optimization purposes and requires a more detailed understanding of the code to interpret. It may contain useful information if your code did not run as expected. **The diagnosticLog file is populated synchronously while the ProtoNN optimization is executing.**
122+
- **timerLog**: Created on using the `TIMER` flag. This file stores proc time and wall time taken to execute various function calls in the code. Indicates the degree of parallelization and is useful for identifying bottlenecks to optimize the code. On specifying the `CONCISE` flag, timing information will only be printed if running time is higher than a threshold specified in `src/common/timer.cpp`. **The timerLog file is populated synchronously while the ProtoNN optimization is executing.**
123+
- **dump**: A folder that is created on using the `DUMP` flag. The parameter matrices are outputted after each iteration in this folder. **This folder is populated synchronously while the ProtoNN optimization is executing.**
124+
- **verify**: A folder that is created on using the `VERIFY` flag. Code for backward verification with legacy Matlab code. **This folder is populated synchronously while the ProtoNN optimization is executing.**
123125

124126
The files **W, B, Z**, and **gamma** can be copied to `foo` to continue training of ProtoNN by initializing with these previously learned matrices. Use the **-P** option for this (see above). On doing so, the starting train/test accuracies should match the final accuracy as specified in the runInfo file.
125127

0 commit comments

Comments
 (0)