Skip to content

Commit 024d5d0

Browse files
committed
updating std_conf.h doc
1 parent 2ed5331 commit 024d5d0

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

std_conf.h

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,22 +42,23 @@
4242

4343
#define STATEFUL 1
4444

45-
// #define INTERLAYER_SIGMOID_ACTIVATION
46-
4745
#define GRADIENTS_CLIP 1
4846
#define GRADIENTS_FIT 0
4947

5048
#define MODEL_REGULARIZE 0
5149

5250
#define DECREASE_LR 0 // set to 0 to disable decreasing learning rate
5351

54-
// #define DEBUG_PRINT
55-
5652
#define STD_LEARNING_RATE_DECREASE 100000
5753
#define STD_LEARNING_RATE_THRESHOLD 10000
5854
#define STD_NUMBER_OF_NO_RECORD_ITERATIONS_UNTIL_LR_DECREASE 1000000
5955

60-
// #define STORE_DURING_TRANING
56+
/*
57+
* These defines modify how the program interacts with the user
58+
* of the program during the training phase. Here you can
59+
* decide how often it should output its progress and wether or not
60+
* it should write to file among other things.
61+
*/
6162
#define PRINT_EVERY_X_ITERATIONS 100
6263
#define STORE_EVERY_X_ITERATIONS 8000
6364
#define PRINT_PROGRESS 1 // set to 0 to disable printing
@@ -67,13 +68,24 @@
6768
#define PRINT_SAMPLE_OUTPUT_TO_FILE_NAME "progress_output.txt" // name of the file containing samples
6869
#define STORE_PROGRESS_EVERY_X_ITERATIONS 1000 // set to 0 to disable writing loss value to file during training
6970
#define PROGRESS_FILE_NAME "progress.csv"
70-
7171
#define NUMBER_OF_CHARS_TO_DISPLAY_DURING_TRAINING 200
7272

73+
/*
74+
* Once the network has been trained it is stored to these files.
75+
* The .net extenction is not to be confused with microsoft,
76+
* it is just an extension i picked that alludes to it being
77+
* a 'network' in its rawest form. It can be parsed by the program
78+
* but not by the interactive HTML application.
79+
* For that, the .json program is intended to be used.
80+
*/
7381
#define STD_LOADABLE_NET_NAME "lstm_net.net"
7482
#define STD_JSON_NET_NAME "lstm_net.json"
7583

84+
// ================== DO NOT CHANGE THE FOLLOWING DEFINES ======================
85+
// Don't change this one, else the HTML application will not work.
7686
#define JSON_KEY_NAME_SET "Feature mapping"
77-
87+
// This define should be undeffed, it was defined during experimentation
88+
// #define INTERLAYER_SIGMOID_ACTIVATION
89+
// =============================================================================
7890

7991
#endif

0 commit comments

Comments
 (0)