/
test_sqlite_reader.py
4505 lines (3466 loc) · 170 KB
/
test_sqlite_reader.py
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
""" Unit tests for the SqliteCaseReader. """
import errno
import os
import unittest
from shutil import rmtree
from tempfile import mkdtemp, mkstemp
from collections import OrderedDict
import numpy as np
from io import StringIO
import openmdao.api as om
from openmdao.recorders.sqlite_recorder import format_version
from openmdao.recorders.sqlite_reader import SqliteCaseReader
from openmdao.recorders.tests.test_sqlite_recorder import ParaboloidProblem
from openmdao.recorders.case import PromAbsDict
from openmdao.core.tests.test_units import SpeedComp
from openmdao.test_suite.components.expl_comp_array import TestExplCompArray
from openmdao.test_suite.components.implicit_newton_linesearch import ImplCompTwoStates
from openmdao.test_suite.components.paraboloid import Paraboloid
from openmdao.test_suite.components.paraboloid_problem import ParaboloidProblem
from openmdao.test_suite.components.sellar import SellarDerivativesGrouped, \
SellarDis1withDerivatives, SellarDis2withDerivatives, SellarProblem
from openmdao.utils.assert_utils import assert_near_equal, assert_warning
from openmdao.utils.general_utils import set_pyoptsparse_opt, determine_adder_scaler, printoptions
from openmdao.utils.general_utils import remove_whitespace
from openmdao.utils.testing_utils import use_tempdirs
from openmdao.core.tests.test_discrete import ModCompEx, ModCompIm
# check that pyoptsparse is installed
OPT, OPTIMIZER = set_pyoptsparse_opt('SLSQP')
if OPTIMIZER:
from openmdao.drivers.pyoptsparse_driver import pyOptSparseDriver
def count_keys(d):
"""
Count the number of keys in the nested dictionary.
Parameters
----------
d : nested OrderedDict
The dictionary of cases to be counted.
"""
count = 0
for k in d:
count += 1
if isinstance(d[k], OrderedDict):
count += count_keys(d[k])
return count
class SellarDerivativesGroupedPreAutoIVC(om.Group):
"""
This version is needed for testing backwards compatibility for load_case on pre-3.2
models.
"""
def initialize(self):
self.options.declare('nonlinear_solver', default=om.NonlinearBlockGS,
desc='Nonlinear solver (class or instance) for Sellar MDA')
self.options.declare('nl_atol', default=None,
desc='User-specified atol for nonlinear solver.')
self.options.declare('nl_maxiter', default=None,
desc='Iteration limit for nonlinear solver.')
self.options.declare('linear_solver', default=om.ScipyKrylov,
desc='Linear solver (class or instance)')
self.options.declare('ln_atol', default=None,
desc='User-specified atol for linear solver.')
self.options.declare('ln_maxiter', default=None,
desc='Iteration limit for linear solver.')
def setup(self):
self.add_subsystem('px', om.IndepVarComp('x', 1.0), promotes=['x'])
self.add_subsystem('pz', om.IndepVarComp('z', np.array([5.0, 2.0])), promotes=['z'])
self.mda = mda = self.add_subsystem('mda', om.Group(), promotes=['x', 'z', 'y1', 'y2'])
mda.add_subsystem('d1', SellarDis1withDerivatives(), promotes=['x', 'z', 'y1', 'y2'])
mda.add_subsystem('d2', SellarDis2withDerivatives(), promotes=['z', 'y1', 'y2'])
self.add_subsystem('obj_cmp', om.ExecComp('obj = x**2 + z[1] + y1 + exp(-y2)',
z=np.array([0.0, 0.0]), x=0.0, y1=0.0, y2=0.0),
promotes=['obj', 'x', 'z', 'y1', 'y2'])
self.add_subsystem('con_cmp1', om.ExecComp('con1 = 3.16 - y1'), promotes=['con1', 'y1'])
self.add_subsystem('con_cmp2', om.ExecComp('con2 = y2 - 24.0'), promotes=['con2', 'y2'])
nl = self.options['nonlinear_solver']
self.nonlinear_solver = nl()
if self.options['nl_atol']:
self.nonlinear_solver.options['atol'] = self.options['nl_atol']
if self.options['nl_maxiter']:
self.nonlinear_solver.options['maxiter'] = self.options['nl_maxiter']
ln = self.options['linear_solver']
self.linear_solver = ln()
if self.options['ln_atol']:
self.linear_solver.options['atol'] = self.options['ln_atol']
if self.options['ln_maxiter']:
self.linear_solver.options['maxiter'] = self.options['ln_maxiter']
def configure(self):
self.mda.linear_solver = om.ScipyKrylov()
self.mda.nonlinear_solver = om.NonlinearBlockGS()
@use_tempdirs
class TestSqliteCaseReader(unittest.TestCase):
def setUp(self):
self.filename = "sqlite_test"
self.recorder = om.SqliteRecorder(self.filename, record_viewer_data=False)
def test_bad_filetype(self):
# Pass a plain text file.
fd, filepath = mkstemp()
with os.fdopen(fd, 'w') as tmp:
tmp.write("Lorem ipsum")
tmp.close()
with self.assertRaises(IOError) as cm:
om.CaseReader(filepath)
msg = 'File does not contain a valid sqlite database'
self.assertTrue(str(cm.exception).startswith(msg))
def test_bad_filename(self):
# Pass a nonexistent file.
with self.assertRaises(IOError) as cm:
om.CaseReader('junk.sql')
self.assertTrue(str(cm.exception).startswith('File does not exist'))
def test_format_version(self):
prob = SellarProblem()
prob.model.add_recorder(self.recorder)
prob.setup()
prob.run_driver()
prob.cleanup()
cr = om.CaseReader(self.filename)
self.assertEqual(cr._format_version, format_version,
msg='format version not read correctly')
def test_reader_instantiates(self):
""" Test that CaseReader returns an SqliteCaseReader. """
prob = SellarProblem()
prob.model.add_recorder(self.recorder)
prob.setup()
prob.run_driver()
prob.cleanup()
cr = om.CaseReader(self.filename)
self.assertTrue(isinstance(cr, SqliteCaseReader),
msg='CaseReader not returning the correct subclass.')
def test_case_attributes(self):
""" Check that a Case object has all the expected attributes. """
prob = SellarProblem()
prob.setup()
prob.driver.add_recorder(self.recorder)
prob.run_driver()
prob.cleanup()
cr = om.CaseReader(self.filename)
case = cr.get_case(0)
self.assertEqual(case.source, 'driver')
self.assertEqual(case.name, 'rank0:Driver|0')
self.assertEqual(case.counter, 1)
self.assertTrue(isinstance(case.timestamp, float))
self.assertEqual(case.success, True)
self.assertEqual(case.msg, '')
self.assertTrue(isinstance(case.outputs, PromAbsDict))
self.assertEqual(case.inputs, None)
self.assertEqual(case.residuals, None)
self.assertEqual(case.derivatives, None)
self.assertEqual(case.parent, None)
self.assertEqual(case.abs_err, None)
self.assertEqual(case.rel_err, None)
def test_invalid_source(self):
""" Tests that the reader returns params correctly. """
prob = SellarProblem(SellarDerivativesGrouped)
driver = prob.driver
driver.recording_options['record_desvars'] = False
driver.recording_options['record_objectives'] = False
driver.recording_options['record_constraints'] = False
driver.recording_options['record_derivatives'] = False
driver.add_recorder(self.recorder)
prob.setup()
prob.run_driver()
prob.cleanup()
cr = om.CaseReader(self.filename)
# check that driver is our only source
self.assertEqual(cr.list_sources(out_stream=None), ['driver'])
# check source vars
source_vars = cr.list_source_vars('driver', out_stream=None)
self.assertEqual(sorted(source_vars['inputs']), [])
self.assertEqual(sorted(source_vars['outputs']), [])
with self.assertRaisesRegex(RuntimeError, "No cases recorded for problem"):
cr.list_source_vars('problem', out_stream=None)
with self.assertRaisesRegex(RuntimeError, "Source not found: root"):
cr.list_source_vars('root', out_stream=None)
with self.assertRaisesRegex(RuntimeError, "Source not found: root.nonlinear_solver"):
cr.list_source_vars('root.nonlinear_solver', out_stream=None)
# check list cases
with self.assertRaisesRegex(RuntimeError, "Source not found: foo"):
cr.list_cases('foo')
with self.assertRaisesRegex(TypeError, "Source parameter must be a string, 999 is type int"):
cr.list_cases(999)
def test_reading_driver_cases(self):
""" Tests that the reader returns params correctly. """
prob = SellarProblem(SellarDerivativesGrouped)
driver = prob.driver = om.ScipyOptimizeDriver(tol=1e-9, disp=False)
driver.recording_options['record_desvars'] = False
driver.recording_options['record_objectives'] = True
driver.recording_options['record_constraints'] = True
driver.recording_options['record_derivatives'] = True
driver.recording_options['record_inputs'] = True
driver.recording_options['includes'] = ['*']
driver.add_recorder(self.recorder)
prob.setup()
prob.run_driver()
prob.cleanup()
cr = om.CaseReader(self.filename)
# check that we only have driver cases
self.assertEqual(cr.list_sources(out_stream=None), ['driver'])
# check source vars
source_vars = cr.list_source_vars('driver', out_stream=None)
self.assertEqual(sorted(source_vars['inputs']), ['x', 'y1', 'y2', 'z'])
self.assertEqual(sorted(source_vars['outputs']), ['con1', 'con2', 'obj', 'x', 'y1', 'y2', 'z'])
# check that we got the correct number of cases
driver_cases = cr.list_cases('driver')
self.assertEqual(driver_cases, [
'rank0:ScipyOptimize_SLSQP|0', 'rank0:ScipyOptimize_SLSQP|1', 'rank0:ScipyOptimize_SLSQP|2',
'rank0:ScipyOptimize_SLSQP|3', 'rank0:ScipyOptimize_SLSQP|4', 'rank0:ScipyOptimize_SLSQP|5',
'rank0:ScipyOptimize_SLSQP|6'
])
# Test to see if the access by case keys works:
seventh_slsqp_iteration_case = cr.get_case('rank0:ScipyOptimize_SLSQP|6')
np.testing.assert_almost_equal(seventh_slsqp_iteration_case.outputs['z'],
[1.97846296, -2.21388305e-13], decimal=2)
deriv_case = cr.get_case('rank0:ScipyOptimize_SLSQP|4')
np.testing.assert_almost_equal(deriv_case.derivatives['obj', 'z'],
[[3.8178954, 1.73971323]], decimal=2)
# While thinking about derivatives, let's get them all.
derivs = deriv_case.derivatives
self.assertEqual(set(derivs.keys()), set([
('obj', 'z'), ('con2', 'z'), ('con1', 'x'),
('obj', 'x'), ('con2', 'x'), ('con1', 'z')
]))
# Test values from the last case
last_case = cr.get_case(driver_cases[-1])
np.testing.assert_almost_equal(last_case.outputs['z'], prob['z'])
np.testing.assert_almost_equal(last_case.outputs['x'], [-0.00309521], decimal=2)
# Test to see if the case keys (iteration coords) come back correctly
for i, iter_coord in enumerate(driver_cases):
self.assertEqual(iter_coord, 'rank0:ScipyOptimize_SLSQP|{}'.format(i))
def test_driver_reading_outputs(self):
prob = ParaboloidProblem()
driver = prob.driver = om.ScipyOptimizeDriver(disp=False, tol=1e-9)
driver.recording_options['record_desvars'] = False
driver.recording_options['record_objectives'] = False
driver.recording_options['record_constraints'] = False
driver.recording_options['record_inputs'] = False
driver.recording_options['record_outputs'] = True
driver.recording_options['record_residuals'] = False
driver.recording_options['includes'] = ['*']
driver.add_recorder(self.recorder)
prob.setup()
prob.set_solver_print(0)
prob.run_driver()
cr = om.CaseReader(self.filename)
# check that we only have driver cases
self.assertEqual(cr.list_sources(out_stream=None), ['driver'])
# check source vars
source_vars = cr.list_source_vars('driver', out_stream=None)
self.assertEqual(sorted(source_vars['inputs']), [])
self.assertEqual(sorted(source_vars['outputs']), ['c', 'f_xy', 'x', 'y'])
# Test values from the last case
driver_cases = cr.list_cases('driver')
last_case = cr.get_case(driver_cases[-1])
np.testing.assert_almost_equal(last_case.outputs['f_xy'], prob['f_xy'])
np.testing.assert_almost_equal(last_case.outputs['x'], prob['x'])
def test_driver_reading_residuals(self):
prob = ParaboloidProblem()
driver = prob.driver = om.ScipyOptimizeDriver(disp=False, tol=1e-9)
driver.recording_options['record_desvars'] = False
driver.recording_options['record_objectives'] = False
driver.recording_options['record_constraints'] = False
driver.recording_options['record_inputs'] = False
driver.recording_options['record_outputs'] = False
driver.recording_options['record_residuals'] = True
driver.recording_options['includes'] = ['*']
driver.add_recorder(self.recorder)
prob.setup()
prob.set_solver_print(0)
prob.run_driver()
cr = om.CaseReader(self.filename)
# check that we only have driver cases
self.assertEqual(cr.list_sources(out_stream=None), ['driver'])
# check source vars
source_vars = cr.list_source_vars('driver', out_stream=None)
self.assertEqual(sorted(source_vars['inputs']), [])
self.assertEqual(sorted(source_vars['residuals']), ['c', 'f_xy', 'x', 'y'])
# Test values from the last case
driver_cases = cr.list_cases('driver')
last_case = cr.get_case(driver_cases[-1])
np.testing.assert_almost_equal(last_case.residuals['f_xy'], 0.0)
np.testing.assert_almost_equal(last_case.residuals['x'], 0.0)
def test_reading_system_cases(self):
prob = SellarProblem()
model = prob.model
model.recording_options['record_inputs'] = True
model.recording_options['record_outputs'] = True
model.recording_options['record_residuals'] = True
model.add_recorder(self.recorder)
prob.setup()
model.nonlinear_solver.options['use_apply_nonlinear'] = True
model.d1.add_recorder(self.recorder) # SellarDis1withDerivatives (an ExplicitComp)
model.obj_cmp.add_recorder(self.recorder) # an ExecComp
prob.run_driver()
prob.cleanup()
cr = om.CaseReader(self.filename)
# check that we only have the three system sources
self.assertEqual(sorted(cr.list_sources(out_stream=None)), ['root', 'root.d1', 'root.obj_cmp'])
# check source vars
source_vars = cr.list_source_vars('root', out_stream=None)
self.assertEqual(sorted(source_vars['inputs']), ['x', 'y1', 'y2', 'z'])
self.assertEqual(sorted(source_vars['outputs']), ['con1', 'con2', 'obj', 'x', 'y1', 'y2', 'z'])
source_vars = cr.list_source_vars('root.d1', out_stream=None)
self.assertEqual(sorted(source_vars['inputs']), ['x', 'y2', 'z'])
self.assertEqual(sorted(source_vars['outputs']), ['y1'])
source_vars = cr.list_source_vars('root.obj_cmp', out_stream=None)
self.assertEqual(sorted(source_vars['inputs']), ['x', 'y1', 'y2', 'z'])
self.assertEqual(sorted(source_vars['outputs']), ['obj'])
# Test to see if we got the correct number of cases
self.assertEqual(len(cr.list_cases('root', recurse=False)), 1)
self.assertEqual(len(cr.list_cases('root.d1', recurse=False)), 7)
self.assertEqual(len(cr.list_cases('root.obj_cmp', recurse=False)), 7)
# Test values from cases
case = cr.get_case('rank0:Driver|0|root._solve_nonlinear|0')
np.testing.assert_almost_equal(case.inputs['d1.y2'], [12.05848815, ])
np.testing.assert_almost_equal(case.outputs['obj'], [28.58830817, ])
np.testing.assert_almost_equal(case.residuals['obj'], [0.0, ],)
# Test to see if the case keys (iteration coords) come back correctly
for i, iter_coord in enumerate(cr.list_cases('root.d1', recurse=False)):
self.assertEqual(iter_coord,
'rank0:Driver|0|root._solve_nonlinear|0|NonlinearBlockGS|{iter}|'
'd1._solve_nonlinear|{iter}'.format(iter=i))
for i, iter_coord in enumerate(cr.list_cases('root.obj_cmp', recurse=False)):
self.assertEqual(iter_coord,
'rank0:Driver|0|root._solve_nonlinear|0|NonlinearBlockGS|{iter}|'
'obj_cmp._solve_nonlinear|{iter}'.format(iter=i))
def test_reading_solver_cases(self):
prob = SellarProblem()
prob.setup()
solver = prob.model.nonlinear_solver
solver.add_recorder(self.recorder)
solver.recording_options['record_abs_error'] = True
solver.recording_options['record_rel_error'] = True
solver.recording_options['record_solver_residuals'] = True
prob.run_driver()
prob.cleanup()
cr = om.CaseReader(self.filename)
# check that we only have the one solver source
self.assertEqual(sorted(cr.list_sources(out_stream=None)), ['root.nonlinear_solver'])
# check source vars
source_vars = cr.list_source_vars('root.nonlinear_solver', out_stream=None)
self.assertEqual(sorted(source_vars['inputs']), ['x', 'y1', 'y2', 'z'])
self.assertEqual(sorted(source_vars['outputs']), ['con1', 'con2', 'obj', 'x', 'y1', 'y2', 'z'])
# Test to see if we got the correct number of cases
solver_cases = cr.list_cases('root.nonlinear_solver')
self.assertEqual(len(solver_cases), 7)
# Test values from cases
last_case = cr.get_case(solver_cases[-1])
np.testing.assert_almost_equal(last_case.abs_err, [0.0, ])
np.testing.assert_almost_equal(last_case.rel_err, [0.0, ])
np.testing.assert_almost_equal(last_case.outputs['x'], [1.0, ])
np.testing.assert_almost_equal(last_case.residuals['con2'], [0.0, ])
# check that the case keys (iteration coords) come back correctly
for i, iter_coord in enumerate(solver_cases):
self.assertEqual(iter_coord,
'rank0:Driver|0|root._solve_nonlinear|0|NonlinearBlockGS|%d' % i)
def test_reading_solver_metadata(self):
prob = SellarProblem(linear_solver=om.LinearBlockGS())
prob.setup()
prob.model.nonlinear_solver.add_recorder(self.recorder)
d1 = prob.model.d1 # SellarDis1withDerivatives (an ExplicitComponent)
d1.nonlinear_solver = om.NonlinearBlockGS(maxiter=5)
d1.nonlinear_solver.add_recorder(self.recorder)
prob.run_driver()
prob.cleanup()
metadata = om.CaseReader(self.filename).solver_metadata
self.assertEqual(
sorted(metadata.keys()),
['d1.NonlinearBlockGS', 'root.NonlinearBlockGS']
)
self.assertEqual(metadata['d1.NonlinearBlockGS']['solver_options']['maxiter'], 5)
self.assertEqual(metadata['root.NonlinearBlockGS']['solver_options']['maxiter'], 10)
def test_reading_driver_recording_with_system_vars(self):
prob = SellarProblem(SellarDerivativesGrouped)
driver = prob.driver = om.ScipyOptimizeDriver(tol=1e-9, disp=False)
driver.recording_options['record_desvars'] = True
driver.recording_options['record_objectives'] = True
driver.recording_options['record_constraints'] = True
driver.recording_options['includes'] = ['y2']
driver.add_recorder(self.recorder)
prob.setup()
prob.run_driver()
prob.cleanup()
cr = om.CaseReader(self.filename)
# Test values from the last case
driver_cases = cr.list_cases('driver')
last_case = cr.get_case(driver_cases[-1])
np.testing.assert_almost_equal(last_case.outputs['z'], prob['z'])
np.testing.assert_almost_equal(last_case.outputs['x'], prob['x'])
np.testing.assert_almost_equal(last_case.outputs['y2'], prob['mda.d2.y2'])
@unittest.skipIf(OPT is None, "pyoptsparse is not installed")
@unittest.skipIf(OPTIMIZER is None, "pyoptsparse is not providing SNOPT or SLSQP")
def test_get_child_cases(self):
prob = SellarProblem(SellarDerivativesGrouped, nonlinear_solver=om.NonlinearRunOnce)
driver = prob.driver = pyOptSparseDriver(optimizer='SLSQP', print_results=False)
driver.recording_options['record_desvars'] = True
driver.recording_options['record_objectives'] = True
driver.recording_options['record_constraints'] = True
driver.add_recorder(self.recorder)
prob.setup()
model = prob.model
model.add_recorder(self.recorder)
model.nonlinear_solver.add_recorder(self.recorder)
prob.run_driver()
prob.cleanup()
cr = om.CaseReader(self.filename)
# check driver cases
expected_coords = [
'rank0:pyOptSparse_SLSQP|0',
'rank0:pyOptSparse_SLSQP|1',
'rank0:pyOptSparse_SLSQP|2',
'rank0:pyOptSparse_SLSQP|3',
'rank0:pyOptSparse_SLSQP|4',
'rank0:pyOptSparse_SLSQP|5',
'rank0:pyOptSparse_SLSQP|6'
]
last_counter = 0
for i, c in enumerate(cr.get_cases(flat=False)):
self.assertEqual(c.name, expected_coords[i])
self.assertTrue(c.counter > last_counter)
last_counter = c.counter
self.assertEqual(i+1, len(expected_coords))
# check driver cases with recursion, flat
expected_coords = [
'rank0:pyOptSparse_SLSQP|0|root._solve_nonlinear|0|NLRunOnce|0',
'rank0:pyOptSparse_SLSQP|0|root._solve_nonlinear|0',
'rank0:pyOptSparse_SLSQP|0',
'rank0:pyOptSparse_SLSQP|1|root._solve_nonlinear|1|NLRunOnce|0',
'rank0:pyOptSparse_SLSQP|1|root._solve_nonlinear|1',
'rank0:pyOptSparse_SLSQP|1',
'rank0:pyOptSparse_SLSQP|2|root._solve_nonlinear|2|NLRunOnce|0',
'rank0:pyOptSparse_SLSQP|2|root._solve_nonlinear|2',
'rank0:pyOptSparse_SLSQP|2',
'rank0:pyOptSparse_SLSQP|3|root._solve_nonlinear|3|NLRunOnce|0',
'rank0:pyOptSparse_SLSQP|3|root._solve_nonlinear|3',
'rank0:pyOptSparse_SLSQP|3',
'rank0:pyOptSparse_SLSQP|4|root._solve_nonlinear|4|NLRunOnce|0',
'rank0:pyOptSparse_SLSQP|4|root._solve_nonlinear|4',
'rank0:pyOptSparse_SLSQP|4',
'rank0:pyOptSparse_SLSQP|5|root._solve_nonlinear|5|NLRunOnce|0',
'rank0:pyOptSparse_SLSQP|5|root._solve_nonlinear|5',
'rank0:pyOptSparse_SLSQP|5',
'rank0:pyOptSparse_SLSQP|6|root._solve_nonlinear|6|NLRunOnce|0',
'rank0:pyOptSparse_SLSQP|6|root._solve_nonlinear|6',
'rank0:pyOptSparse_SLSQP|6',
]
last_counter = 0
for i, c in enumerate(cr.get_cases(recurse=True, flat=True)):
self.assertEqual(c.name, expected_coords[i])
if len(c.name.split('|')) > 2:
self.assertEqual(c.parent, expected_coords[i+1])
else:
self.assertEqual(c.parent, None)
self.assertTrue(c.counter > last_counter)
last_counter = c.counter
self.assertEqual(i+1, len(expected_coords))
# check child cases with recursion, flat
expected_coords = [
'rank0:pyOptSparse_SLSQP|0|root._solve_nonlinear|0|NLRunOnce|0',
'rank0:pyOptSparse_SLSQP|0|root._solve_nonlinear|0',
'rank0:pyOptSparse_SLSQP|0',
]
last_counter = 0
for i, c in enumerate(cr.get_cases('rank0:pyOptSparse_SLSQP|0', recurse=True, flat=True)):
self.assertEqual(c.name, expected_coords[i])
self.assertTrue(c.counter > last_counter)
last_counter = c.counter
self.assertEqual(i+1, len(expected_coords))
# check child cases with recursion, nested
expected_coords = {
'rank0:pyOptSparse_SLSQP|0': {
'rank0:pyOptSparse_SLSQP|0|root._solve_nonlinear|0': {
'rank0:pyOptSparse_SLSQP|0|root._solve_nonlinear|0|NLRunOnce|0': {}
},
}
}
cases = cr.get_cases('rank0:pyOptSparse_SLSQP|0', recurse=True, flat=False)
count = 0
for case in cases:
count += 1
coord = case.name
self.assertTrue(coord in list(expected_coords.keys()))
for child_case in cases[case]:
count += 1
child_coord = child_case.name
self.assertTrue(child_coord in expected_coords[coord].keys())
for grandchild_case in cases[case][child_case]:
count += 1
grandchild_coord = grandchild_case.name
self.assertTrue(grandchild_coord in expected_coords[coord][child_coord].keys())
self.assertEqual(count, 3)
def test_get_child_cases_system(self):
prob = SellarProblem(SellarDerivativesGrouped, nonlinear_solver=om.NonlinearRunOnce)
prob.driver = om.ScipyOptimizeDriver(tol=1e-9, disp=False)
prob.setup()
model = prob.model
model.add_recorder(self.recorder)
model.nonlinear_solver.add_recorder(self.recorder)
model.mda.nonlinear_solver.add_recorder(self.recorder)
prob.run_driver()
prob.cleanup()
cr = om.CaseReader(self.filename)
parent_coord = 'rank0:ScipyOptimize_SLSQP|2|root._solve_nonlinear|2'
coord = parent_coord + '|NLRunOnce|0'
# user scenario: given a case (with coord), get all cases with same parent
case = cr.get_case(coord)
self.assertEqual(case.parent, parent_coord)
expected_coords = [
parent_coord + '|NLRunOnce|0|mda._solve_nonlinear|2|NonlinearBlockGS|0',
parent_coord + '|NLRunOnce|0|mda._solve_nonlinear|2|NonlinearBlockGS|1',
parent_coord + '|NLRunOnce|0|mda._solve_nonlinear|2|NonlinearBlockGS|2',
parent_coord + '|NLRunOnce|0|mda._solve_nonlinear|2|NonlinearBlockGS|3',
parent_coord + '|NLRunOnce|0|mda._solve_nonlinear|2|NonlinearBlockGS|4',
parent_coord + '|NLRunOnce|0|mda._solve_nonlinear|2|NonlinearBlockGS|5',
parent_coord + '|NLRunOnce|0|mda._solve_nonlinear|2|NonlinearBlockGS|6',
parent_coord + '|NLRunOnce|0|mda._solve_nonlinear|2|NonlinearBlockGS|7',
parent_coord + '|NLRunOnce|0',
parent_coord
]
last_counter = 0
for i, c in enumerate(cr.get_cases(source=case.parent, recurse=True, flat=True)):
self.assertEqual(c.name, expected_coords[i])
self.assertTrue(c.counter > last_counter)
last_counter = c.counter
i += 1
self.assertEqual(i, len(expected_coords))
def test_list_cases_recurse(self):
prob = SellarProblem(SellarDerivativesGrouped, nonlinear_solver=om.NonlinearRunOnce)
prob.driver = om.ScipyOptimizeDriver(optimizer='SLSQP', tol=1e-9, disp=False)
prob.driver.add_recorder(self.recorder)
prob.setup()
model = prob.model
model.add_recorder(self.recorder)
model.mda.add_recorder(self.recorder)
model.nonlinear_solver.add_recorder(self.recorder)
model.mda.nonlinear_solver.add_recorder(self.recorder)
prob.run_driver()
prob.cleanup()
cr = om.CaseReader(self.filename)
# get total iteration count to check against
global_iterations = len(cr._global_iterations)
#
# get a recursive list of all cases (flat)
#
cases = cr.list_cases(recurse=True, flat=True, out_stream=None)
# verify the cases are all there
self.assertEqual(len(cases), global_iterations)
# verify the cases are in proper order
counter = 0
for i, c in enumerate(cr.get_case(case) for case in cases):
counter += 1
self.assertEqual(c.counter, counter)
#
# get a recursive dict of all cases (nested)
#
cases = cr.list_cases(recurse=True, flat=False)
num_cases = count_keys(cases)
self.assertEqual(num_cases, global_iterations)
#
# get a recursive list of child cases
#
parent_coord = 'rank0:ScipyOptimize_SLSQP|0|root._solve_nonlinear|0'
expected_coords = [
parent_coord + '|NLRunOnce|0|mda._solve_nonlinear|0|NonlinearBlockGS|0',
parent_coord + '|NLRunOnce|0|mda._solve_nonlinear|0|NonlinearBlockGS|1',
parent_coord + '|NLRunOnce|0|mda._solve_nonlinear|0|NonlinearBlockGS|2',
parent_coord + '|NLRunOnce|0|mda._solve_nonlinear|0|NonlinearBlockGS|3',
parent_coord + '|NLRunOnce|0|mda._solve_nonlinear|0|NonlinearBlockGS|4',
parent_coord + '|NLRunOnce|0|mda._solve_nonlinear|0|NonlinearBlockGS|5',
parent_coord + '|NLRunOnce|0|mda._solve_nonlinear|0|NonlinearBlockGS|6',
parent_coord + '|NLRunOnce|0|mda._solve_nonlinear|0',
parent_coord + '|NLRunOnce|0',
parent_coord
]
cases = cr.list_cases(parent_coord, recurse=True, flat=True)
# verify the cases are all there and are as expected
self.assertEqual(len(cases), len(expected_coords))
for i, c in enumerate(cases):
self.assertEqual(c, expected_coords[i])
#
# get a list of cases for each source
#
sources = cr.list_sources(out_stream=None)
self.assertEqual(sorted(sources), [
'driver', 'root', 'root.mda', 'root.mda.nonlinear_solver', 'root.nonlinear_solver'
])
# verify the coordinates of the returned cases are all there as expected
expected_coord = {
'driver': r'rank0:ScipyOptimize_SLSQP\|\d',
'root': r'rank0:ScipyOptimize_SLSQP\|\d\|root._solve_nonlinear\|\d',
'root.nonlinear_solver': r'rank0:ScipyOptimize_SLSQP\|\d\|root._solve_nonlinear\|\d\|NLRunOnce\|0',
'root.mda': r'rank0:ScipyOptimize_SLSQP\|\d\|root._solve_nonlinear\|\d\|NLRunOnce\|0\|mda._solve_nonlinear\|\d',
'root.mda.nonlinear_solver': r'rank0:ScipyOptimize_SLSQP\|\d\|root._solve_nonlinear\|\d\|NLRunOnce\|0\|mda._solve_nonlinear\|\d\|NonlinearBlockGS\|\d',
}
counter = 0
mda_counter = 0
root_counter = 0
for source in sources:
expected = expected_coord[source]
cases = cr.list_cases(source, recurse=False)
for case in cases:
counter += 1
if source.startswith('root.mda'): # count all cases for/under mda system
mda_counter += 1
if source.startswith('root.'): # count all cases for/under root solver
root_counter += 1
self.assertRegexpMatches(case, expected)
self.assertEqual(counter, global_iterations)
#
# get a recursive list of child cases for the mda system
#
counter = 0
cases = cr.list_cases('root.mda', recurse=True, flat=True)
for case in cases:
self.assertTrue(case.index('|mda._solve_nonlinear|') > 0)
counter += 1
self.assertEqual(counter, mda_counter)
#
# get a recursive list of child cases for the root solver
#
counter = 0
cases = cr.list_cases('root.nonlinear_solver', recurse=True, flat=True)
for case in cases:
self.assertTrue(case.index('|NLRunOnce|') > 0)
counter += 1
self.assertEqual(counter, root_counter)
def test_list_cases_nested_model(self):
prob = SellarProblem(SellarDerivativesGrouped, nonlinear_solver=om.NonlinearRunOnce)
prob.driver = om.ScipyOptimizeDriver(tol=1e-9, disp=False)
prob.setup()
model = prob.model
model.add_recorder(self.recorder)
model.mda.add_recorder(self.recorder)
model.nonlinear_solver.add_recorder(self.recorder)
model.mda.nonlinear_solver.add_recorder(self.recorder)
prob.run_driver()
prob.cleanup()
cr = om.CaseReader(self.filename)
# get total iteration count to check against
global_iterations = len(cr._global_iterations)
#
# get a recursive list of all cases (flat)
#
cases = cr.list_cases(recurse=True, flat=True, out_stream=None)
# verify the cases are all there
self.assertEqual(len(cases), global_iterations)
# verify the cases are in proper order
counter = 0
for i, c in enumerate(cr.get_case(case) for case in cases):
counter += 1
self.assertEqual(c.counter, counter)
#
# get a recursive dict of all cases (nested)
#
cases = cr.list_cases(recurse=True, flat=False)
num_cases = count_keys(cases)
self.assertEqual(num_cases, global_iterations)
def test_list_cases_nested_no_source(self):
prob = SellarProblem(SellarDerivativesGrouped, nonlinear_solver=om.NonlinearRunOnce)
prob.driver = om.ScipyOptimizeDriver(tol=1e-9, disp=False)
prob.setup()
model = prob.model
model.mda.add_recorder(self.recorder)
model.nonlinear_solver.add_recorder(self.recorder)
model.mda.nonlinear_solver.add_recorder(self.recorder)
prob.run_driver()
prob.cleanup()
cr = om.CaseReader(self.filename)
# get total iteration count to check against
global_iterations = len(cr._global_iterations)
#
# get a recursive list of all cases (flat)
#
cases = cr.list_cases(recurse=True, flat=True, out_stream=None)
# verify the cases are all there
self.assertEqual(len(cases), global_iterations)
# verify the cases are in proper order
counter = 0
for i, c in enumerate(cr.get_case(case) for case in cases):
counter += 1
self.assertEqual(c.counter, counter)
#
# try to get a recursive dict of all cases (nested), without driver or model
#
expected_err = ("A nested dictionary of all cases was requested, but "
"neither the driver or the model was recorded. Please "
"specify another source (system or solver) for the cases "
"you want to see.")
with self.assertRaises(RuntimeError) as cm:
cases = cr.list_cases(recurse=True, flat=False)
self.assertEqual(str(cm.exception), expected_err)
def test_get_cases_recurse(self):
prob = SellarProblem(SellarDerivativesGrouped, nonlinear_solver=om.NonlinearRunOnce)
prob.driver = om.ScipyOptimizeDriver(optimizer='SLSQP', tol=1e-9, disp=False)
prob.driver.add_recorder(self.recorder)
prob.setup()
model = prob.model
model.add_recorder(self.recorder)
model.mda.add_recorder(self.recorder)
model.nonlinear_solver.add_recorder(self.recorder)
model.mda.nonlinear_solver.add_recorder(self.recorder)
prob.run_driver()
prob.cleanup()
cr = om.CaseReader(self.filename)
# get total iteration count to check against
global_iterations = len(cr._global_iterations)
#
# get a recursive list of all cases (flat)
#
cases = cr.get_cases(recurse=True, flat=True)
# verify the cases are all there
self.assertEqual(len(cases), global_iterations)
# verify the cases are in proper order
counter = 0
for i, c in enumerate(cases):
counter += 1
self.assertEqual(c.counter, counter)
#
# get a recursive dict of all cases (nested)
#
cases = cr.get_cases(recurse=True, flat=False)
num_cases = count_keys(cases)
self.assertEqual(num_cases, global_iterations)
#
# get a recursive list of child cases
#
parent_coord = 'rank0:ScipyOptimize_SLSQP|0|root._solve_nonlinear|0'
expected_coords = [
parent_coord + '|NLRunOnce|0|mda._solve_nonlinear|0|NonlinearBlockGS|0',
parent_coord + '|NLRunOnce|0|mda._solve_nonlinear|0|NonlinearBlockGS|1',
parent_coord + '|NLRunOnce|0|mda._solve_nonlinear|0|NonlinearBlockGS|2',
parent_coord + '|NLRunOnce|0|mda._solve_nonlinear|0|NonlinearBlockGS|3',
parent_coord + '|NLRunOnce|0|mda._solve_nonlinear|0|NonlinearBlockGS|4',
parent_coord + '|NLRunOnce|0|mda._solve_nonlinear|0|NonlinearBlockGS|5',
parent_coord + '|NLRunOnce|0|mda._solve_nonlinear|0|NonlinearBlockGS|6',
parent_coord + '|NLRunOnce|0|mda._solve_nonlinear|0',
parent_coord + '|NLRunOnce|0',
parent_coord
]
cases = cr.get_cases(parent_coord, recurse=True, flat=True)
# verify the cases are all there and are as expected
self.assertEqual(len(cases), len(expected_coords))
for i, c in enumerate(cases):
self.assertEqual(c.name, expected_coords[i])
#
# get a list of cases for each source
#
sources = cr.list_sources(out_stream=None)
self.assertEqual(sorted(sources), [
'driver', 'root', 'root.mda', 'root.mda.nonlinear_solver', 'root.nonlinear_solver'
])
# verify the coordinates of the returned cases are as expected and that the cases are all there
expected_coord = {
'driver': r'rank0:ScipyOptimize_SLSQP\|\d',
'root': r'rank0:ScipyOptimize_SLSQP\|\d\|root._solve_nonlinear\|\d',
'root.nonlinear_solver': r'rank0:ScipyOptimize_SLSQP\|\d\|root._solve_nonlinear\|\d\|NLRunOnce\|0',
'root.mda': r'rank0:ScipyOptimize_SLSQP\|\d\|root._solve_nonlinear\|\d\|NLRunOnce\|0\|mda._solve_nonlinear\|\d',
'root.mda.nonlinear_solver': r'rank0:ScipyOptimize_SLSQP\|\d\|root._solve_nonlinear\|\d\|NLRunOnce\|0\|mda._solve_nonlinear\|\d\|NonlinearBlockGS\|\d',
}
counter = 0
mda_counter = 0
root_counter = 0
for source in sources:
expected = expected_coord[source]
cases = cr.get_cases(source, recurse=False)
for case in cases:
counter += 1
if source.startswith('root.mda'): # count all cases for/under mda system
mda_counter += 1
if source.startswith('root.'): # count all cases for/under root solver
root_counter += 1
self.assertRegexpMatches(case.name, expected)
self.assertEqual(counter, global_iterations)
#
# get a recursive list of child cases for the mda system
#
counter = 0
cases = cr.get_cases('root.mda', recurse=True, flat=True)
for case in cases:
counter += 1
self.assertEqual(counter, mda_counter)
#
# get a recursive list of child cases for the root solver
#
counter = 0
cases = cr.get_cases('root.nonlinear_solver', recurse=True, flat=True)
for case in cases:
counter += 1
self.assertEqual(counter, root_counter)