/
sir.go
1553 lines (1387 loc) · 53.4 KB
/
sir.go
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
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) 2019, The Emergent Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
/*
sir illustrates the dynamic gating of information into PFC active maintenance, by the basal ganglia (BG). It uses a simple Store-Ignore-Recall (SIR) task, where the BG system learns via phasic dopamine signals and trial-and-error exploration, discovering what needs to be stored, ignored, and recalled as a function of reinforcement of correct behavior, and learned reinforcement of useful working memory representations.
*/
package main
import (
"flag"
"fmt"
"log"
"math"
"math/rand"
"os"
"strconv"
"strings"
"time"
"github.com/emer/emergent/emer"
"github.com/emer/emergent/env"
"github.com/emer/emergent/netview"
"github.com/emer/emergent/params"
"github.com/emer/emergent/prjn"
"github.com/emer/emergent/relpos"
"github.com/emer/etable/agg"
"github.com/emer/etable/eplot"
"github.com/emer/etable/etable"
"github.com/emer/etable/etensor"
"github.com/emer/etable/etview" // include to get gui views
"github.com/emer/etable/simat"
"github.com/emer/etable/split"
"github.com/emer/leabra/leabra"
"github.com/emer/leabra/pbwm"
"github.com/emer/leabra/rl"
"github.com/goki/gi/gi"
"github.com/goki/gi/gimain"
"github.com/goki/gi/giv"
"github.com/goki/ki/ki"
"github.com/goki/ki/kit"
"github.com/goki/mat32"
)
func main() {
TheSim.New()
TheSim.Config()
if len(os.Args) > 1 {
TheSim.CmdArgs() // simple assumption is that any args = no gui -- could add explicit arg if you want
} else {
gimain.Main(func() { // this starts gui -- requires valid OpenGL display connection (e.g., X11)
guirun()
})
}
}
func guirun() {
TheSim.Init()
win := TheSim.ConfigGui()
win.StartEventLoop()
}
// LogPrec is precision for saving float values in logs
const LogPrec = 4
// ParamSets is the default set of parameters -- Base is always applied, and others can be optionally
// selected to apply on top of that
var ParamSets = params.Sets{
{Name: "Base", Desc: "these are the best params", Sheets: params.Sheets{
"Network": ¶ms.Sheet{
{Sel: "Prjn", Desc: "no extra learning factors",
Params: params.Params{
"Prjn.Learn.Lrate": "0.02", // slower overall is key
"Prjn.Learn.Norm.On": "false",
"Prjn.Learn.Momentum.On": "false",
"Prjn.Learn.WtBal.On": "false",
}},
{Sel: "Layer", Desc: "no decay",
Params: params.Params{
"Layer.Act.Init.Decay": "0", // key for all layers not otherwise done automatically
}},
{Sel: ".Back", Desc: "top-down back-projections MUST have lower relative weight scale, otherwise network hallucinates",
Params: params.Params{
"Prjn.WtScale.Rel": "0.2",
}},
{Sel: ".BgFixed", Desc: "BG Matrix -> GP wiring",
Params: params.Params{
"Prjn.Learn.Learn": "false",
"Prjn.WtInit.Mean": "0.8",
"Prjn.WtInit.Var": "0",
"Prjn.WtInit.Sym": "false",
}},
{Sel: "RWPrjn", Desc: "Reward prediction -- into PVi",
Params: params.Params{
"Prjn.Learn.Lrate": "0.02",
"Prjn.WtInit.Mean": "0",
"Prjn.WtInit.Var": "0",
"Prjn.WtInit.Sym": "false",
}},
{Sel: "#Rew", Desc: "Reward layer -- no clamp limits",
Params: params.Params{
"Layer.Act.Clamp.Range.Min": "-1",
"Layer.Act.Clamp.Range.Max": "1",
}},
{Sel: ".PFCFmDeep", Desc: "PFC Deep -> PFC fixed",
Params: params.Params{
"Prjn.Learn.Learn": "false",
"Prjn.WtInit.Mean": "0.8",
"Prjn.WtInit.Var": "0",
"Prjn.WtInit.Sym": "false",
}},
{Sel: ".PFCMntDToOut", Desc: "PFC MntD -> PFC Out fixed",
Params: params.Params{
"Prjn.Learn.Learn": "false",
"Prjn.WtInit.Mean": "0.8",
"Prjn.WtInit.Var": "0",
"Prjn.WtInit.Sym": "false",
}},
{Sel: ".FmPFCOutD", Desc: "If multiple stripes, PFC OutD needs to be strong b/c avg act says weak",
Params: params.Params{
"Prjn.WtScale.Abs": "1", // increase in proportion to number of stripes
}},
{Sel: ".PFCFixed", Desc: "Input -> PFC",
Params: params.Params{
"Prjn.Learn.Learn": "false",
"Prjn.WtInit.Mean": "0.8",
"Prjn.WtInit.Var": "0",
"Prjn.WtInit.Sym": "false",
}},
{Sel: ".MatrixPrjn", Desc: "Matrix learning",
Params: params.Params{
"Prjn.Learn.Lrate": "0.04", // .04 > .1
"Prjn.WtInit.Var": "0.1",
"Prjn.Trace.GateNoGoPosLR": "1", // 0.1 default
"Prjn.Trace.NotGatedLR": "0.7", // 0.7 default
"Prjn.Trace.Decay": "1.0", // 1.0 default
"Prjn.Trace.AChDecay": "0.0", // not useful even at .1, surprising..
"Prjn.Trace.Deriv": "true", // true default, better than false
}},
{Sel: "MatrixLayer", Desc: "exploring these options",
Params: params.Params{
"Layer.Act.XX1.Gain": "100",
"Layer.Inhib.Layer.Gi": "1.9",
"Layer.Inhib.Layer.FB": "0.5",
"Layer.Inhib.Pool.On": "true",
"Layer.Inhib.Pool.Gi": "2.1", // def 1.9
"Layer.Inhib.Pool.FB": "0",
"Layer.Inhib.Self.On": "true",
"Layer.Inhib.Self.Gi": "0.4", // def 0.3
"Layer.Inhib.ActAvg.Init": "0.05",
"Layer.Inhib.ActAvg.Fixed": "true",
}},
{Sel: "#GPiThal", Desc: "defaults also set automatically by layer but included here just to be sure",
Params: params.Params{
"Layer.Inhib.Layer.Gi": "1.8",
"Layer.Inhib.Layer.FB": "1", // was 0.5
"Layer.Inhib.Pool.On": "false",
"Layer.Inhib.ActAvg.Init": ".2",
"Layer.Inhib.ActAvg.Fixed": "true",
"Layer.Act.Dt.GTau": "3",
"Layer.Gate.GeGain": "3",
"Layer.Gate.NoGo": "1", // 1.25?
"Layer.Gate.Thr": "0.2", // 0.25?
}},
{Sel: "#GPeNoGo", Desc: "GPe is a regular layer -- needs special params",
Params: params.Params{
"Layer.Inhib.Layer.Gi": "2.4", // 2.4 > 2.2 > 1.8
"Layer.Inhib.Layer.FB": "0.5",
"Layer.Inhib.Layer.FBTau": "3", // otherwise a bit jumpy
"Layer.Inhib.Pool.On": "false",
"Layer.Inhib.ActAvg.Init": ".2",
"Layer.Inhib.ActAvg.Fixed": "true",
}},
{Sel: ".PFC", Desc: "pfc defaults",
Params: params.Params{
"Layer.Inhib.Layer.On": "false",
"Layer.Inhib.Pool.On": "true",
"Layer.Inhib.Pool.Gi": "1.8",
"Layer.Inhib.Pool.FB": "1",
"Layer.Inhib.ActAvg.Init": "0.2",
"Layer.Inhib.ActAvg.Fixed": "true",
}},
{Sel: "#Input", Desc: "Basic params",
Params: params.Params{
"Layer.Inhib.ActAvg.Init": "0.25",
"Layer.Inhib.ActAvg.Fixed": "true",
}},
{Sel: "#Output", Desc: "Basic params",
Params: params.Params{
"Layer.Inhib.Layer.Gi": "2",
"Layer.Inhib.Layer.FB": "0.5",
"Layer.Inhib.ActAvg.Init": "0.25",
"Layer.Inhib.ActAvg.Fixed": "true",
}},
{Sel: "#InputToOutput", Desc: "weaker",
Params: params.Params{
"Prjn.WtScale.Rel": "0.5",
}},
{Sel: "#Hidden", Desc: "Basic params",
Params: params.Params{
"Layer.Inhib.Layer.Gi": "2",
"Layer.Inhib.Layer.FB": "0.5",
}},
{Sel: "#SNc", Desc: "allow negative",
Params: params.Params{
"Layer.Act.Clamp.Range.Min": "-1",
"Layer.Act.Clamp.Range.Max": "1",
}},
{Sel: "#RWPred", Desc: "keep it guessing",
Params: params.Params{
"Layer.PredRange.Min": "0.01", // increasing to .05, .95 can be useful for harder tasks
"Layer.PredRange.Max": "0.99",
}},
},
}},
}
// Sim encapsulates the entire simulation model, and we define all the
// functionality as methods on this struct. This structure keeps all relevant
// state information organized and available without having to pass everything around
// as arguments to methods, and provides the core GUI interface (note the view tags
// for the fields which provide hints to how things should be displayed).
type Sim struct {
BurstDaGain float32 `desc:"strength of dopamine bursts: 1 default -- reduce for PD OFF, increase for PD ON"`
DipDaGain float32 `desc:"strength of dopamine dips: 1 default -- reduce to siulate D2 agonists"`
Net *pbwm.Network `view:"no-inline" desc:"the network -- click to view / edit parameters for layers, prjns, etc"`
TrnEpcLog *etable.Table `view:"no-inline" desc:"training epoch-level log data"`
TstEpcLog *etable.Table `view:"no-inline" desc:"testing epoch-level log data"`
TstTrlLog *etable.Table `view:"no-inline" desc:"testing trial-level log data"`
RunLog *etable.Table `view:"no-inline" desc:"summary log of each run"`
RunStats *etable.Table `view:"no-inline" desc:"aggregate stats on all runs"`
SimMat *simat.SimMat `view:"no-inline" desc:"similarity matrix"`
Params params.Sets `view:"no-inline" desc:"full collection of param sets"`
ParamSet string `desc:"which set of *additional* parameters to use -- always applies Base and optionaly this next if set -- can use multiple names separated by spaces (don't put spaces in ParamSet names!)"`
Tag string `desc:"extra tag string to add to any file names output from sim (e.g., weights files, log files, params for run)"`
MaxRuns int `desc:"maximum number of model runs to perform"`
MaxEpcs int `desc:"maximum number of epochs to run per model run"`
MaxTrls int `desc:"maximum number of training trials per epoch"`
NZeroStop int `desc:"if a positive number, training will stop after this many epochs with zero SSE"`
TrainEnv SIREnv `desc:"Training environment -- SIR environment"`
TestEnv SIREnv `desc:"Testing nvironment -- SIR environment"`
Time leabra.Time `desc:"leabra timing parameters and state"`
ViewOn bool `desc:"whether to update the network view while running"`
TrainUpdt leabra.TimeScales `desc:"at what time scale to update the display during training? Anything longer than Epoch updates at Epoch in this model"`
TestUpdt leabra.TimeScales `desc:"at what time scale to update the display during testing? Anything longer than Epoch updates at Epoch in this model"`
TstRecLays []string `desc:"names of layers to record activations etc of during testing"`
TrlDA float64 `inactive:"+" desc:"dopamine level on this trial"`
TrlAbsDA float64 `inactive:"+" desc:"absolute value of dopamine on this trial"`
TrlRewPred float64 `inactive:"+" desc:"reward prediction level on this trial"`
TrlErr float64 `inactive:"+" desc:"1 if trial was error, 0 if correct -- based on SSE = 0 (subject to .5 unit-wise tolerance)"`
TrlSSE float64 `inactive:"+" desc:"current trial's sum squared error"`
TrlAvgSSE float64 `inactive:"+" desc:"current trial's average sum squared error"`
TrlCosDiff float64 `inactive:"+" desc:"current trial's cosine difference"`
EpcDA float64 `inactive:"+" desc:"last epoch's average dopamine"`
EpcAbsDA float64 `inactive:"+" desc:"last epoch's avg abs dopamine"`
EpcRewPred float64 `inactive:"+" desc:"last epoch's avg rew pred dopamine"`
EpcSSE float64 `inactive:"+" desc:"last epoch's total sum squared error"`
EpcAvgSSE float64 `inactive:"+" desc:"last epoch's average sum squared error (average over trials, and over units within layer)"`
EpcPctErr float64 `inactive:"+" desc:"last epoch's average TrlErr"`
EpcPctCor float64 `inactive:"+" desc:"1 - last epoch's average TrlErr"`
EpcCosDiff float64 `inactive:"+" desc:"last epoch's average cosine difference for output layer (a normalized error measure, maximum of 1 when the minus phase exactly matches the plus)"`
EpcPerTrlMSec float64 `inactive:"+" desc:"how long did the epoch take per trial in wall-clock milliseconds"`
FirstZero int `inactive:"+" desc:"epoch at when SSE first went to zero"`
NZero int `inactive:"+" desc:"number of epochs in a row with zero SSE"`
// internal state - view:"-"
SumDA float64 `view:"-" inactive:"+" desc:"sum to increment as we go through epoch"`
SumAbsDA float64 `view:"-" inactive:"+" desc:"sum to increment as we go through epoch"`
SumRewPred float64 `view:"-" inactive:"+" desc:"sum to increment as we go through epoch"`
SumErr float64 `view:"-" inactive:"+" desc:"sum to increment as we go through epoch"`
SumSSE float64 `view:"-" inactive:"+" desc:"sum to increment as we go through epoch"`
SumAvgSSE float64 `view:"-" inactive:"+" desc:"sum to increment as we go through epoch"`
SumCosDiff float64 `view:"-" inactive:"+" desc:"sum to increment as we go through epoch"`
Win *gi.Window `view:"-" desc:"main GUI window"`
NetView *netview.NetView `view:"-" desc:"the network viewer"`
ToolBar *gi.ToolBar `view:"-" desc:"the master toolbar"`
WtsGrid *etview.TensorGrid `view:"-" desc:"the weights grid view"`
TrnEpcPlot *eplot.Plot2D `view:"-" desc:"the training epoch plot"`
TstEpcPlot *eplot.Plot2D `view:"-" desc:"the testing epoch plot"`
TstTrlPlot *eplot.Plot2D `view:"-" desc:"the test-trial plot"`
RunPlot *eplot.Plot2D `view:"-" desc:"the run plot"`
TrnEpcFile *os.File `view:"-" desc:"log file"`
RunFile *os.File `view:"-" desc:"log file"`
ValsTsrs map[string]*etensor.Float32 `view:"-" desc:"for holding layer values"`
SaveWts bool `view:"-" desc:"for command-line run only, auto-save final weights after each run"`
NoGui bool `view:"-" desc:"if true, runing in no GUI mode"`
LogSetParams bool `view:"-" desc:"if true, print message for all params that are set"`
IsRunning bool `view:"-" desc:"true if sim is running"`
StopNow bool `view:"-" desc:"flag to stop running"`
NeedsNewRun bool `view:"-" desc:"flag to initialize NewRun if last one finished"`
RndSeed int64 `view:"-" desc:"the current random seed"`
LastEpcTime time.Time `view:"-" desc:"timer for last epoch"`
}
// this registers this Sim Type and gives it properties that e.g.,
// prompt for filename for save methods.
var KiT_Sim = kit.Types.AddType(&Sim{}, SimProps)
// TheSim is the overall state for this simulation
var TheSim Sim
// New creates new blank elements and initializes defaults
func (ss *Sim) New() {
ss.Net = &pbwm.Network{}
ss.TrnEpcLog = &etable.Table{}
ss.TstEpcLog = &etable.Table{}
ss.TstTrlLog = &etable.Table{}
ss.RunLog = &etable.Table{}
ss.RunStats = &etable.Table{}
ss.SimMat = &simat.SimMat{}
ss.Params = ParamSets
ss.RndSeed = 1
ss.ViewOn = true
ss.TrainUpdt = leabra.AlphaCycle //leabra.AlphaCycle
ss.TestUpdt = leabra.AlphaCycle
ss.TstRecLays = []string{"Input", "Output", "GPiThal", "PFCmntD", "PFCoutD"}
ss.Defaults()
}
func (ss *Sim) Defaults() {
ss.BurstDaGain = 1
ss.DipDaGain = 1
}
////////////////////////////////////////////////////////////////////////////////////////////
// Configs
// Config configures all the elements using the standard functions
func (ss *Sim) Config() {
ss.ConfigEnv()
ss.ConfigNet(ss.Net)
ss.ConfigTrnEpcLog(ss.TrnEpcLog)
ss.ConfigTstEpcLog(ss.TstEpcLog)
ss.ConfigTstTrlLog(ss.TstTrlLog)
ss.ConfigRunLog(ss.RunLog)
}
func (ss *Sim) ConfigEnv() {
if ss.MaxRuns == 0 { // allow user override
ss.MaxRuns = 10
}
if ss.MaxEpcs == 0 { // allow user override
ss.MaxEpcs = 100
ss.NZeroStop = 5
}
if ss.MaxTrls == 0 { // allow user override
ss.MaxTrls = 100
}
ss.TrainEnv.Nm = "TrainEnv"
ss.TrainEnv.Dsc = "training params and state"
ss.TrainEnv.SetNStim(4)
ss.TrainEnv.RewVal = 1
ss.TrainEnv.NoRewVal = 0
ss.TrainEnv.Validate()
ss.TrainEnv.Run.Max = ss.MaxRuns // note: we are not setting epoch max -- do that manually
ss.TrainEnv.Trial.Max = ss.MaxTrls
ss.TestEnv.Nm = "TestEnv"
ss.TestEnv.Dsc = "testing params and state"
ss.TestEnv.SetNStim(4)
ss.TestEnv.RewVal = 1
ss.TestEnv.NoRewVal = 0
ss.TestEnv.Validate()
ss.TestEnv.Run.Max = ss.MaxRuns // note: we are not setting epoch max -- do that manually
ss.TestEnv.Trial.Max = 20 // good amount for testing
ss.TrainEnv.Init(0)
ss.TestEnv.Init(0)
}
func (ss *Sim) ConfigNet(net *pbwm.Network) {
net.InitName(net, "SIR")
rew, rp, da := rl.AddRWLayers(&net.Network, "", relpos.Behind, 2)
snc := da.(*rl.RWDaLayer)
snc.SetName("SNc")
inp := net.AddLayer2D("Input", 1, 4, emer.Input)
ctrl := net.AddLayer2D("CtrlInput", 1, 3, emer.Input)
out := net.AddLayer2D("Output", 1, 4, emer.Target)
hid := net.AddLayer2D("Hidden", 7, 7, emer.Hidden)
inp.SetRelPos(relpos.Rel{Rel: relpos.Above, Other: rew.Name(), YAlign: relpos.Front, XAlign: relpos.Left})
out.SetRelPos(relpos.Rel{Rel: relpos.RightOf, Other: "Input", YAlign: relpos.Front, Space: 1})
ctrl.SetRelPos(relpos.Rel{Rel: relpos.Behind, Other: "Input", XAlign: relpos.Left, Space: 2})
hid.SetRelPos(relpos.Rel{Rel: relpos.Behind, Other: "CtrlInput", XAlign: relpos.Left, Space: 2})
// args: nY, nMaint, nOut, nNeurBgY, nNeurBgX, nNeurPfcY, nNeurPfcX
mtxGo, mtxNoGo, gpe, gpi, cini, pfcMnt, pfcMntD, pfcOut, pfcOutD := net.AddPBWM("", 1, 1, 1, 1, 3, 1, 4)
_ = gpe
_ = gpi
_ = pfcMnt
_ = pfcMntD
_ = pfcOut
cin := cini.(*pbwm.CINLayer)
cin.RewLays.Add(rew.Name(), rp.Name())
mtxGo.SetRelPos(relpos.Rel{Rel: relpos.RightOf, Other: "Rew", YAlign: relpos.Front, Space: 14})
full := prjn.NewFull()
fmin := prjn.NewRect()
fmin.Size.Set(1, 1)
fmin.Scale.Set(1, 1)
fmin.Wrap = true
net.ConnectLayersPrjn(ctrl, rp, full, emer.Forward, &rl.RWPrjn{})
net.ConnectLayersPrjn(pfcMntD, rp, full, emer.Forward, &rl.RWPrjn{})
net.ConnectLayersPrjn(pfcOutD, rp, full, emer.Forward, &rl.RWPrjn{})
pj := net.ConnectLayersPrjn(ctrl, mtxGo, fmin, emer.Forward, &pbwm.MatrixTracePrjn{})
pj.SetClass("MatrixPrjn")
pj = net.ConnectLayersPrjn(ctrl, mtxNoGo, fmin, emer.Forward, &pbwm.MatrixTracePrjn{})
pj.SetClass("MatrixPrjn")
pj = net.ConnectLayers(inp, pfcMnt, fmin, emer.Forward)
pj.SetClass("PFCFixed")
net.ConnectLayers(inp, hid, full, emer.Forward)
net.BidirConnectLayers(hid, out, full)
pj = net.ConnectLayers(pfcOutD, hid, full, emer.Forward)
pj.SetClass("FmPFCOutD")
pj = net.ConnectLayers(pfcOutD, out, full, emer.Forward)
pj.SetClass("FmPFCOutD")
net.ConnectLayers(inp, out, full, emer.Forward)
snc.SendDA.AddAllBut(net) // send dopamine to all layers..
net.Defaults()
ss.SetParams("Network", false) // only set Network params
err := net.Build()
if err != nil {
log.Println(err)
return
}
net.InitWts()
}
////////////////////////////////////////////////////////////////////////////////
// Init, utils
// Init restarts the run, and initializes everything, including network weights
// and resets the epoch log table
func (ss *Sim) Init() {
rand.Seed(ss.RndSeed)
ss.StopNow = false
ss.SetParams("", false) // all sheets
ss.NewRun()
ss.UpdateView(true, -1)
if ss.NetView != nil && ss.NetView.IsVisible() {
ss.NetView.RecordSyns()
}
}
// NewRndSeed gets a new random seed based on current time -- otherwise uses
// the same random seed for every run
func (ss *Sim) NewRndSeed() {
ss.RndSeed = time.Now().UnixNano()
}
// Counters returns a string of the current counter state
// use tabs to achieve a reasonable formatting overall
// and add a few tabs at the end to allow for expansion..
func (ss *Sim) Counters(train bool) string {
if train {
return fmt.Sprintf("Run:\t%d\tEpoch:\t%d\tTrial:\t%d\tCycle:\t%d\tName:\t%s\t\t\t", ss.TrainEnv.Run.Cur, ss.TrainEnv.Epoch.Cur, ss.TrainEnv.Trial.Cur, ss.Time.Cycle, ss.TrainEnv.String())
} else {
return fmt.Sprintf("Run:\t%d\tEpoch:\t%d\tTrial:\t%d\tCycle:\t%d\tName:\t%s\t\t\t", ss.TrainEnv.Run.Cur, ss.TrainEnv.Epoch.Cur, ss.TestEnv.Trial.Cur, ss.Time.Cycle, ss.TestEnv.String())
}
}
func (ss *Sim) UpdateView(train bool, cyc int) {
if ss.NetView != nil && ss.NetView.IsVisible() {
ss.NetView.Record(ss.Counters(train), cyc)
// note: essential to use Go version of update when called from another goroutine
ss.NetView.GoUpdate() // note: using counters is significantly slower..
}
}
////////////////////////////////////////////////////////////////////////////////
// Running the Network, starting bottom-up..
// AlphaCyc runs one alpha-cycle (100 msec, 4 quarters) of processing.
// External inputs must have already been applied prior to calling,
// using ApplyExt method on relevant layers (see TrainTrial, TestTrial).
// If train is true, then learning DWt or WtFmDWt calls are made.
// Handles netview updating within scope of AlphaCycle
func (ss *Sim) AlphaCyc(train bool) {
// ss.Win.PollEvents() // this can be used instead of running in a separate goroutine
viewUpdt := ss.TrainUpdt
if !train {
viewUpdt = ss.TestUpdt
}
ss.Net.AlphaCycInit(train)
ss.Time.AlphaCycStart()
for qtr := 0; qtr < 4; qtr++ {
for cyc := 0; cyc < ss.Time.CycPerQtr; cyc++ {
ss.Net.Cycle(&ss.Time)
ss.Time.CycleInc()
if ss.ViewOn {
switch viewUpdt {
case leabra.Cycle:
if cyc != ss.Time.CycPerQtr-1 { // will be updated by quarter
ss.UpdateView(train, ss.Time.Cycle)
}
case leabra.FastSpike:
if (cyc+1)%10 == 0 {
ss.UpdateView(train, -1)
}
}
}
}
ss.Net.QuarterFinal(&ss.Time)
ss.Time.QuarterInc()
if ss.ViewOn {
switch {
case viewUpdt == leabra.Cycle:
ss.UpdateView(train, ss.Time.Cycle)
case viewUpdt <= leabra.Quarter:
ss.UpdateView(train, -1)
case viewUpdt == leabra.Phase:
if qtr >= 2 {
ss.UpdateView(train, -1)
}
}
}
if qtr == 2 {
ss.ApplyReward(train)
}
}
if train {
ss.Net.DWt()
if ss.NetView != nil && ss.NetView.IsVisible() {
ss.NetView.RecordSyns()
}
ss.Net.WtFmDWt()
}
if ss.ViewOn && viewUpdt == leabra.AlphaCycle {
ss.UpdateView(train, -1)
}
}
// ApplyInputs applies input patterns from given envirbonment.
// It is good practice to have this be a separate method with appropriate
// args so that it can be used for various different contexts
// (training, testing, etc).
func (ss *Sim) ApplyInputs(en env.Env) {
ss.Net.InitExt() // clear any existing inputs -- not strictly necessary if always
// going to the same layers, but good practice and cheap anyway
lays := []string{"Input", "CtrlInput", "Output"}
for _, lnm := range lays {
ly := ss.Net.LayerByName(lnm).(leabra.LeabraLayer).AsLeabra()
pats := en.State(ly.Nm)
if pats == nil {
continue
}
ly.ApplyExt(pats)
}
}
// ApplyReward computes reward based on network output and applies it -- call
// at start of 3rd quarter (plus phase)
func (ss *Sim) ApplyReward(train bool) {
var en *SIREnv
if train {
en = &ss.TrainEnv
} else {
en = &ss.TestEnv
}
if en.Act != Recall { // only reward on recall trials!
return
}
out := ss.Net.LayerByName("Output").(leabra.LeabraLayer).AsLeabra()
mxi := out.Pools[0].Inhib.Act.MaxIdx
en.SetReward(mxi)
pats := en.State("Reward")
ly := ss.Net.LayerByName("Rew").(leabra.LeabraLayer).AsLeabra()
ly.ApplyExt1DTsr(pats)
}
// TrainTrial runs one trial of training using TrainEnv
func (ss *Sim) TrainTrial() {
if ss.NeedsNewRun {
ss.NewRun()
}
ss.TrainEnv.Step() // the Env encapsulates and manages all counter state
// Key to query counters FIRST because current state is in NEXT epoch
// if epoch counter has changed
epc, _, chg := ss.TrainEnv.Counter(env.Epoch)
if chg {
if ss.ViewOn && ss.TrainUpdt > leabra.AlphaCycle {
ss.UpdateView(true, -1)
}
ss.LogTrnEpc(ss.TrnEpcLog)
if ss.ViewOn && ss.TrainUpdt > leabra.AlphaCycle {
ss.UpdateView(true, -1)
}
if epc >= ss.MaxEpcs || (ss.NZeroStop > 0 && ss.NZero >= ss.NZeroStop) {
// done with training..
ss.RunEnd()
if ss.TrainEnv.Run.Incr() { // we are done!
ss.StopNow = true
return
} else {
ss.NeedsNewRun = true
return
}
}
}
ss.ApplyInputs(&ss.TrainEnv)
ss.AlphaCyc(true) // train
ss.TrialStats(true) // accumulate
}
// RunEnd is called at the end of a run -- save weights, record final log, etc here
func (ss *Sim) RunEnd() {
ss.LogRun(ss.RunLog)
}
// NewRun intializes a new run of the model, using the TrainEnv.Run counter
// for the new run value
func (ss *Sim) NewRun() {
run := ss.TrainEnv.Run.Cur
ss.TrainEnv.Init(run)
ss.Time.Reset()
ss.Net.InitWts()
ss.InitStats()
ss.TrnEpcLog.SetNumRows(0)
ss.TstEpcLog.SetNumRows(0)
ss.NeedsNewRun = false
}
// InitStats initializes all the statistics, especially important for the
// cumulative epoch stats -- called at start of new run
func (ss *Sim) InitStats() {
// accumulators
ss.SumDA = 0
ss.SumAbsDA = 0
ss.SumRewPred = 0
ss.SumSSE = 0
ss.SumAvgSSE = 0
ss.SumCosDiff = 0
ss.SumErr = 0
ss.FirstZero = -1
ss.NZero = 0
// clear rest just to make Sim look initialized
ss.TrlDA = 0
ss.TrlAbsDA = 0
ss.TrlRewPred = 0
ss.TrlErr = 0
ss.TrlSSE = 0
ss.TrlAvgSSE = 0
ss.EpcDA = 0
ss.EpcAbsDA = 0
ss.EpcRewPred = 0
ss.EpcSSE = 0
ss.EpcAvgSSE = 0
ss.EpcPctErr = 0
ss.EpcCosDiff = 0
}
// TrialStats computes the trial-level statistics and adds them to the epoch accumulators if
// accum is true. Note that we're accumulating stats here on the Sim side so the
// core algorithm side remains as simple as possible, and doesn't need to worry about
// different time-scales over which stats could be accumulated etc.
// You can also aggregate directly from log data, as is done for testing stats
func (ss *Sim) TrialStats(accum bool) (sse, avgsse, cosdiff float64) {
out := ss.Net.LayerByName("Output").(leabra.LeabraLayer).AsLeabra()
snc := ss.Net.LayerByName("SNc").(leabra.LeabraLayer).AsLeabra()
rp := ss.Net.LayerByName("RWPred").(leabra.LeabraLayer).AsLeabra()
ss.TrlDA = float64(snc.Neurons[0].Act)
ss.TrlAbsDA = math.Abs(ss.TrlDA)
ss.TrlRewPred = float64(rp.Neurons[0].Act)
ss.TrlCosDiff = float64(out.CosDiff.Cos)
ss.TrlSSE, ss.TrlAvgSSE = out.MSE(0.5) // 0.5 = per-unit tolerance -- right side of .5
if ss.TrlSSE > 0 {
ss.TrlErr = 1
} else {
ss.TrlErr = 0
}
if accum {
ss.SumDA += ss.TrlDA
ss.SumAbsDA += ss.TrlAbsDA
ss.SumRewPred += ss.TrlRewPred
ss.SumErr += ss.TrlErr
ss.SumSSE += ss.TrlSSE
ss.SumAvgSSE += ss.TrlAvgSSE
ss.SumCosDiff += ss.TrlCosDiff
}
return
}
// TrainEpoch runs training trials for remainder of this epoch
func (ss *Sim) TrainEpoch() {
ss.StopNow = false
curEpc := ss.TrainEnv.Epoch.Cur
for {
ss.TrainTrial()
if ss.StopNow || ss.TrainEnv.Epoch.Cur != curEpc {
break
}
}
ss.Stopped()
}
// TrainRun runs training trials for remainder of run
func (ss *Sim) TrainRun() {
ss.StopNow = false
curRun := ss.TrainEnv.Run.Cur
for {
ss.TrainTrial()
if ss.StopNow || ss.TrainEnv.Run.Cur != curRun {
break
}
}
ss.Stopped()
}
// Train runs the full training from this point onward
func (ss *Sim) Train() {
ss.StopNow = false
for {
ss.TrainTrial()
if ss.StopNow {
break
}
}
ss.Stopped()
}
// Stop tells the sim to stop running
func (ss *Sim) Stop() {
ss.StopNow = true
}
// Stopped is called when a run method stops running -- updates the IsRunning flag and toolbar
func (ss *Sim) Stopped() {
ss.IsRunning = false
if ss.Win != nil {
vp := ss.Win.WinViewport2D()
if ss.ToolBar != nil {
ss.ToolBar.UpdateActions()
}
vp.SetNeedsFullRender()
}
}
// SaveWeights saves the network weights -- when called with giv.CallMethod
// it will auto-prompt for filename
func (ss *Sim) SaveWeights(filename gi.FileName) {
ss.Net.SaveWtsJSON(filename)
}
////////////////////////////////////////////////////////////////////////////////////////////
// Testing
// TestTrial runs one trial of testing -- always sequentially presented inputs
func (ss *Sim) TestTrial(returnOnChg bool) {
ss.TestEnv.Step()
// Query counters FIRST
_, _, chg := ss.TestEnv.Counter(env.Epoch)
if chg {
if ss.ViewOn && ss.TestUpdt > leabra.AlphaCycle {
ss.UpdateView(false, -1)
}
ss.LogTstEpc(ss.TstEpcLog)
if returnOnChg {
return
}
}
ss.ApplyInputs(&ss.TestEnv)
ss.AlphaCyc(false) // !train
ss.TrialStats(false) // !accumulate
ss.LogTstTrl(ss.TstTrlLog)
}
// TestAll runs through the full set of testing items
func (ss *Sim) TestAll() {
ss.TestEnv.Init(ss.TestEnv.Run.Cur)
for {
ss.TestTrial(true) // return on chg, don't present
_, _, chg := ss.TestEnv.Counter(env.Epoch)
if chg || ss.StopNow {
break
}
}
}
// RunTestAll runs through the full set of testing items, has stop running = false at end -- for gui
func (ss *Sim) RunTestAll() {
ss.StopNow = false
ss.TestAll()
ss.Stopped()
}
/////////////////////////////////////////////////////////////////////////
// Params setting
// ParamsName returns name of current set of parameters
func (ss *Sim) ParamsName() string {
if ss.ParamSet == "" {
return "Base"
}
return ss.ParamSet
}
// SetParams sets the params for "Base" and then current ParamSet.
// If sheet is empty, then it applies all avail sheets (e.g., Network, Sim)
// otherwise just the named sheet
// if setMsg = true then we output a message for each param that was set.
func (ss *Sim) SetParams(sheet string, setMsg bool) error {
if sheet == "" {
// this is important for catching typos and ensuring that all sheets can be used
ss.Params.ValidateSheets([]string{"Network", "Sim"})
}
err := ss.SetParamsSet("Base", sheet, setMsg)
if ss.ParamSet != "" && ss.ParamSet != "Base" {
sps := strings.Fields(ss.ParamSet)
for _, ps := range sps {
err = ss.SetParamsSet(ps, sheet, setMsg)
}
}
// gpi := ss.Net.LayerByName("GPiThal").(*pbwm.GPiThalLayer)
// gpi.Gate.Thr = 0.5 // todo: these are not taking in params
// gpi.Gate.NoGo = 0.4
//
matg := ss.Net.LayerByName("MatrixGo").(*pbwm.MatrixLayer)
matn := ss.Net.LayerByName("MatrixNoGo").(*pbwm.MatrixLayer)
matg.Matrix.BurstGain = ss.BurstDaGain
matg.Matrix.DipGain = ss.DipDaGain
matn.Matrix.BurstGain = ss.BurstDaGain
matn.Matrix.DipGain = ss.DipDaGain
return err
}
// SetParamsSet sets the params for given params.Set name.
// If sheet is empty, then it applies all avail sheets (e.g., Network, Sim)
// otherwise just the named sheet
// if setMsg = true then we output a message for each param that was set.
func (ss *Sim) SetParamsSet(setNm string, sheet string, setMsg bool) error {
pset, err := ss.Params.SetByNameTry(setNm)
if err != nil {
return err
}
if sheet == "" || sheet == "Network" {
netp, ok := pset.Sheets["Network"]
if ok {
ss.Net.ApplyParams(netp, setMsg)
}
}
if sheet == "" || sheet == "Sim" {
simp, ok := pset.Sheets["Sim"]
if ok {
simp.Apply(ss, setMsg)
}
}
// note: if you have more complex environments with parameters, definitely add
// sheets for them, e.g., "TrainEnv", "TrainEnv" etc
return err
}
////////////////////////////////////////////////////////////////////////////////////////////
// Logging
// ValsTsr gets value tensor of given name, creating if not yet made
func (ss *Sim) ValsTsr(name string) *etensor.Float32 {
if ss.ValsTsrs == nil {
ss.ValsTsrs = make(map[string]*etensor.Float32)
}
tsr, ok := ss.ValsTsrs[name]
if !ok {
tsr = &etensor.Float32{}
ss.ValsTsrs[name] = tsr
}
return tsr
}
// RunName returns a name for this run that combines Tag and Params -- add this to
// any file names that are saved.
func (ss *Sim) RunName() string {
if ss.Tag != "" {
return ss.Tag + "_" + ss.ParamsName()
} else {
return ss.ParamsName()
}
}
// RunEpochName returns a string with the run and epoch numbers with leading zeros, suitable
// for using in weights file names. Uses 3, 5 digits for each.
func (ss *Sim) RunEpochName(run, epc int) string {
return fmt.Sprintf("%03d_%05d", run, epc)
}
// WeightsFileName returns default current weights file name
func (ss *Sim) WeightsFileName() string {
return ss.Net.Nm + "_" + ss.RunName() + "_" + ss.RunEpochName(ss.TrainEnv.Run.Cur, ss.TrainEnv.Epoch.Cur) + ".wts.gz"
}
// LogFileName returns default log file name
func (ss *Sim) LogFileName(lognm string) string {
return ss.Net.Nm + "_" + ss.RunName() + "_" + lognm + ".csv"
}
//////////////////////////////////////////////
// TrnEpcLog
// LogTrnEpc adds data from current epoch to the TrnEpcLog table.
// computes epoch averages prior to logging.
func (ss *Sim) LogTrnEpc(dt *etable.Table) {
row := dt.Rows
dt.SetNumRows(row + 1)
epc := ss.TrainEnv.Epoch.Prv // this is triggered by increment so use previous value
nt := float64(ss.TrainEnv.Trial.Max) // number of trials in view
ss.EpcDA = ss.SumDA / nt
ss.SumDA = 0
ss.EpcAbsDA = ss.SumAbsDA / nt
ss.SumAbsDA = 0
ss.EpcRewPred = ss.SumRewPred / nt
ss.SumRewPred = 0
ss.EpcSSE = ss.SumSSE / nt
ss.SumSSE = 0
ss.EpcAvgSSE = ss.SumAvgSSE / nt
ss.SumAvgSSE = 0
ss.EpcPctErr = float64(ss.SumErr) / nt
ss.SumErr = 0
ss.EpcPctCor = 1 - ss.EpcPctErr
ss.EpcCosDiff = ss.SumCosDiff / nt
ss.SumCosDiff = 0
if ss.FirstZero < 0 && ss.EpcPctErr == 0 {
ss.FirstZero = epc
}
if ss.EpcPctErr == 0 {
ss.NZero++
} else {
ss.NZero = 0
}
if ss.LastEpcTime.IsZero() {
ss.EpcPerTrlMSec = 0
} else {
iv := time.Now().Sub(ss.LastEpcTime)
ss.EpcPerTrlMSec = float64(iv) / (nt * float64(time.Millisecond))
}
ss.LastEpcTime = time.Now()
dt.SetCellFloat("Run", row, float64(ss.TrainEnv.Run.Cur))
dt.SetCellFloat("Epoch", row, float64(epc))
dt.SetCellFloat("SSE", row, ss.EpcSSE)
dt.SetCellFloat("AvgSSE", row, ss.EpcAvgSSE)
dt.SetCellFloat("PctErr", row, ss.EpcPctErr)
dt.SetCellFloat("PctCor", row, ss.EpcPctCor)
dt.SetCellFloat("CosDiff", row, ss.EpcCosDiff)
dt.SetCellFloat("DA", row, ss.EpcDA)
dt.SetCellFloat("AbsDA", row, ss.EpcAbsDA)
dt.SetCellFloat("RewPred", row, ss.EpcRewPred)
dt.SetCellFloat("PerTrlMSec", row, ss.EpcPerTrlMSec)
// note: essential to use Go version of update when called from another goroutine
ss.TrnEpcPlot.GoUpdate()
if ss.TrnEpcFile != nil {
if ss.TrainEnv.Run.Cur == 0 && epc == 0 {
dt.WriteCSVHeaders(ss.TrnEpcFile, etable.Tab)
}
dt.WriteCSVRow(ss.TrnEpcFile, row, etable.Tab)
}
}
func (ss *Sim) ConfigTrnEpcLog(dt *etable.Table) {
dt.SetMetaData("name", "TrnEpcLog")
dt.SetMetaData("desc", "Record of performance over epochs of training")
dt.SetMetaData("read-only", "true")
dt.SetMetaData("precision", strconv.Itoa(LogPrec))
sch := etable.Schema{
{"Run", etensor.INT64, nil, nil},
{"Epoch", etensor.INT64, nil, nil},
{"SSE", etensor.FLOAT64, nil, nil},
{"AvgSSE", etensor.FLOAT64, nil, nil},
{"PctErr", etensor.FLOAT64, nil, nil},
{"PctCor", etensor.FLOAT64, nil, nil},
{"CosDiff", etensor.FLOAT64, nil, nil},
{"DA", etensor.FLOAT64, nil, nil},
{"AbsDA", etensor.FLOAT64, nil, nil},
{"RewPred", etensor.FLOAT64, nil, nil},
{"PerTrlMSec", etensor.FLOAT64, nil, nil},
}
dt.SetFromSchema(sch, 0)