forked from gorgonia/gorgonia
-
Notifications
You must be signed in to change notification settings - Fork 0
/
solvers.go
1065 lines (891 loc) · 24.4 KB
/
solvers.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
package gorgonia
import (
"math"
"github.com/chewxy/gorgonia/tensor"
"github.com/chewxy/math32"
"github.com/pkg/errors"
)
// Solver is anything that does gradient updates.
// The name solvers is stolen from Caffe. A much shorter name than GradientUpdaters
type Solver interface {
Step(Nodes) error
}
// SolverOpt is a function that provides construction options for a Solver
type SolverOpt func(s Solver)
// WithL2Reg adds a L2 regularization parameter to the solver. By default, the solvers do not use any regularization param
func WithL2Reg(l2reg float64) SolverOpt {
f := func(s Solver) {
switch st := s.(type) {
case *RMSPropSolver:
st.l2reg = l2reg
st.useL2Reg = true
case *AdamSolver:
st.l2reg = l2reg
st.useL2Reg = true
case *VanillaSolver:
st.l2reg = l2reg
st.useL2Reg = true
}
}
return f
}
// WithL1Reg adds a L1 regularization parameter to the solver. By default, the solvers do not use any regularization param
func WithL1Reg(l1reg float64) SolverOpt {
f := func(s Solver) {
switch st := s.(type) {
case *AdamSolver:
st.l1reg = l1reg
st.useL1Reg = true
case *VanillaSolver:
st.l1reg = l1reg
st.useL1Reg = true
}
}
return f
}
// WithBatchSize sets the batch size for the solver. Currently only Adam and Vanilla (basic SGD) has batch size support
func WithBatchSize(batch float64) SolverOpt {
f := func(s Solver) {
switch st := s.(type) {
case *AdamSolver:
st.batch = batch
case *VanillaSolver:
st.batch = batch
}
}
return f
}
// WithEps sets the smoothing factor for the solver.
func WithEps(eps float64) SolverOpt {
f := func(s Solver) {
switch st := s.(type) {
case *RMSPropSolver:
st.eps = eps
case *AdamSolver:
st.eps = eps
}
}
return f
}
// WithClip clips the gradient if it gets too crazy. By default all solvers do not have any clips attached
func WithClip(clip float64) SolverOpt {
f := func(s Solver) {
switch st := s.(type) {
case *RMSPropSolver:
st.clip = clip
st.useClip = true
case *AdamSolver:
st.clip = clip
st.useClip = true
case *VanillaSolver:
st.clip = clip
st.useClip = true
}
}
return f
}
// WithLearnRate sets the learn rate or step size for the solver.
func WithLearnRate(eta float64) SolverOpt {
f := func(s Solver) {
switch st := s.(type) {
case *RMSPropSolver:
st.eta = eta
case *AdamSolver:
st.eta = eta
case *VanillaSolver:
st.eta = eta
}
}
return f
}
// WithBeta1 sets the beta1 param of the solver. Only works with Adam
func WithBeta1(beta1 float64) SolverOpt {
f := func(s Solver) {
switch st := s.(type) {
case *AdamSolver:
st.beta1 = beta1
}
}
return f
}
// WithBeta2 sets the beta1 param of the solver. Only works with Adam
func WithBeta2(beta2 float64) SolverOpt {
f := func(s Solver) {
switch st := s.(type) {
case *AdamSolver:
st.beta2 = beta2
}
}
return f
}
// WithRho sets the decay parameter of the RMSProp solver
func WithRho(rho float64) SolverOpt {
f := func(s Solver) {
switch st := s.(type) {
case *RMSPropSolver:
st.decay = rho
}
}
return f
}
// RMSPropSolver is a solver that implements Geoffrey Hinton's RMSProp gradient descent optimization algorithm.
// http://www.cs.toronto.edu/~tijmen/csc321/slides/lecture_slides_lec6.pdf
type RMSPropSolver struct {
decay float64 // decay rate/rho
eps float64 // smoothing factor
l2reg float64 // l2 regularization
clip float64 // clip value
eta float64 // learn rate
useClip, useL2Reg bool
// unsettable
cache []*dualValue
}
// NewRMSPropSolver creates an RMSProp solver with these default values:
// eta (learn rate) : 0.001
// eps (smoothing factor): 1e-8
// rho (decay factor) : 0.999
func NewRMSPropSolver(opts ...SolverOpt) *RMSPropSolver {
s := &RMSPropSolver{
decay: 0.999,
eps: 1e-8,
eta: 0.001,
}
for _, opt := range opts {
opt(s)
}
return s
}
// Step steps through each node in the model and applies the RMSProp gradient descent algorithm on the value.
//
// This function will error out if the nodes do not have an associated Grad value.
func (s *RMSPropSolver) Step(model Nodes) (err error) {
if s.cache == nil {
s.cache = make([]*dualValue, len(model))
}
for i, n := range model {
solverLogf("BEFORE (%v %p) : %+1.1s", n, n, n.boundTo)
dv, ok := n.boundTo.(*dualValue)
if !ok {
return errors.Errorf("Expected a *dualValue in %v (%x). Got %T instead", n, n.Hashcode(), n.boundTo)
}
var cached *dualValue
if cached = s.cache[i]; cached == nil {
if cached, err = dv.clone0(); err != nil {
return errors.Wrap(err, "Failed to carry out clone0()")
}
s.cache[i] = cached
}
grad := dv.d
weights := dv.Value
cv := cached.Value
// cw = cw*decay + (1-decay) * grad^2
switch cw := cv.(type) {
case *tensor.Dense:
var gt, gt2, w, regularized tensor.Tensor
var decay, omdecay, stepSize, eps, l2reg, clip, negClip interface{}
switch cw.Dtype() {
case tensor.Float64:
decay = s.decay
omdecay = 1.0 - s.decay
stepSize = -s.eta
eps = s.eps
l2reg = s.l2reg
clip = s.clip
negClip = -s.clip
case tensor.Float32:
decay = float32(s.decay)
omdecay = float32(1.0 - s.decay)
stepSize = float32(-s.eta)
eps = float32(s.eps)
l2reg = float32(s.l2reg)
clip = float32(s.clip)
negClip = float32(-s.clip)
}
gt = grad.(tensor.Tensor)
if gt2, err = tensor.Square(gt); err != nil {
return errors.Wrap(err, pointWiseSquareFail)
}
tensor.Mul(cw, decay, tensor.UseUnsafe())
tensor.Mul(gt2, omdecay, tensor.UseUnsafe())
tensor.Add(cw, gt2, tensor.UseUnsafe())
defer returnTensor(gt2)
if s.useClip {
if _, err = tensor.Clamp(gt, negClip, clip, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, clampFail)
}
}
// regularize
var upd tensor.Tensor
if upd, err = tensor.Add(cw, eps); err != nil {
return errors.Wrap(err, "Failed to carry Add()")
}
if _, err = tensor.InvSqrt(upd, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, invSqrtFail)
}
if _, err = tensor.Mul(gt, stepSize, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, pointWiseMulFail)
}
if _, err = tensor.Mul(upd, gt, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, pointWiseMulFail)
}
// update
w = weights.(*tensor.Dense)
if s.useL2Reg {
if regularized, err = tensor.Mul(w, l2reg); err != nil {
return errors.Wrap(err, pointWiseMulFail)
}
if _, err = tensor.Sub(upd, regularized, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, subFail)
}
defer returnTensor(regularized)
}
if _, err = tensor.Add(w, upd, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, addFail)
}
defer returnTensor(upd)
// zero all
gt.Zero()
case *F32:
decay := float32(s.decay)
omdecay := float32(1.0 - s.decay)
stepSize := float32(s.eta)
eps := float32(s.eps)
l2reg := float32(s.l2reg)
gs := grad.(*F32).any()
c := cw.any()
c = c*decay + omdecay*gs*gs
cached.Value, _ = anyToScalar(c)
w := weights.(*F32).any()
upd := -stepSize*gs/math32.Sqrt(c+eps) - l2reg*w
w += upd
// because scalar values are copies, and not pointers, we have to actually re-update the dualValu in model[i]
dv.Value, _ = anyToScalar(w)
dv.d = zero(Float32)
case *F64:
decay := s.decay
omdecay := 1.0 - s.decay
stepSize := s.eta
eps := s.eps
l2reg := s.l2reg
gs := grad.(*F64).any()
c := cw.any()
c = c*decay + omdecay*gs*gs
cached.Value, _ = anyToScalar(c)
w := weights.(*F64).any()
upd := -stepSize*gs/math.Sqrt(c+eps) - l2reg*w
w += upd
// because scalar values are copies, and not pointers, we have to actually re-update the dualValu in model[i]
dv.Value, _ = anyToScalar(w)
dv.d = zero(Float64)
default:
}
solverLogf("AFTER (%v): %+1.1s", n, n.boundTo)
}
return nil
}
// AdamSolver is the Adaptive Moment Estimation solver (basically RMSProp on steroids).
// Paper: http://arxiv.org/abs/1412.6980
//
// We overload the purpose of existing data structure of a *dualValue. However, instead of just holding a value and its derivative,
// the cache's *dualValues hold the Means of gradients (in .Value) and the variances of the gradients (in .d)
type AdamSolver struct {
eta float64 // learn rate
eps float64 // smoothing
beta1 float64 // modifier for means
beta2 float64 // modifier for variances
clip float64 // clip gradients
l1reg float64 // l1 regularization parameter
l2reg float64 // l2 regularization parameter
batch float64 // batch size
useClip, useL1Reg, useL2Reg bool
// unsettable
iter int
cache []*dualValue
}
// NewAdamSolver creates an Adam solver with these default values:
// eta (learn rate) : 0.001
// eps (smoothing factor) : 1e-8
// beta1 : 0.9
// beta2 : 0.999
// batch : 1
func NewAdamSolver(opts ...SolverOpt) *AdamSolver {
s := &AdamSolver{
eta: 0.001,
eps: 1e-8,
beta1: 0.9,
beta2: 0.999,
batch: 1,
}
for _, opt := range opts {
opt(s)
}
return s
}
// Step steps through each node in the model and applies the Adaptive Moment Estimation gradient descent algorithm on the value.
//
// This function will error out if the nodes do not have an associated Grad value.
func (s *AdamSolver) Step(model Nodes) (err error) {
if s.cache == nil {
s.cache = make([]*dualValue, len(model))
}
s.iter++
correction1 := (1 - math.Pow(s.beta1, float64(s.iter)))
correction2 := (1 - math.Pow(s.beta2, float64(s.iter)))
for i, n := range model {
dv, ok := n.boundTo.(*dualValue)
if !ok {
return errors.Errorf("Expected a *dualValue in %v (%x). Got %T instead", n, n.Hashcode(), n.boundTo)
}
var cached *dualValue
if cached = s.cache[i]; cached == nil {
if cached, err = dv.clone0(); err != nil {
return errors.Wrap(err, "Failed to carry clone0()")
}
s.cache[i] = cached
}
grad := dv.d
weights := dv.Value
cvm := cached.Value // means of gradients
cvv := cached.d // variances of gradients
switch m := cvm.(type) {
case *tensor.Dense:
g := grad.(*tensor.Dense)
w := weights.(*tensor.Dense)
v := cvv.(*tensor.Dense)
var l1reg, l2reg, clip, negClip, beta1, beta2, omβ1, omβ2, eps, eta, onePerBatch interface{}
var correctionV1, correctionV2 interface{}
switch m.Dtype() {
case tensor.Float64:
l1reg = s.l1reg
l2reg = s.l2reg
clip = s.clip
negClip = -s.clip
beta1 = s.beta1
beta2 = s.beta2
omβ1 = float64(1) - s.beta1
omβ2 = float64(1) - s.beta2
eps = s.eps
eta = -s.eta
onePerBatch = float64(1) / s.batch
correctionV1 = float64(1) / float64(correction1)
correctionV2 = float64(1) / float64(correction2)
case tensor.Float32:
l1reg = float32(s.l1reg)
l2reg = float32(s.l2reg)
clip = float32(s.clip)
negClip = float32(s.clip)
beta1 = float32(s.beta1)
beta2 = float32(s.beta2)
omβ1 = float32(1) - float32(s.beta1)
omβ2 = float32(1) - float32(s.beta2)
eps = float32(s.eps)
eta = float32(-s.eta)
onePerBatch = float32(1) / float32(s.batch)
correctionV1 = float32(1) / float32(correction1)
correctionV2 = float32(1) / float32(correction2)
}
// prep the regularization of gradients
if s.useL1Reg {
var l1regs tensor.Tensor
if l1regs, err = tensor.Sign(w); err != nil {
errors.Wrap(err, signFail)
}
if l1regs, err = tensor.Mul(l1reg, l1regs, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, pointWiseMulFail)
}
if _, err = tensor.Add(g, l1regs, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, addFail)
}
defer returnTensor(l1regs)
}
if s.useL2Reg {
var l2regs tensor.Tensor
if l2regs, err = tensor.Mul(l2reg, w); err != nil {
return errors.Wrap(err, pointWiseMulFail)
}
if _, err = tensor.Add(g, l2regs, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, addFail)
}
defer returnTensor(l2regs)
}
if s.batch > 1 {
if _, err = tensor.Mul(onePerBatch, g, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, pointWiseMulFail)
}
}
if s.useClip && s.clip > 0 {
if _, err = tensor.Clamp(g, negClip, clip, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, clampFail)
}
}
// prep done. Now let's apply the formula:
// the formula is
// (β_1 * m_t-1) + (1 - β_1)g_t .................. 1
// (β_2 * v_t-1) + (1 - β_2)*(g_t)^2 ............. 2
// equation(1)
t1 := g.Clone().(*tensor.Dense)
if _, err = tensor.Mul(omβ1, t1, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, pointWiseMulFail)
}
// equation(2)
if _, err = tensor.Mul(g, g, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, pointWiseMulFail)
}
if _, err = tensor.Mul(omβ2, g, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, pointWiseMulFail)
}
// equation (1)
if _, err = tensor.Mul(beta1, m, tensor.WithIncr(t1)); err != nil {
return errors.Wrap(err, pointWiseMulFail)
}
// equation (2)
if _, err = tensor.Mul(beta2, v, tensor.WithIncr(g)); err != nil {
return errors.Wrap(err, pointWiseMulFail)
}
defer returnTensor(m)
defer returnTensor(v)
cached.SetValue(t1)
cached.SetDeriv(g.Clone().(*tensor.Dense))
// now deal with the hats
mHats := t1.Clone().(*tensor.Dense)
vHats := g.Clone().(*tensor.Dense)
if _, err = tensor.Mul(correctionV1, mHats, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, pointWiseMulFail)
}
if _, err = tensor.Mul(correctionV2, vHats, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, pointWiseMulFail)
}
// update := -eta * mHat / (sqrt(vHat) + epsilon)
if _, err = tensor.Sqrt(vHats, tensor.UseUnsafe()); err != nil {
return // TODO: rewrite this to use InvSqrt
}
if _, err = tensor.Add(eps, vHats, tensor.UseUnsafe()); err != nil {
return
}
if _, err = tensor.Mul(eta, mHats, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, pointWiseMulFail)
}
if _, err = tensor.Div(mHats, vHats, tensor.WithIncr(w)); err != nil {
return
}
defer returnTensor(vHats)
defer returnTensor(mHats)
if _, err = tensor.Add(w, mHats, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, addFail)
}
g.Zero()
case *F32:
g := grad.(*F32).any()
w := weights.(*F32).any()
v := cvv.(*F32).any()
mm := m.any()
l1reg := float32(s.l1reg)
l2reg := float32(s.l2reg)
batch := float32(s.batch)
clip := float32(s.clip)
beta1 := float32(s.beta1)
beta2 := float32(s.beta2)
eps := float32(s.eps)
eta := float32(s.eta)
if s.useL1Reg {
if w < 0 {
l1reg = -l1reg
}
g += l1reg
}
if s.useL2Reg {
l2reg *= w
g += l2reg
}
if batch > 1 {
g *= (1 / batch)
}
if s.useClip {
if g > clip {
g = clip
} else if g < -clip {
g = -clip
}
}
newM := (beta1 * mm) + (1-beta1)*g
newV := (beta2 * v) + (1-beta2)*g*g
cached.Value, _ = anyToScalar(newM)
cached.d, _ = anyToScalar(newV)
mHat := (1 / float32(correction1)) * newM
vHat := (1 / float32(correction2)) * newV
upd := -eta * mHat / (float32(math.Sqrt(float64(vHat))) + eps)
w += upd
dv.Value, _ = anyToScalar(w)
dv.d = zero(Float32)
case *F64:
g := grad.(*F64).any()
w := weights.(*F64).any()
v := cvv.(*F64).any()
mm := m.any()
l1reg := s.l1reg
l2reg := s.l2reg
batch := s.batch
clip := s.clip
beta1 := s.beta1
beta2 := s.beta2
eps := s.eps
eta := s.eta
if s.useL1Reg {
if w < 0 {
l1reg = -l1reg
}
g += l1reg
}
if s.useL2Reg {
l2reg *= w
g += l2reg
}
if batch > 1 {
g *= (1 / batch)
}
if s.useClip {
if g > clip {
g = clip
} else if g < -clip {
g = -clip
}
}
newM := (beta1 * mm) + (1-beta1)*g
newV := (beta2 * v) + (1-beta2)*g*g
cached.Value, _ = anyToScalar(newM)
cached.d, _ = anyToScalar(newV)
mHat := (1 / correction1) * newM
vHat := (1 / correction2) * newV
upd := -eta * mHat / (math.Sqrt(vHat) + eps)
w += upd
dv.Value, _ = anyToScalar(w)
dv.d = zero(Float64)
default:
err = errors.Errorf(nyiTypeFail, "AdamSolver", cvm)
return
}
}
return
}
// VanillaSolver is your bog standard stochastic gradient descent optimizer. There are no fancy features to this
type VanillaSolver struct {
eta float64 // learn rate
clip float64 // clip gradients
l1reg float64 // l1 regularization parameter
l2reg float64 // l2 regularization parameter
batch float64 // batch size
useClip, useL1Reg, useL2Reg bool
}
// NewVanillaSolver creates a new VanillaSolver with sane-ish default values
func NewVanillaSolver(opts ...SolverOpt) *VanillaSolver {
s := &VanillaSolver{
batch: 1,
eta: 0.001,
}
for _, opt := range opts {
opt(s)
}
return s
}
// Step steps through each node in the model and applies the most basic gradient descent algorithm on the value.
//
// This function will error out if the nodes do not have an associated Grad value.
func (s *VanillaSolver) Step(model Nodes) (err error) {
for _, n := range model {
dv, ok := n.boundTo.(*dualValue)
if !ok {
return errors.Errorf("Expected a *dualValue in %v (%x). Got %T instead", n, n.Hashcode(), n.boundTo)
}
grad := dv.d
weights := dv.Value
switch w := weights.(type) {
case *tensor.Dense:
g := grad.(*tensor.Dense)
var l1reg, l2reg, clip, negClip, eta interface{}
var onePerBatch interface{}
switch w.Dtype() {
case tensor.Float64:
l1reg = s.l1reg
l2reg = s.l2reg
clip = s.clip
negClip = -s.clip
eta = -s.eta
onePerBatch = float64(1) / s.batch
case tensor.Float32:
l1reg = float32(s.l1reg)
l2reg = float32(s.l2reg)
clip = float32(s.clip)
negClip = float32(-s.clip)
eta = float32(-s.eta)
onePerBatch = float32(1) / float32(s.batch)
}
// prep the regularization of gradients
var l1regs, l2regs tensor.Tensor
if s.useL1Reg {
if l1regs, err = tensor.Sign(w); err != nil {
return errors.Wrap(err, signFail)
}
if l1regs, err = tensor.Mul(l1reg, l1regs, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, pointWiseMulFail)
}
if _, err = tensor.Add(g, l1regs, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, addFail)
}
defer returnTensor(l1regs)
}
if s.useL2Reg {
if l2regs, err = tensor.Mul(l2reg, w); err != nil {
return errors.Wrap(err, pointWiseMulFail)
}
if _, err = tensor.Add(g, l2regs, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, addFail)
}
defer returnTensor(l2regs)
}
if s.batch > 1 {
if _, err = tensor.Mul(onePerBatch, g, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, pointWiseMulFail)
}
}
if s.useClip && s.clip > 0 {
if _, err = tensor.Clamp(g, negClip, clip, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, clampFail)
}
}
if _, err = tensor.Mul(eta, g, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, pointWiseMulFail)
}
if _, err = tensor.Add(w, g, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, addFail)
}
g.Zero()
case *F32:
g := grad.(*F32).any()
wv := w.any()
l1reg := float32(s.l1reg)
l2reg := float32(s.l2reg)
batch := float32(s.batch)
clip := float32(s.clip)
eta := float32(s.eta)
if s.useL1Reg {
if wv < 0 {
l1reg = -l1reg
}
g += l1reg
}
if s.useL2Reg {
l2reg *= wv
g += l2reg
}
if batch > 1 {
g *= (1 / batch)
}
if s.useClip {
if g > clip {
g = clip
} else if g < -clip {
g = -clip
}
}
upd := -eta * g
wv += upd
dv.Value, _ = anyToScalar(wv)
dv.d = zero(Float32)
case *F64:
g := grad.(*F64).any()
wv := w.any()
l1reg := s.l1reg
l2reg := s.l2reg
batch := s.batch
clip := s.clip
eta := s.eta
if s.useL1Reg {
if wv < 0 {
l1reg = -l1reg
}
g += l1reg
}
if s.useL2Reg {
l2reg *= wv
g += l2reg
}
if batch > 1 {
g *= (1 / batch)
}
if s.useClip {
if g > clip {
g = clip
} else if g < -clip {
g = -clip
}
}
upd := -eta * g
wv += upd
dv.Value, _ = anyToScalar(wv)
dv.d = zero(Float64)
default:
return errors.Errorf(nyiFail, "VanillaSolver.step", w)
}
}
return
}
// AdaGradSolver is the solver that does adaptive gradient descent. Read the paper: http://jmlr.org/papers/v12/duchi11a.html
type AdaGradSolver struct {
eta float64 // learn rate
eps float64 // smoothing factor
l1Reg float64 // l1reg param
l2reg float64 // l2reg param
clip float64 // clip at
useL2Reg, useClip bool
cache []*dualValue
}
// NewAdaGradSolver creates a new AdaGradSolver with sane-ish default values
func NewAdaGradSolver(opts ...SolverOpt) *AdaGradSolver {
s := &AdaGradSolver{
eta: 0.001,
eps: 1e-8,
}
for _, opt := range opts {
opt(s)
}
return s
}
// Step steps through each node in the model and applies the Adaptive Gradient gradient descent algorithm on the value.
//
// This function will error out if the nodes do not have an associated Grad value.
func (s *AdaGradSolver) Step(model Nodes) (err error) {
if s.cache == nil {
s.cache = make([]*dualValue, len(model))
}
for i, n := range model {
dv, ok := n.boundTo.(*dualValue)
if !ok {
return errors.Errorf("Expected a *dualValue in %v (%x). Got %T instead", n, n.Hashcode(), n.boundTo)
}
var cached *dualValue
if cached = s.cache[i]; cached == nil {
if cached, err = dv.clone0(); err != nil {
return errors.Wrap(err, clone0Fail)
}
s.cache[i] = cached
}
grad := dv.d
weights := dv.Value
cv := cached.Value
switch cw := cv.(type) {
case *tensor.Dense:
var w, g, c, g2, regularized tensor.Tensor
var l2reg, clip, negClip, eps, eta interface{}
switch cw.Dtype() {
case tensor.Float64:
l2reg = s.l2reg
clip = s.clip
negClip = -s.clip
eps = s.eps
eta = -s.eta
case tensor.Float32:
l2reg = float32(s.l2reg)
clip = float32(s.clip)
negClip = float32(-s.clip)
eps = float32(s.eps)
eta = float32(-s.eta)
}
g = grad.(*tensor.Dense)
if g2, err = tensor.Square(g); err != nil {
return errors.Wrap(err, pointWiseSquareFail)
}
c = cw
tensor.Add(c, g2, tensor.UseUnsafe())
defer returnTensor(g2)
if s.useClip {
if _, err = tensor.Clamp(g, negClip, clip, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, clampFail)
}
}
// update
var upd tensor.Tensor
if upd, err = tensor.Add(c, eps); err != nil {
return errors.Wrap(err, addFail)
}
if _, err = tensor.InvSqrt(upd, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, invSqrtFail)
}
if _, err = tensor.Mul(g, eta, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, pointWiseMulFail)
}
if _, err = tensor.Mul(upd, g, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, pointWiseMulFail)
}
// regularize
w = weights.(*tensor.Dense)
if s.useL2Reg {
if regularized, err = tensor.Mul(w, l2reg); err != nil {
return errors.Wrap(err, pointWiseMulFail)
}
if _, err = tensor.Sub(upd, regularized, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, subFail)
}
defer returnTensor(regularized)
}
if _, err = tensor.Add(w, upd, tensor.UseUnsafe()); err != nil {
return errors.Wrap(err, addFail)
}
defer returnTensor(upd)
// zero all
g.Zero()
case *F32:
var w, g, c float32
l2reg := float32(s.l2reg)
clip := float32(s.clip)
eps := float32(s.eps)
eta := float32(s.eta)
c = cw.any()
g = grad.(*F32).any()