-
Notifications
You must be signed in to change notification settings - Fork 0
/
config.pm
434 lines (327 loc) · 15.9 KB
/
config.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
#
# CONFIG.PM - Lots of parameters for your tweaking pleasure.
#
#
# Copyright (C) 2005 Ryan R. Varick <rvarick@indiana.edu>
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation; either version 2 of
# the License, or (at your option) any later version.
#
#
# DESCRIPTION: These are all various parameters and values that
# can be tweaked throughout the program, I hope. This is due
# for a rewrite.
#
#
# Other files to include
#
# use Hardware; # TODO: Need an original name, updated calls
require 'hardware.pm'; # Core - HAL
require 'logging.pm'; # Core - data logging module
require 'utilities.pm'; # Core - miscellaneous functions
require 'fitness.pm'; # Core (should be extra)
require 'ga.pm'; # Core (should be extra)
# Experimental support for strict
use strict;
# ========== USER DEFINED VALUES ==========
#
# NOTE: Variables in this section can be tweaked to modify program behavior.
# The variables in the 'Internals' section are not meant to be modified.
# It just so happened that this file morphed into the central registry for
# all globals variables used by the program.
#
#
# NOTE: I didn't know Perl supported booleans at the time I started this
# monstrosity. I apologize for sucking at life.
#
our $NULL = -1;
our $TRUE = 1;
our $FALSE = 0;
# Program version
our $VERSION = '2.1.0-alpha1';
# ---------- Feedback control ----------
our $FEEDBACK = $TRUE; # Basic feedback, can be disabled for silent running
our $GA_FEEDBACK = $TRUE; # Extended feedback when running the GA
our $SHOW_TIPS = $TRUE; # Help messages for mistyped commands
our $show_prompt = $TRUE; # A basic prompt, you probably want this enabled
# ---------- Debugging control ----------
#
# NOTE: If you are debugging, you should probably set the population and generations
# low -- these will generate *a lot* of feedback to sift through.
#
our $DEBUG = $FALSE; # General debugging messages
our $DEBUG_COMM = $FALSE; # Communication specific debugging messages
our $DEBUG_LOGGING = $FALSE; # Logging specific debugging messages
our $DEBUG_GA = $FALSE; # GA specific debugging messages
our $TEST_MODE = $FALSE; # Disable communication with the EAC
# ---------- Logging parameters ----------
our $HELPFILE = 'docs/commands'; # Location of the quick help sheet
our $viewer = 'eog'; # Default image viewer (eog = "Eye of Gnome")
our $gnuplot = 'gnuplot'; # Path the gnuplot, a rather useless variable
our $datadir_prefix = 'dataset'; # Name of the directory logs are to be saved to --
our $datadir_seperator = '-'; # Multiple datasets are stored in sequentially numbered
our $datadir_base = '00'; # directories, modified by these variables
our $genotype_dir = 'genotypes'; # Directory used by the GA to store configurations
our $gradient_dir = 'gradients'; # Directory used to store voltage gradients
our $image_dir = 'images'; # Directory used to store plots of the voltage gradient
our $state_file = 'statefile'; # File used to store the current identifier
our $statistics_file = 'statsfile'; # File used to store the generational statistics
our $convergence_file = 'convergence'; # File used to store overall convergence statistics
our $generation_id_base = '01'; # The identifier is in the format of 00-000-000
our $genome_id_base = '001'; # The first number is the generation id, the second
our $gradient_id_base = '001'; # number is the genome id, and the third is the
our $id_seperator = '-'; # gradient id associated with that genome
our $reuse_last_datadir = $TRUE; # Whether to reuse the latest data directory or create
our $autoclean = $TRUE; # a new directory, and, if reusing, whether to reset first
our $use_zero_based_input = $FALSE; # Whether user interface input is 1-based --
# Internally, everything is 0-based, which is easy
# to forget about. This variable allows for a bit more
# intuitive operation, I think.
# ---------- Hardware parameters ----------
#
# NOTE: This turned out more complicated than I intended. This
# system of 'flags' is supposed to allow the program to be extended
# in the future as new hardware variations are added. These variables
# need to convey three things:
#
# 1) The HARDWARE details of the EAC.
# 2) The LOCATION of the EAC.
# 3) The PROTOCOL to use to communicate with the EAC.
#
# Unfortunately I didn't think this through enough so the final result
# is somewhat confusing. The first group of variables conveys (1), the
# second group of variables conveys (2), and the third conveys (3).
#
# Generally, when making decisions about the hardware, the protocol flag
# is tested (i.e., if($HARDWARE eq $EACV1) { ... } ). This is usually
# okay outside of hardware.pm, since the most important difference
# between the hardware versions is EAC vs. uEAC. I've tried to abstract
# the rest of the program such that the protocol differences, location,
# and hardware minutia (grid vs. radial, etc) are confined to hardware.pm.
#
# From the user's perspective, $HARDWARE conveys the essential
# information -- are we using one of the EACs? Or are we using one of
# the more flexible uEACs? Leave it to hardware.pm to figure out the
# the details.
#
our $EAC_FOAM = 'v1-foam'; # EAC (hardware v1) substrates --
our $EAC_SILICON = 'v1-silicon'; # foam (grid) and silicon (radial)
our $UEAC_NET = 'v2-net'; # uEAC (hardware v2) communication protocols --
our $UEAC_USB = 'v2-usb'; # net (network) and USB (virtual serial port)
our $default_foam_eac = 'eac4.cs.indiana.edu'; # Locations of various default EACs
our $default_silicon_eac = 'eac4.cs.indiana.edu';
our $default_usb_ueac = '/dev/ttyUSB0';
our $default_net_ueac = '';
our $EACV1 = $EAC_FOAM; # Protocol flags, what protocol to use with
our $EACV2 = $UEAC_USB; # each architecture -- EAC = EACV1, uEAC = EACV2
our $HARDWARE = $EACV1; # Default communication protocol
our $eac = $default_foam_eac; # Default machine to use
#
# Defaults specific to the EAC (hardware v1)
#
our $min_foam_current = 0; # Minimum and maximum amount of current the foam EACs
our $max_foam_current = 200; # should try to use
our $min_silicon_current = 0; # Minimum and maximum amount of current the silicon EACs
our $max_silicon_current = 1000; # should try to use
our $num_sources = 8; # Number of sources to index (1-based)
our $num_sinks = 8; # Number of sinks to index (1-based)
our $num_llas = 6; # Number of LLAs to index (1-based)
# NOTE: If you want to disable LLAs altogether, then
# you should set the use_llas variable below to FALSE
# FIXME
our $current_unit = 'uA';
#
# Defaults specific to the uEAC (hardware v2)
#
our $min_ueac_current = 0; # Minimum and maximum amount of current the
our $max_ueac_current = 200; # sources and sinks suppport
our $num_rows = 5; # Dimensions of the sheet (1-based)
our $num_cols = 5;
#
# Defaults shared by both hardware versions
#
our $min_lla = 1; # Inclusive bounds on the LLAs (DEPRICATED)
our $max_lla = 27; #
our $use_llas = $TRUE; # Whether to encode LLAs or not (used by the GA)
our $initial_current_scaling_value = 1; # During initialization, scale current by this value
our $current_precision = "%2.1f"; # Current precision (a sprintf mask)
our $voltage_precision = "%2.3f"; # Voltage precision (a sprintf mask)
our $reset_board = $FALSE; # Whether to reset the board before each GA evaluation
our $num_report_samples = 1; # Number of times to sample when reporting the gradient
# ---------- Genetic Algorithm Parameters ----------
#
# General parameters
#
our $population_size = 5; # Number of genomes in the population
our $num_generations = 2; # Number of populations to evaluate
# NOTE: The GA will stop regardless if the fitness
# threshold is met (see below).
our $non_coding_probability = 0.5; # Probability that a gene will not encode anything
# (used during initialization)
our $fitness_threshold = 100.0; # What constitutes a 'good enough' genome
our $fitness_format = "%4.3f"; # Fitness precision (a sprintf mask)
our $min_fitness = 0.0; # Lower bound on fitness (internal)
our $max_fitness = 100.0; # Upper bound on fitness (internal)
#
# Breeding parameters
#
our $num_elites = 1; # Number of elites genomes to select before breeding
our $use_tournament_selection = $TRUE; # Whether to use tournament selection during breeding,
our $num_tournament_opponents = 2; # and the number of genomes to compete against
our $use_crossover = $TRUE;
our $num_crossover_points = 3; # FIXME: Should this 0-based, and not broken
our $min_crossover_length = 2; # Minimum number of genes that a crossover region must have
our $max_crossover_length = 10; # Maximum number of genes that a crossover region may have
#
# Mutation parameters
#
our $mutation_rate = 0.0; # Frequency at which mutation should occur
our $noise_mutation_rate = 0.0; # When mutating, frequency at which mutation simply adds
# noise. This works on the principle that mutation may
# be too coarse to hone in on the best solution -- that
# ultimately the GA should be able to explore solutions around
# a specific point