Skip to content

fl_server_api.tests.test_model

Classes:

Name Description
ModelTests

Classes

ModelTests

Bases: TransactionTestCase


              flowchart TD
              fl_server_api.tests.test_model.ModelTests[ModelTests]

              

              click fl_server_api.tests.test_model.ModelTests href "" "fl_server_api.tests.test_model.ModelTests"
            

Methods:

Name Description
setUp
test_delete_global_model_with_training_as_model_owner
test_delete_local_model_with_training_as_model_owner
test_delete_model_as_training_owner
test_delete_model_as_training_participant
test_delete_model_with_training_as_unrelated_user
test_delete_model_without_training_as_model_owner
test_delete_model_without_training_as_unrelated_user
test_delete_non_existing_model
test_download_model_preprocessing
test_download_model_preprocessing_with_undefined_preprocessing
test_get_all_models
test_get_all_models_for_a_training
test_get_all_models_for_a_training_latest_only
test_get_global_model_metrics
test_get_local_model_metrics
test_get_model
test_get_model_and_unpickle
test_get_model_metadata
test_get_model_metadata_torchscript_model
test_get_model_metadata_with_preprocessing
test_unauthorized
test_upload
test_upload_bad_metrics
test_upload_global_model_metrics
test_upload_local_model_metrics
test_upload_mean_model
test_upload_model_preprocessing
test_upload_model_preprocessing_v1_Compose_bad
test_upload_model_preprocessing_v2_Compose_good
test_upload_swag_model
test_upload_swag_stats
test_upload_update
test_upload_update_and_aggregate
test_upload_update_and_not_aggregate_since_training_is_locked
test_upload_update_bad_keys
test_upload_update_no_participant
test_upload_update_no_training
test_upload_update_with_metrics
test_upload_update_with_metrics_bad
test_upload_with_preprocessing
Source code in fl_server_api/tests/test_model.py
 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
class ModelTests(TransactionTestCase):

    def setUp(self):
        self.user = Dummy.create_user_and_authenticate(self.client)

    def test_unauthorized(self):
        del self.client.defaults["HTTP_AUTHORIZATION"]
        with self.assertLogs("root", level="WARNING"):
            response = self.client.post(
                f"{BASE_URL}/models/",
                {"model_file": b"Hello World!"}
            )
        self.assertEqual(401, response.status_code)
        response_json = response.json()
        self.assertIsNotNone(response_json)
        self.assertEqual("Authentication credentials were not provided.", response_json["detail"])

    def test_get_all_models(self):
        # make user actor and client
        self.user.actor = True
        self.user.client = True
        self.user.save()
        # create models and trainings - some related to user some not
        [Dummy.create_model() for _ in range(2)]
        models = [Dummy.create_model(owner=self.user) for _ in range(2)]
        [Dummy.create_training() for _ in range(2)]
        trainings = [Dummy.create_training(actor=self.user) for _ in range(2)]
        trainings += [Dummy.create_training(participants=[self.user]) for _ in range(2)]
        models += [t.model for t in trainings]
        # get user related models
        response = self.client.get(f"{BASE_URL}/models/")
        self.assertEqual(200, response.status_code)
        self.assertEqual("application/json", response["content-type"])
        response_json = response.json()
        self.assertEqual(len(models), len(response_json))
        self.assertEqual(
            sorted([str(model.id) for model in models]),
            sorted([model["id"] for model in response_json])
        )

    def test_get_all_models_for_a_training(self):
        # make user actor and client
        self.user.actor = True
        self.user.client = True
        self.user.save()
        # create participants
        participants = [Dummy.create_user() for _ in range(4)]
        participant_rounds = [3, 4, 4, 3]
        # create models and trainings - some related to user some not
        [Dummy.create_training() for _ in range(2)]
        [Dummy.create_training(actor=self.user) for _ in range(2)]
        [Dummy.create_training(participants=[self.user]) for _ in range(2)]
        [Dummy.create_model_update() for _ in range(2)]
        [Dummy.create_model_update(owner=self.user) for _ in range(2)]
        training = Dummy.create_training(actor=self.user, participants=participants)
        # create model update for 4 users
        base_model = training.model
        models = [base_model]
        for participant, rounds in zip(participants, participant_rounds):
            for round_idx in range(rounds):
                model = Dummy.create_model_update(base_model=base_model, owner=participant, round=round_idx+1)
                models.append(model)
        # get user related models for a special training
        response = self.client.get(f"{BASE_URL}/trainings/{training.pk}/models/")
        self.assertEqual(200, response.status_code)
        self.assertEqual("application/json", response["content-type"])
        response_json = response.json()
        self.assertEqual(len(models), len(response_json))
        self.assertEqual(
            sorted([str(model.id) for model in models]),
            sorted([model["id"] for model in response_json])
        )

    def test_get_all_models_for_a_training_latest_only(self):
        # make user actor and client
        self.user.actor = True
        self.user.client = True
        self.user.save()
        # create participants
        participants = [Dummy.create_user() for _ in range(4)]
        participant_rounds = [3, 4, 4, 3]
        # create models and trainings - some related to user some not
        [Dummy.create_training() for _ in range(2)]
        [Dummy.create_training(actor=self.user) for _ in range(2)]
        [Dummy.create_training(participants=[self.user]) for _ in range(2)]
        [Dummy.create_model_update() for _ in range(2)]
        [Dummy.create_model_update(owner=self.user) for _ in range(2)]
        training = Dummy.create_training(actor=self.user, participants=participants)
        # create model update for 4 users
        base_model = training.model
        models_latest = [base_model]
        for participant, rounds in zip(participants, participant_rounds):
            for round_idx in range(rounds):
                model = Dummy.create_model_update(base_model=base_model, owner=participant, round=round_idx+1)
            models_latest.append(model)
        # get user related "latest" models for a special training
        response = self.client.get(f"{BASE_URL}/trainings/{training.pk}/models/latest/")
        self.assertEqual(200, response.status_code)
        self.assertEqual("application/json", response["content-type"])
        response_json = response.json()
        self.assertEqual(len(models_latest), len(response_json))
        models_latest = sorted(models_latest, key=lambda m: str(m.pk))
        response_models = sorted(response_json, key=lambda m: m["id"])
        self.assertEqual(
            [str(model.id) for model in models_latest],
            [model["id"] for model in response_models]
        )
        self.assertEqual(
            [model.round for model in models_latest],
            [model["round"] for model in response_models]
        )

    def test_get_model_metadata(self):
        model_bytes = from_torch_module(torch.nn.Sequential(
            torch.nn.Linear(3, 64),
            torch.nn.ELU(),
            torch.nn.Linear(64, 1),
        ))
        model = Dummy.create_model(weights=model_bytes, input_shape=[None, 3])
        response = self.client.get(f"{BASE_URL}/models/{model.id}/metadata/")
        self.assertEqual(200, response.status_code)
        self.assertEqual("application/json", response["content-type"])
        response_json = response.json()
        self.assertEqual(str(model.id), response_json["id"])
        self.assertEqual(str(model.name), response_json["name"])
        self.assertEqual(str(model.description), response_json["description"])
        self.assertEqual(model.input_shape, response_json["input_shape"])
        self.assertFalse(response_json["has_preprocessing"])
        # check stats
        stats = response_json["stats"]
        self.assertIsNotNone(stats)
        self.assertEqual([[1, 3]], stats["input_size"])
        self.assertIsNotNone(stats["total_input"])
        self.assertIsNotNone(stats["total_mult_adds"])
        self.assertIsNotNone(stats["total_output_bytes"])
        self.assertIsNotNone(stats["total_param_bytes"])
        self.assertIsNotNone(stats["total_params"])
        self.assertIsNotNone(stats["trainable_params"])
        # layer 1 stats
        layer1 = stats["summary_list"][0]
        self.assertEqual("Sequential", layer1["class_name"])
        self.assertEqual(0, layer1["depth"])
        self.assertEqual(1, layer1["depth_index"])
        self.assertEqual(True, layer1["executed"])
        self.assertEqual("Sequential", layer1["var_name"])
        self.assertEqual(False, layer1["is_leaf_layer"])
        self.assertEqual(False, layer1["contains_lazy_param"])
        self.assertEqual(False, layer1["is_recursive"])
        self.assertEqual([1, 3], layer1["input_size"])
        self.assertEqual([1, 1], layer1["output_size"])
        self.assertEqual(None, layer1["kernel_size"])
        self.assertIsNotNone(layer1["trainable_params"])
        self.assertIsNotNone(layer1["num_params"])
        self.assertIsNotNone(layer1["param_bytes"])
        self.assertIsNotNone(layer1["output_bytes"])
        self.assertIsNotNone(layer1["macs"])
        # layer 2 stats
        layer2 = stats["summary_list"][1]
        self.assertEqual("Linear", layer2["class_name"])
        self.assertEqual(1, layer2["depth"])
        self.assertEqual(1, layer2["depth_index"])
        self.assertEqual(True, layer2["executed"])
        self.assertEqual("0", layer2["var_name"])
        self.assertEqual(True, layer2["is_leaf_layer"])
        self.assertEqual(False, layer2["contains_lazy_param"])
        self.assertEqual(False, layer2["is_recursive"])
        self.assertEqual([1, 3], layer2["input_size"])
        self.assertEqual([1, 64], layer2["output_size"])
        self.assertEqual(None, layer2["kernel_size"])
        self.assertIsNotNone(layer2["trainable_params"])
        self.assertIsNotNone(layer2["num_params"])
        self.assertIsNotNone(layer2["param_bytes"])
        self.assertIsNotNone(layer2["output_bytes"])
        self.assertIsNotNone(layer2["macs"])
        # layer 3 stats
        layer3 = stats["summary_list"][2]
        self.assertEqual("ELU", layer3["class_name"])
        self.assertEqual(1, layer3["depth"])
        self.assertEqual(2, layer3["depth_index"])
        self.assertEqual(True, layer3["executed"])
        self.assertEqual("1", layer3["var_name"])
        self.assertEqual(True, layer3["is_leaf_layer"])
        self.assertEqual(False, layer3["contains_lazy_param"])
        self.assertEqual(False, layer3["is_recursive"])
        self.assertEqual([1, 64], layer3["input_size"])
        self.assertEqual([1, 64], layer3["output_size"])
        self.assertEqual(None, layer3["kernel_size"])
        self.assertIsNotNone(layer3["trainable_params"])
        self.assertIsNotNone(layer3["num_params"])
        self.assertIsNotNone(layer3["param_bytes"])
        self.assertIsNotNone(layer3["output_bytes"])
        self.assertIsNotNone(layer3["macs"])
        # layer 4 stats
        layer4 = stats["summary_list"][3]
        self.assertEqual("Linear", layer4["class_name"])
        self.assertEqual(1, layer4["depth"])
        self.assertEqual(3, layer4["depth_index"])
        self.assertEqual(True, layer4["executed"])
        self.assertEqual("2", layer4["var_name"])
        self.assertEqual(True, layer4["is_leaf_layer"])
        self.assertEqual(False, layer4["contains_lazy_param"])
        self.assertEqual(False, layer4["is_recursive"])
        self.assertEqual([1, 64], layer4["input_size"])
        self.assertEqual([1, 1], layer4["output_size"])
        self.assertEqual(None, layer4["kernel_size"])
        self.assertIsNotNone(layer4["trainable_params"])
        self.assertIsNotNone(layer4["num_params"])
        self.assertIsNotNone(layer4["param_bytes"])
        self.assertIsNotNone(layer4["output_bytes"])
        self.assertIsNotNone(layer4["macs"])

    def test_get_model_metadata_with_preprocessing(self):
        model_bytes = from_torch_module(torch.nn.Sequential(
            torch.nn.Linear(3, 64),
            torch.nn.ELU(),
            torch.nn.Linear(64, 1),
        ))
        torch_model_preprocessing = from_torch_module(transforms.Compose([
            transforms.ToImage(),
            transforms.ToDtype(torch.float32, scale=True),
            transforms.Normalize(mean=(0.,), std=(1.,)),
        ]))
        model = Dummy.create_model(weights=model_bytes, preprocessing=torch_model_preprocessing, input_shape=[None, 3])
        response = self.client.get(f"{BASE_URL}/models/{model.id}/metadata/")
        self.assertEqual(200, response.status_code)
        self.assertEqual("application/json", response["content-type"])
        response_json = response.json()
        self.assertEqual(str(model.id), response_json["id"])
        self.assertEqual(str(model.name), response_json["name"])
        self.assertEqual(str(model.description), response_json["description"])
        self.assertEqual(model.input_shape, response_json["input_shape"])
        self.assertTrue(response_json["has_preprocessing"])

    def test_get_model_metadata_torchscript_model(self):
        torchscript_model_bytes = from_torch_module(torch.jit.script(torch.nn.Sequential(
            torch.nn.Linear(3, 64),
            torch.nn.ELU(),
            torch.nn.Linear(64, 1),
        )))
        model = Dummy.create_model(weights=torchscript_model_bytes, input_shape=[None, 3])
        response = self.client.get(f"{BASE_URL}/models/{model.id}/metadata/")
        self.assertEqual(200, response.status_code)
        self.assertEqual("application/json", response["content-type"])
        response_json = response.json()
        self.assertEqual(str(model.id), response_json["id"])
        self.assertEqual(str(model.name), response_json["name"])
        self.assertEqual(str(model.description), response_json["description"])
        self.assertEqual(model.input_shape, response_json["input_shape"])
        # check stats
        stats = response_json["stats"]
        self.assertIsNotNone(stats)
        self.assertEqual([[1, 3]], stats["input_size"])
        self.assertIsNotNone(stats["total_input"])
        self.assertIsNotNone(stats["total_mult_adds"])
        self.assertIsNotNone(stats["total_output_bytes"])
        self.assertIsNotNone(stats["total_param_bytes"])
        self.assertIsNotNone(stats["total_params"])
        self.assertIsNotNone(stats["trainable_params"])
        self.assertEqual(4, len(stats["summary_list"]))

    def test_get_model(self):
        model = Dummy.create_model(weights=b"Hello World!")
        response = self.client.get(f"{BASE_URL}/models/{model.id}/")
        self.assertEqual(200, response.status_code)
        self.assertEqual("application/octet-stream", response["content-type"])
        self.assertEqual(b"Hello World!", response.getvalue())

    def test_delete_model_without_training_as_model_owner(self):
        model = Dummy.create_model(owner=self.user)
        response = self.client.delete(f"{BASE_URL}/models/{model.id}/")
        self.assertEqual(200, response.status_code)
        body = response.json()
        self.assertEqual("Model removed!", body["detail"])
        self.assertRaises(ObjectDoesNotExist, Model.objects.get, pk=model.id)

    def test_delete_global_model_with_training_as_model_owner(self):
        model = Dummy.create_model(owner=self.user)
        training = Dummy.create_training(model=model)
        response = self.client.delete(f"{BASE_URL}/models/{model.id}/")
        self.assertEqual(200, response.status_code)
        body = response.json()
        self.assertEqual("Model removed!", body["detail"])
        self.assertRaises(ObjectDoesNotExist, Model.objects.get, pk=model.id)
        # due to cascade delete (in the case of GlobalModel), training should also be deleted
        self.assertRaises(ObjectDoesNotExist, Training.objects.get, pk=training.id)

    def test_delete_local_model_with_training_as_model_owner(self):
        global_model = Dummy.create_model()
        local_model = Dummy.create_model_update(base_model=global_model, owner=self.user)
        training = Dummy.create_training(model=global_model)
        response = self.client.delete(f"{BASE_URL}/models/{local_model.id}/")
        self.assertEqual(200, response.status_code)
        body = response.json()
        self.assertEqual("Model removed!", body["detail"])
        self.assertRaises(ObjectDoesNotExist, Model.objects.get, pk=local_model.id)
        self.assertIsNotNone(Model.objects.get(pk=global_model.id))
        self.assertIsNotNone(Training.objects.get(pk=training.id))

    def test_delete_model_as_training_owner(self):
        model = Dummy.create_model()
        training = Dummy.create_training(model=model, actor=self.user)
        response = self.client.delete(f"{BASE_URL}/models/{model.id}/")
        self.assertEqual(200, response.status_code)
        body = response.json()
        self.assertEqual("Model removed!", body["detail"])
        self.assertRaises(ObjectDoesNotExist, Model.objects.get, pk=model.id)
        # due to cascade delete (in the case of GlobalModel), training should also be deleted
        self.assertRaises(ObjectDoesNotExist, Training.objects.get, pk=training.id)

    def test_delete_model_as_training_participant(self):
        model = Dummy.create_model()
        Dummy.create_training(model=model, participants=[Dummy.create_client(), self.user, Dummy.create_client()])
        with self.assertLogs("django.request", level="WARNING"):
            response = self.client.delete(f"{BASE_URL}/models/{model.id}/")
        self.assertEqual(403, response.status_code)
        body = response.json()
        self.assertEqual(
            "You are neither the owner of the model nor the actor of the corresponding training.",
            body["detail"]
        )
        self.assertIsNotNone(Model.objects.get(pk=model.id))

    def test_delete_model_with_training_as_unrelated_user(self):
        model = Dummy.create_model()
        Dummy.create_training(model=model)
        with self.assertLogs("django.request", level="WARNING"):
            response = self.client.delete(f"{BASE_URL}/models/{model.id}/")
        self.assertEqual(403, response.status_code)
        body = response.json()
        self.assertEqual(
            "You are neither the owner of the model nor the actor of the corresponding training.",
            body["detail"]
        )
        self.assertIsNotNone(Model.objects.get(pk=model.id))

    def test_delete_model_without_training_as_unrelated_user(self):
        model = Dummy.create_model()
        with self.assertLogs("django.request", level="WARNING"):
            response = self.client.delete(f"{BASE_URL}/models/{model.id}/")
        self.assertEqual(403, response.status_code)
        body = response.json()
        self.assertEqual(
            "You are neither the owner of the model nor the actor of the corresponding training.",
            body["detail"]
        )
        self.assertIsNotNone(Model.objects.get(pk=model.id))

    def test_delete_non_existing_model(self):
        model_id = str(uuid4())
        with self.assertLogs("django.request", level="WARNING"):
            response = self.client.delete(f"{BASE_URL}/models/{model_id}/")
        self.assertEqual(400, response.status_code)
        body = response.json()
        self.assertEqual(f"Model {model_id} not found.", body["detail"])

    def test_get_model_and_unpickle(self):
        model = Dummy.create_model()
        response = self.client.get(f"{BASE_URL}/models/{model.id}/")
        self.assertEqual(200, response.status_code)
        self.assertEqual("application/octet-stream", response["content-type"])
        torch_model = torch.jit.load(io.BytesIO(response.content))
        self.assertIsNotNone(torch_model)
        self.assertTrue(isinstance(torch_model, torch.nn.Module))

    def test_upload(self):
        torch_model = torch.jit.script(torch.nn.Sequential(
            torch.nn.Linear(3, 64),
            torch.nn.ELU(),
            torch.nn.Linear(64, 64),
            torch.nn.ELU(),
            torch.nn.Linear(64, 1),
        ))
        model_file = SimpleUploadedFile(
            "model.pt",
            from_torch_module(torch_model),  # torchscript model
            content_type="application/octet-stream"
        )
        response = self.client.post(f"{BASE_URL}/models/", {
            "model_file": model_file,
            "name": "Test Model",
            "description": "Test Model Description - Test Model Description Test",
            "input_shape": [None, 3]
        })
        self.assertEqual(201, response.status_code)
        response_json = response.json()
        self.assertIsNotNone(response_json)
        self.assertEqual("Model Upload Accepted", response_json["detail"])
        uuid = response_json["model_id"]
        self.assertIsNotNone(uuid)
        self.assertIsNot("", uuid)
        self.assertEqual(GlobalModel, type(Model.objects.get(id=uuid)))
        self.assertEqual([None, 3], Model.objects.get(id=uuid).input_shape)

    def test_upload_swag_model(self):
        torch_model = torch.jit.script(torch.nn.Sequential(
            torch.nn.Linear(3, 64),
            torch.nn.ELU(),
            torch.nn.Linear(64, 64),
            torch.nn.ELU(),
            torch.nn.Linear(64, 1),
        ))
        model_file = SimpleUploadedFile(
            "model.pt",
            from_torch_module(torch_model),  # torchscript model
            content_type="application/octet-stream"
        )
        response = self.client.post(f"{BASE_URL}/models/", {
            "type": "SWAG",
            "model_file": model_file,
            "name": "Test SWAG Model",
            "description": "Test SWAG Model Description - Test SWAG Model Description Test",
        })
        self.assertEqual(201, response.status_code)
        response_json = response.json()
        self.assertIsNotNone(response_json)
        self.assertEqual("Model Upload Accepted", response_json["detail"])
        uuid = response_json["model_id"]
        self.assertIsNotNone(uuid)
        self.assertIsNot("", uuid)
        self.assertEqual(SWAGModel, type(Model.objects.get(id=uuid)))

    def test_upload_mean_model(self):
        models = [Dummy.create_model(owner=self.user) for _ in range(10)]
        model_uuids = [str(m.id) for m in models]
        response = self.client.post(f"{BASE_URL}/models/", {
            "type": "MEAN",
            "name": "Test MEAN Model",
            "description": "Test MEAN Model Description - Test MEAN Model Description Test",
            "models": model_uuids,
        }, "application/json")
        self.assertEqual(201, response.status_code)
        response_json = response.json()
        self.assertIsNotNone(response_json)
        self.assertEqual("Model Upload Accepted", response_json["detail"])
        uuid = response_json["model_id"]
        self.assertIsNotNone(uuid)
        self.assertIsNot("", uuid)
        self.assertEqual(MeanModel, type(Model.objects.get(id=uuid)))

    def test_upload_with_preprocessing(self):
        torch_model = torch.jit.script(torch.nn.Sequential(
            torch.nn.Linear(3, 64),
            torch.nn.ELU(),
            torch.nn.Linear(64, 1),
        ))
        model_file = SimpleUploadedFile(
            "model.pt",
            from_torch_module(torch_model),  # torchscript model
            content_type="application/octet-stream"
        )
        torch_model_preprocessing = torch.jit.script(torch.nn.Sequential(
            transforms.Normalize(mean=(0.,), std=(1.,)),
        ))
        model_preprocessing_file = SimpleUploadedFile(
            "preprocessing.pt",
            from_torch_module(torch_model_preprocessing),  # torchscript model
            content_type="application/octet-stream"
        )
        response = self.client.post(f"{BASE_URL}/models/", {
            "model_file": model_file,
            "model_preprocessing_file": model_preprocessing_file,
            "name": "Test Model",
            "description": "Test Model Description - Test Model Description Test",
            "input_shape": [None, 3]
        })
        self.assertEqual(201, response.status_code)
        response_json = response.json()
        self.assertIsNotNone(response_json)
        self.assertEqual("Model Upload Accepted", response_json["detail"])
        uuid = response_json["model_id"]
        self.assertIsNotNone(uuid)
        self.assertIsNot("", uuid)
        self.assertEqual(GlobalModel, type(Model.objects.get(id=uuid)))
        self.assertEqual([None, 3], Model.objects.get(id=uuid).input_shape)
        model = get_entity(GlobalModel, pk=uuid)
        self.assertIsNotNone(model)
        self.assertIsNotNone(model.weights)
        self.assertIsNotNone(model.preprocessing)
        self.assertTrue(isinstance(model.get_torch_model(), torch.nn.Module))
        self.assertTrue(isinstance(model.get_preprocessing_torch_model(), torch.nn.Module))

    def test_upload_model_preprocessing(self):
        model = Dummy.create_model(owner=self.user, preprocessing=None)
        torch_model_preprocessing = torch.jit.script(torch.nn.Sequential(
            transforms.Normalize(mean=(0.,), std=(1.,)),
        ))
        model_preprocessing_file = SimpleUploadedFile(
            "preprocessing.pt",
            from_torch_module(torch_model_preprocessing),  # torchscript model
            content_type="application/octet-stream"
        )
        response = self.client.post(f"{BASE_URL}/models/{model.id}/preprocessing/", {
            "model_preprocessing_file": model_preprocessing_file,
        })
        self.assertEqual(202, response.status_code)
        response_json = response.json()
        self.assertIsNotNone(response_json)
        self.assertEqual("Proprocessing Model Upload Accepted", response_json["detail"])
        model.refresh_from_db()
        self.assertIsNotNone(model)
        self.assertIsNotNone(model.preprocessing)
        self.assertTrue(isinstance(model.get_preprocessing_torch_model(), torch.nn.Module))

    def test_upload_model_preprocessing_v1_Compose_bad(self):
        model = Dummy.create_model(owner=self.user, preprocessing=None)
        # torchvision.transforms.Compose (v1 not v2) does not inherit from torch.nn.Module!!
        torch_model_preprocessing = torchvision.transforms.Compose([
            torchvision.transforms.ToTensor(),
            torchvision.transforms.Normalize(mean=(0.,), std=(1.,)),
        ])
        model_preprocessing_file = SimpleUploadedFile(
            "preprocessing.pt",
            from_torch_module(torch_model_preprocessing),  # (normal) transforms.Compose
            content_type="application/octet-stream"
        )
        with self.assertLogs("fl.server", level="ERROR"):  # Loaded torch object is not of expected type.
            with self.assertLogs("django.request", level="WARNING"):  # Bad Request
                response = self.client.post(f"{BASE_URL}/models/{model.id}/preprocessing/", {
                    "model_preprocessing_file": model_preprocessing_file,
                })
        self.assertEqual(400, response.status_code)
        response_json = response.json()
        self.assertIsNotNone(response_json)
        self.assertEqual(
            "Invalid preprocessing file: Loaded torch object is not of expected type.",
            response_json[0],
        )

    def test_upload_model_preprocessing_v2_Compose_good(self):
        # Maybe good now
        model = Dummy.create_model(owner=self.user, preprocessing=None)
        torch_model_preprocessing = transforms.Compose([
            transforms.ToImage(),
            transforms.ToDtype(torch.float32, scale=True),
            transforms.Normalize(mean=(0.,), std=(1.,)),
        ])
        model_preprocessing_file = SimpleUploadedFile(
            "preprocessing.pt",
            from_torch_module(torch_model_preprocessing),  # (normal) transforms.Compose
            content_type="application/octet-stream"
        )
        response = self.client.post(f"{BASE_URL}/models/{model.id}/preprocessing/", {
            "model_preprocessing_file": model_preprocessing_file,
        })
        self.assertEqual(202, response.status_code)
        response_json = response.json()
        self.assertIsNotNone(response_json)
        self.assertEqual("Proprocessing Model Upload Accepted", response_json["detail"])
        model.refresh_from_db()
        self.assertIsNotNone(model)
        self.assertIsNotNone(model.preprocessing)
        self.assertTrue(isinstance(model.get_preprocessing_torch_model(), torch.nn.Module))

    def test_download_model_preprocessing(self):
        torch_model_preprocessing = from_torch_module(torch.jit.script(torch.nn.Sequential(
            transforms.Normalize(mean=(0.,), std=(1.,)),
        )))
        model = Dummy.create_model(owner=self.user, preprocessing=torch_model_preprocessing)
        response = self.client.get(f"{BASE_URL}/models/{model.id}/preprocessing/")
        self.assertEqual(200, response.status_code)
        self.assertEqual("application/octet-stream", response["content-type"])
        torch_model = torch.jit.load(io.BytesIO(response.content))
        self.assertIsNotNone(torch_model)
        self.assertTrue(isinstance(torch_model, torch.nn.Module))

    def test_download_model_preprocessing_with_undefined_preprocessing(self):
        model = Dummy.create_model(owner=self.user, preprocessing=None)
        with self.assertLogs("django.request", level="WARNING") as cm:
            response = self.client.get(f"{BASE_URL}/models/{model.id}/preprocessing/")
        self.assertEqual(cm.output, [
            f"WARNING:django.request:Not Found: /api/models/{model.id}/preprocessing/",
        ])
        self.assertEqual(404, response.status_code)
        response_json = response.json()
        self.assertIsNotNone(response_json)
        self.assertEqual(f"Model '{model.id}' has no preprocessing model defined.", response_json["detail"])

    @patch("fl_server_ai.trainer.tasks.process_trainer_task.apply_async")
    def test_upload_update(self, apply_async: MagicMock):
        model = Dummy.create_model(owner=self.user, round=0)
        Dummy.create_training(model=model, actor=self.user, state=TrainingState.ONGOING,
                              participants=[self.user, Dummy.create_user()])
        model_update_file = SimpleUploadedFile(
            "model.pt",
            from_torch_module(torch.jit.script(torch.nn.Sequential(
                torch.nn.Linear(3, 1),
                torch.nn.Sigmoid()
            ))),
            content_type="application/octet-stream"
        )
        response = self.client.post(
            f"{BASE_URL}/models/{model.id}/",
            {"model_file": model_update_file, "round": 0,
             "sample_size": 100}
        )
        self.assertEqual(201, response.status_code)
        response_json = response.json()
        self.assertIsNotNone(response_json)
        self.assertEqual("Model Update Accepted", response_json["detail"])
        self.assertFalse(apply_async.called)

    def test_upload_update_bad_keys(self):
        model = Dummy.create_model(owner=self.user, round=0)
        model_update_file = SimpleUploadedFile(
            "model.pt",
            from_torch_module(torch.jit.script(torch.nn.Sequential(
                torch.nn.Linear(3, 1),
                torch.nn.Sigmoid()
            ))),
            content_type="application/octet-stream"
        )
        with self.assertLogs("django.request", level="WARNING"):
            response = self.client.post(
                f"{BASE_URL}/models/{model.id}/",
                {"xXx_model_file_xXx": model_update_file, "round": 0, "sample_size": 100}
            )
        self.assertEqual(400, response.status_code)
        response_json = response.json()
        self.assertIsNotNone(response_json)
        self.assertEqual("No uploaded file 'model_file' found.", response_json["detail"])

    def test_upload_update_no_training(self):
        model = Dummy.create_model(owner=self.user, round=0)
        model_update_file = SimpleUploadedFile(
            "model.pt",
            from_torch_module(torch.jit.script(torch.nn.Sequential(
                torch.nn.Linear(3, 1),
                torch.nn.Sigmoid()
            ))),
            content_type="application/octet-stream"
        )
        with self.assertLogs("django.request", level="WARNING"):
            response = self.client.post(
                f"{BASE_URL}/models/{model.id}/",
                {"model_file": model_update_file, "round": 0, "sample_size": 100}
            )
        self.assertEqual(404, response.status_code)
        response_json = response.json()
        self.assertIsNotNone(response_json)
        self.assertEqual(f"Model with ID {model.id} does not have a training process running", response_json["detail"])

    def test_upload_update_no_participant(self):
        self.client.defaults["HTTP_ACCEPT"] = "application/json"
        actor = Dummy.create_actor()
        model = Dummy.create_model(owner=actor, round=0)
        training = Dummy.create_training(
            model=model, actor=actor, state=TrainingState.ONGOING,
            participants=[actor, Dummy.create_client()]
        )
        model_update_file = SimpleUploadedFile(
            "model.pt",
            from_torch_module(torch.jit.script(torch.nn.Sequential(
                torch.nn.Linear(3, 1),
                torch.nn.Sigmoid()
            ))),
            content_type="application/octet-stream"
        )
        with self.assertLogs("root", level="WARNING"):
            response = self.client.post(
                f"{BASE_URL}/models/{model.id}/",
                {"model_file": model_update_file, "round": 0,
                 "sample_size": 500}
            )
        self.assertEqual(403, response.status_code)
        response_json = response.json()
        self.assertIsNotNone(response_json)
        self.assertEqual(f"You are not a participant of training {training.id}!", response_json["detail"])

    @patch("fl_server_ai.trainer.tasks.process_trainer_task.apply_async")
    def test_upload_update_and_aggregate(self, apply_async: MagicMock):
        model = Dummy.create_model(owner=self.user, round=0)
        train = Dummy.create_training(model=model, actor=self.user, state=TrainingState.ONGOING,
                                      participants=[self.user])
        model_update_file = SimpleUploadedFile(
            "model.pt",
            from_torch_module(torch.jit.script(torch.nn.Sequential(
                torch.nn.Linear(3, 1),
                torch.nn.Sigmoid()
            ))),
            content_type="application/octet-stream"
        )
        response = self.client.post(
            f"{BASE_URL}/models/{model.id}/",
            {"model_file": model_update_file, "round": 0,
             "sample_size": 100}
        )
        self.assertEqual(201, response.status_code)
        response_json = response.json()
        self.assertIsNotNone(response_json)
        self.assertEqual("Model Update Accepted", response_json["detail"])
        self.assertTrue(apply_async.called)
        apply_async.assert_called_once_with(
            (),
            {"training_uuid": train.id, "event_cls": TrainingRoundFinished},
            retry=False
        )

    @patch("fl_server_ai.trainer.tasks.process_trainer_task.apply_async")
    def test_upload_update_and_not_aggregate_since_training_is_locked(self, apply_async: MagicMock):
        model = Dummy.create_model(owner=self.user, round=0)
        training = Dummy.create_training(
            model=model, actor=self.user, state=TrainingState.ONGOING, participants=[self.user]
        )
        training.locked = True
        training.save()
        model_update_file = SimpleUploadedFile(
            "model.pt",
            from_torch_module(torch.jit.script(torch.nn.Sequential(
                torch.nn.Linear(3, 1),
                torch.nn.Sigmoid()
            ))),
            content_type="application/octet-stream"
        )
        response = self.client.post(
            f"{BASE_URL}/models/{model.id}/",
            {"model_file": model_update_file, "round": 0,
             "sample_size": 100}
        )
        self.assertEqual(201, response.status_code)
        response_json = response.json()
        self.assertIsNotNone(response_json)
        self.assertEqual("Model Update Accepted", response_json["detail"])
        self.assertFalse(apply_async.called)

    def test_upload_update_with_metrics(self):
        model = Dummy.create_model(owner=self.user, round=0)
        Dummy.create_training(model=model, actor=self.user, state=TrainingState.ONGOING,
                              participants=[self.user, Dummy.create_user()])
        model_update_file = SimpleUploadedFile(
            "model.pt",
            from_torch_module(torch.jit.script(torch.nn.Sequential(
                torch.nn.Linear(3, 1),
                torch.nn.Sigmoid()
            ))),
            content_type="application/octet-stream"
        )

        response = self.client.post(
            f"{BASE_URL}/models/{model.id}/",
            {
                "model_file": model_update_file,
                "round": 0,
                "metric_names": ["loss", "accuracy", "dummy_binary"],
                "metric_values": [1999.0, 0.12, b"Hello World!"],
                "sample_size": 50
            },
        )
        self.assertEqual(201, response.status_code)
        response_json = response.json()
        self.assertIsNotNone(response_json)
        self.assertEqual("Model Update Accepted", response_json["detail"])

    def test_upload_update_with_metrics_bad(self):
        model = Dummy.create_model(owner=self.user)
        Dummy.create_training(model=model, actor=self.user, state=TrainingState.ONGOING,
                              participants=[self.user, Dummy.create_user()])
        model_update_file = SimpleUploadedFile(
            "model.pt",
            from_torch_module(torch.jit.script(torch.nn.Sequential(
                torch.nn.Linear(3, 1),
                torch.nn.Sigmoid()
            ))),
            content_type="application/octet-stream"
        )
        with self.assertLogs("root", level="WARNING"):
            response = self.client.post(
                f"{BASE_URL}/models/{model.id}/",
                {"model_file": model_update_file, "round": 0, "metric_names": 5,
                 "sample_size": 500}
            )
        self.assertEqual(400, response.status_code)

    def test_upload_global_model_metrics(self):
        model = Dummy.create_model(owner=self.user, round=0)
        metrics = dict(
            metric_names=["loss", "accuracy", "dummy_binary"],
            metric_values=[1999.0, 0.12, b"Hello World!"],
        )
        with self.assertLogs("fl.server", level="WARNING") as cm:
            response = self.client.post(
                f"{BASE_URL}/models/{model.id}/metrics/",
                metrics,
            )
        self.assertEqual(cm.output, [
            f"WARNING:fl.server:Global model {model.id} is not connected to any training.",
        ])
        self.assertEqual(201, response.status_code)
        response_json = response.json()
        self.assertIsNotNone(response_json)
        self.assertEqual("Model Metrics Upload Accepted", response_json["detail"])
        self.assertEqual(str(model.id), response_json["model_id"])

    def test_upload_local_model_metrics(self):
        model = Dummy.create_model_update(owner=self.user)
        metrics = dict(
            metric_names=["loss", "accuracy", "dummy_binary"],
            metric_values=[1999.0, 0.12, b"Hello World!"],
        )
        response = self.client.post(
            f"{BASE_URL}/models/{model.id}/metrics/",
            metrics,
        )
        self.assertEqual(201, response.status_code)
        response_json = response.json()
        self.assertIsNotNone(response_json)
        self.assertEqual("Model Metrics Upload Accepted", response_json["detail"])
        self.assertEqual(str(model.id), response_json["model_id"])

    def test_upload_bad_metrics(self):
        model = Dummy.create_model(owner=self.user, round=0)
        metrics = dict(
            metric_names=["loss", "accuracy", "dummy_binary"],
            metric_values=[1999.0, b"Hello World!"],
        )
        with self.assertLogs("django.request", level="WARNING"):
            response = self.client.post(
                f"{BASE_URL}/models/{model.id}/metrics/",
                metrics,
            )
        self.assertEqual(400, response.status_code)
        response_json = response.json()
        self.assertIsNotNone(response_json)
        self.assertEqual("Metric names and values must have the same length", response_json["detail"])

    @patch("fl_server_ai.trainer.tasks.process_trainer_task.apply_async")
    def test_upload_swag_stats(self, apply_async: MagicMock):
        model = Dummy.create_model(owner=self.user, round=0)
        train = Dummy.create_training(
            model=model,
            actor=self.user,
            state=TrainingState.SWAG_ROUND,
            participants=[self.user]
        )

        first_moment_file = SimpleUploadedFile(
            "first_moment.pkl",
            pickle.dumps(torch.nn.Sequential(
                torch.nn.Linear(3, 1),
                torch.nn.Sigmoid()
            ).state_dict()),
            content_type="application/octet-stream"
        )
        second_moment_file = SimpleUploadedFile(
            "second_moment.pkl",
            pickle.dumps(torch.nn.Sequential(
                torch.nn.Linear(3, 1),
                torch.nn.Sigmoid()
            ).state_dict()),
            content_type="application/octet-stream"
        )
        response = self.client.post(f"{BASE_URL}/models/{model.id}/swag/", {
            "first_moment_file": first_moment_file,
            "second_moment_file": second_moment_file,
            "sample_size": 100,
            "round": 0
        })
        self.assertEqual(201, response.status_code)
        response_json = response.json()
        self.assertIsNotNone(response_json)
        self.assertEqual("SWAG Statistic Accepted", response_json["detail"])
        self.assertTrue(apply_async.called)
        apply_async.assert_called_once_with(
            (),
            {"training_uuid": train.id, "event_cls": SWAGRoundFinished},
            retry=False
        )

    def test_get_global_model_metrics(self):
        model = Dummy.create_model(owner=self.user)
        metric = Dummy.create_metric(model=model)
        response = self.client.get(f"{BASE_URL}/models/{model.id}/metrics/")
        self.assertEqual(200, response.status_code)
        body = response.json()
        self.assertEqual(1, len(body))
        self.assertEqual(metric.value_float, body[0]["value_float"])
        self.assertEqual(metric.key, body[0]["key"])

    def test_get_local_model_metrics(self):
        model = Dummy.create_model_update(owner=self.user)
        metric = Dummy.create_metric(model=model)
        response = self.client.get(f"{BASE_URL}/models/{model.id}/metrics/")
        self.assertEqual(200, response.status_code)
        body = response.json()
        self.assertEqual(1, len(body))
        self.assertEqual(metric.value_float, body[0]["value_float"])
        self.assertEqual(metric.key, body[0]["key"])

Functions

setUp
setUp()
Source code in fl_server_api/tests/test_model.py
def setUp(self):
    self.user = Dummy.create_user_and_authenticate(self.client)
test_delete_global_model_with_training_as_model_owner
test_delete_global_model_with_training_as_model_owner()
Source code in fl_server_api/tests/test_model.py
def test_delete_global_model_with_training_as_model_owner(self):
    model = Dummy.create_model(owner=self.user)
    training = Dummy.create_training(model=model)
    response = self.client.delete(f"{BASE_URL}/models/{model.id}/")
    self.assertEqual(200, response.status_code)
    body = response.json()
    self.assertEqual("Model removed!", body["detail"])
    self.assertRaises(ObjectDoesNotExist, Model.objects.get, pk=model.id)
    # due to cascade delete (in the case of GlobalModel), training should also be deleted
    self.assertRaises(ObjectDoesNotExist, Training.objects.get, pk=training.id)
test_delete_local_model_with_training_as_model_owner
test_delete_local_model_with_training_as_model_owner()
Source code in fl_server_api/tests/test_model.py
def test_delete_local_model_with_training_as_model_owner(self):
    global_model = Dummy.create_model()
    local_model = Dummy.create_model_update(base_model=global_model, owner=self.user)
    training = Dummy.create_training(model=global_model)
    response = self.client.delete(f"{BASE_URL}/models/{local_model.id}/")
    self.assertEqual(200, response.status_code)
    body = response.json()
    self.assertEqual("Model removed!", body["detail"])
    self.assertRaises(ObjectDoesNotExist, Model.objects.get, pk=local_model.id)
    self.assertIsNotNone(Model.objects.get(pk=global_model.id))
    self.assertIsNotNone(Training.objects.get(pk=training.id))
test_delete_model_as_training_owner
test_delete_model_as_training_owner()
Source code in fl_server_api/tests/test_model.py
def test_delete_model_as_training_owner(self):
    model = Dummy.create_model()
    training = Dummy.create_training(model=model, actor=self.user)
    response = self.client.delete(f"{BASE_URL}/models/{model.id}/")
    self.assertEqual(200, response.status_code)
    body = response.json()
    self.assertEqual("Model removed!", body["detail"])
    self.assertRaises(ObjectDoesNotExist, Model.objects.get, pk=model.id)
    # due to cascade delete (in the case of GlobalModel), training should also be deleted
    self.assertRaises(ObjectDoesNotExist, Training.objects.get, pk=training.id)
test_delete_model_as_training_participant
test_delete_model_as_training_participant()
Source code in fl_server_api/tests/test_model.py
def test_delete_model_as_training_participant(self):
    model = Dummy.create_model()
    Dummy.create_training(model=model, participants=[Dummy.create_client(), self.user, Dummy.create_client()])
    with self.assertLogs("django.request", level="WARNING"):
        response = self.client.delete(f"{BASE_URL}/models/{model.id}/")
    self.assertEqual(403, response.status_code)
    body = response.json()
    self.assertEqual(
        "You are neither the owner of the model nor the actor of the corresponding training.",
        body["detail"]
    )
    self.assertIsNotNone(Model.objects.get(pk=model.id))
test_delete_model_with_training_as_unrelated_user
test_delete_model_with_training_as_unrelated_user()
Source code in fl_server_api/tests/test_model.py
def test_delete_model_with_training_as_unrelated_user(self):
    model = Dummy.create_model()
    Dummy.create_training(model=model)
    with self.assertLogs("django.request", level="WARNING"):
        response = self.client.delete(f"{BASE_URL}/models/{model.id}/")
    self.assertEqual(403, response.status_code)
    body = response.json()
    self.assertEqual(
        "You are neither the owner of the model nor the actor of the corresponding training.",
        body["detail"]
    )
    self.assertIsNotNone(Model.objects.get(pk=model.id))
test_delete_model_without_training_as_model_owner
test_delete_model_without_training_as_model_owner()
Source code in fl_server_api/tests/test_model.py
def test_delete_model_without_training_as_model_owner(self):
    model = Dummy.create_model(owner=self.user)
    response = self.client.delete(f"{BASE_URL}/models/{model.id}/")
    self.assertEqual(200, response.status_code)
    body = response.json()
    self.assertEqual("Model removed!", body["detail"])
    self.assertRaises(ObjectDoesNotExist, Model.objects.get, pk=model.id)
test_delete_model_without_training_as_unrelated_user
test_delete_model_without_training_as_unrelated_user()
Source code in fl_server_api/tests/test_model.py
def test_delete_model_without_training_as_unrelated_user(self):
    model = Dummy.create_model()
    with self.assertLogs("django.request", level="WARNING"):
        response = self.client.delete(f"{BASE_URL}/models/{model.id}/")
    self.assertEqual(403, response.status_code)
    body = response.json()
    self.assertEqual(
        "You are neither the owner of the model nor the actor of the corresponding training.",
        body["detail"]
    )
    self.assertIsNotNone(Model.objects.get(pk=model.id))
test_delete_non_existing_model
test_delete_non_existing_model()
Source code in fl_server_api/tests/test_model.py
def test_delete_non_existing_model(self):
    model_id = str(uuid4())
    with self.assertLogs("django.request", level="WARNING"):
        response = self.client.delete(f"{BASE_URL}/models/{model_id}/")
    self.assertEqual(400, response.status_code)
    body = response.json()
    self.assertEqual(f"Model {model_id} not found.", body["detail"])
test_download_model_preprocessing
test_download_model_preprocessing()
Source code in fl_server_api/tests/test_model.py
def test_download_model_preprocessing(self):
    torch_model_preprocessing = from_torch_module(torch.jit.script(torch.nn.Sequential(
        transforms.Normalize(mean=(0.,), std=(1.,)),
    )))
    model = Dummy.create_model(owner=self.user, preprocessing=torch_model_preprocessing)
    response = self.client.get(f"{BASE_URL}/models/{model.id}/preprocessing/")
    self.assertEqual(200, response.status_code)
    self.assertEqual("application/octet-stream", response["content-type"])
    torch_model = torch.jit.load(io.BytesIO(response.content))
    self.assertIsNotNone(torch_model)
    self.assertTrue(isinstance(torch_model, torch.nn.Module))
test_download_model_preprocessing_with_undefined_preprocessing
test_download_model_preprocessing_with_undefined_preprocessing()
Source code in fl_server_api/tests/test_model.py
def test_download_model_preprocessing_with_undefined_preprocessing(self):
    model = Dummy.create_model(owner=self.user, preprocessing=None)
    with self.assertLogs("django.request", level="WARNING") as cm:
        response = self.client.get(f"{BASE_URL}/models/{model.id}/preprocessing/")
    self.assertEqual(cm.output, [
        f"WARNING:django.request:Not Found: /api/models/{model.id}/preprocessing/",
    ])
    self.assertEqual(404, response.status_code)
    response_json = response.json()
    self.assertIsNotNone(response_json)
    self.assertEqual(f"Model '{model.id}' has no preprocessing model defined.", response_json["detail"])
test_get_all_models
test_get_all_models()
Source code in fl_server_api/tests/test_model.py
def test_get_all_models(self):
    # make user actor and client
    self.user.actor = True
    self.user.client = True
    self.user.save()
    # create models and trainings - some related to user some not
    [Dummy.create_model() for _ in range(2)]
    models = [Dummy.create_model(owner=self.user) for _ in range(2)]
    [Dummy.create_training() for _ in range(2)]
    trainings = [Dummy.create_training(actor=self.user) for _ in range(2)]
    trainings += [Dummy.create_training(participants=[self.user]) for _ in range(2)]
    models += [t.model for t in trainings]
    # get user related models
    response = self.client.get(f"{BASE_URL}/models/")
    self.assertEqual(200, response.status_code)
    self.assertEqual("application/json", response["content-type"])
    response_json = response.json()
    self.assertEqual(len(models), len(response_json))
    self.assertEqual(
        sorted([str(model.id) for model in models]),
        sorted([model["id"] for model in response_json])
    )
test_get_all_models_for_a_training
test_get_all_models_for_a_training()
Source code in fl_server_api/tests/test_model.py
def test_get_all_models_for_a_training(self):
    # make user actor and client
    self.user.actor = True
    self.user.client = True
    self.user.save()
    # create participants
    participants = [Dummy.create_user() for _ in range(4)]
    participant_rounds = [3, 4, 4, 3]
    # create models and trainings - some related to user some not
    [Dummy.create_training() for _ in range(2)]
    [Dummy.create_training(actor=self.user) for _ in range(2)]
    [Dummy.create_training(participants=[self.user]) for _ in range(2)]
    [Dummy.create_model_update() for _ in range(2)]
    [Dummy.create_model_update(owner=self.user) for _ in range(2)]
    training = Dummy.create_training(actor=self.user, participants=participants)
    # create model update for 4 users
    base_model = training.model
    models = [base_model]
    for participant, rounds in zip(participants, participant_rounds):
        for round_idx in range(rounds):
            model = Dummy.create_model_update(base_model=base_model, owner=participant, round=round_idx+1)
            models.append(model)
    # get user related models for a special training
    response = self.client.get(f"{BASE_URL}/trainings/{training.pk}/models/")
    self.assertEqual(200, response.status_code)
    self.assertEqual("application/json", response["content-type"])
    response_json = response.json()
    self.assertEqual(len(models), len(response_json))
    self.assertEqual(
        sorted([str(model.id) for model in models]),
        sorted([model["id"] for model in response_json])
    )
test_get_all_models_for_a_training_latest_only
test_get_all_models_for_a_training_latest_only()
Source code in fl_server_api/tests/test_model.py
def test_get_all_models_for_a_training_latest_only(self):
    # make user actor and client
    self.user.actor = True
    self.user.client = True
    self.user.save()
    # create participants
    participants = [Dummy.create_user() for _ in range(4)]
    participant_rounds = [3, 4, 4, 3]
    # create models and trainings - some related to user some not
    [Dummy.create_training() for _ in range(2)]
    [Dummy.create_training(actor=self.user) for _ in range(2)]
    [Dummy.create_training(participants=[self.user]) for _ in range(2)]
    [Dummy.create_model_update() for _ in range(2)]
    [Dummy.create_model_update(owner=self.user) for _ in range(2)]
    training = Dummy.create_training(actor=self.user, participants=participants)
    # create model update for 4 users
    base_model = training.model
    models_latest = [base_model]
    for participant, rounds in zip(participants, participant_rounds):
        for round_idx in range(rounds):
            model = Dummy.create_model_update(base_model=base_model, owner=participant, round=round_idx+1)
        models_latest.append(model)
    # get user related "latest" models for a special training
    response = self.client.get(f"{BASE_URL}/trainings/{training.pk}/models/latest/")
    self.assertEqual(200, response.status_code)
    self.assertEqual("application/json", response["content-type"])
    response_json = response.json()
    self.assertEqual(len(models_latest), len(response_json))
    models_latest = sorted(models_latest, key=lambda m: str(m.pk))
    response_models = sorted(response_json, key=lambda m: m["id"])
    self.assertEqual(
        [str(model.id) for model in models_latest],
        [model["id"] for model in response_models]
    )
    self.assertEqual(
        [model.round for model in models_latest],
        [model["round"] for model in response_models]
    )
test_get_global_model_metrics
test_get_global_model_metrics()
Source code in fl_server_api/tests/test_model.py
def test_get_global_model_metrics(self):
    model = Dummy.create_model(owner=self.user)
    metric = Dummy.create_metric(model=model)
    response = self.client.get(f"{BASE_URL}/models/{model.id}/metrics/")
    self.assertEqual(200, response.status_code)
    body = response.json()
    self.assertEqual(1, len(body))
    self.assertEqual(metric.value_float, body[0]["value_float"])
    self.assertEqual(metric.key, body[0]["key"])
test_get_local_model_metrics
test_get_local_model_metrics()
Source code in fl_server_api/tests/test_model.py
def test_get_local_model_metrics(self):
    model = Dummy.create_model_update(owner=self.user)
    metric = Dummy.create_metric(model=model)
    response = self.client.get(f"{BASE_URL}/models/{model.id}/metrics/")
    self.assertEqual(200, response.status_code)
    body = response.json()
    self.assertEqual(1, len(body))
    self.assertEqual(metric.value_float, body[0]["value_float"])
    self.assertEqual(metric.key, body[0]["key"])
test_get_model
test_get_model()
Source code in fl_server_api/tests/test_model.py
def test_get_model(self):
    model = Dummy.create_model(weights=b"Hello World!")
    response = self.client.get(f"{BASE_URL}/models/{model.id}/")
    self.assertEqual(200, response.status_code)
    self.assertEqual("application/octet-stream", response["content-type"])
    self.assertEqual(b"Hello World!", response.getvalue())
test_get_model_and_unpickle
test_get_model_and_unpickle()
Source code in fl_server_api/tests/test_model.py
def test_get_model_and_unpickle(self):
    model = Dummy.create_model()
    response = self.client.get(f"{BASE_URL}/models/{model.id}/")
    self.assertEqual(200, response.status_code)
    self.assertEqual("application/octet-stream", response["content-type"])
    torch_model = torch.jit.load(io.BytesIO(response.content))
    self.assertIsNotNone(torch_model)
    self.assertTrue(isinstance(torch_model, torch.nn.Module))
test_get_model_metadata
test_get_model_metadata()
Source code in fl_server_api/tests/test_model.py
def test_get_model_metadata(self):
    model_bytes = from_torch_module(torch.nn.Sequential(
        torch.nn.Linear(3, 64),
        torch.nn.ELU(),
        torch.nn.Linear(64, 1),
    ))
    model = Dummy.create_model(weights=model_bytes, input_shape=[None, 3])
    response = self.client.get(f"{BASE_URL}/models/{model.id}/metadata/")
    self.assertEqual(200, response.status_code)
    self.assertEqual("application/json", response["content-type"])
    response_json = response.json()
    self.assertEqual(str(model.id), response_json["id"])
    self.assertEqual(str(model.name), response_json["name"])
    self.assertEqual(str(model.description), response_json["description"])
    self.assertEqual(model.input_shape, response_json["input_shape"])
    self.assertFalse(response_json["has_preprocessing"])
    # check stats
    stats = response_json["stats"]
    self.assertIsNotNone(stats)
    self.assertEqual([[1, 3]], stats["input_size"])
    self.assertIsNotNone(stats["total_input"])
    self.assertIsNotNone(stats["total_mult_adds"])
    self.assertIsNotNone(stats["total_output_bytes"])
    self.assertIsNotNone(stats["total_param_bytes"])
    self.assertIsNotNone(stats["total_params"])
    self.assertIsNotNone(stats["trainable_params"])
    # layer 1 stats
    layer1 = stats["summary_list"][0]
    self.assertEqual("Sequential", layer1["class_name"])
    self.assertEqual(0, layer1["depth"])
    self.assertEqual(1, layer1["depth_index"])
    self.assertEqual(True, layer1["executed"])
    self.assertEqual("Sequential", layer1["var_name"])
    self.assertEqual(False, layer1["is_leaf_layer"])
    self.assertEqual(False, layer1["contains_lazy_param"])
    self.assertEqual(False, layer1["is_recursive"])
    self.assertEqual([1, 3], layer1["input_size"])
    self.assertEqual([1, 1], layer1["output_size"])
    self.assertEqual(None, layer1["kernel_size"])
    self.assertIsNotNone(layer1["trainable_params"])
    self.assertIsNotNone(layer1["num_params"])
    self.assertIsNotNone(layer1["param_bytes"])
    self.assertIsNotNone(layer1["output_bytes"])
    self.assertIsNotNone(layer1["macs"])
    # layer 2 stats
    layer2 = stats["summary_list"][1]
    self.assertEqual("Linear", layer2["class_name"])
    self.assertEqual(1, layer2["depth"])
    self.assertEqual(1, layer2["depth_index"])
    self.assertEqual(True, layer2["executed"])
    self.assertEqual("0", layer2["var_name"])
    self.assertEqual(True, layer2["is_leaf_layer"])
    self.assertEqual(False, layer2["contains_lazy_param"])
    self.assertEqual(False, layer2["is_recursive"])
    self.assertEqual([1, 3], layer2["input_size"])
    self.assertEqual([1, 64], layer2["output_size"])
    self.assertEqual(None, layer2["kernel_size"])
    self.assertIsNotNone(layer2["trainable_params"])
    self.assertIsNotNone(layer2["num_params"])
    self.assertIsNotNone(layer2["param_bytes"])
    self.assertIsNotNone(layer2["output_bytes"])
    self.assertIsNotNone(layer2["macs"])
    # layer 3 stats
    layer3 = stats["summary_list"][2]
    self.assertEqual("ELU", layer3["class_name"])
    self.assertEqual(1, layer3["depth"])
    self.assertEqual(2, layer3["depth_index"])
    self.assertEqual(True, layer3["executed"])
    self.assertEqual("1", layer3["var_name"])
    self.assertEqual(True, layer3["is_leaf_layer"])
    self.assertEqual(False, layer3["contains_lazy_param"])
    self.assertEqual(False, layer3["is_recursive"])
    self.assertEqual([1, 64], layer3["input_size"])
    self.assertEqual([1, 64], layer3["output_size"])
    self.assertEqual(None, layer3["kernel_size"])
    self.assertIsNotNone(layer3["trainable_params"])
    self.assertIsNotNone(layer3["num_params"])
    self.assertIsNotNone(layer3["param_bytes"])
    self.assertIsNotNone(layer3["output_bytes"])
    self.assertIsNotNone(layer3["macs"])
    # layer 4 stats
    layer4 = stats["summary_list"][3]
    self.assertEqual("Linear", layer4["class_name"])
    self.assertEqual(1, layer4["depth"])
    self.assertEqual(3, layer4["depth_index"])
    self.assertEqual(True, layer4["executed"])
    self.assertEqual("2", layer4["var_name"])
    self.assertEqual(True, layer4["is_leaf_layer"])
    self.assertEqual(False, layer4["contains_lazy_param"])
    self.assertEqual(False, layer4["is_recursive"])
    self.assertEqual([1, 64], layer4["input_size"])
    self.assertEqual([1, 1], layer4["output_size"])
    self.assertEqual(None, layer4["kernel_size"])
    self.assertIsNotNone(layer4["trainable_params"])
    self.assertIsNotNone(layer4["num_params"])
    self.assertIsNotNone(layer4["param_bytes"])
    self.assertIsNotNone(layer4["output_bytes"])
    self.assertIsNotNone(layer4["macs"])
test_get_model_metadata_torchscript_model
test_get_model_metadata_torchscript_model()
Source code in fl_server_api/tests/test_model.py
def test_get_model_metadata_torchscript_model(self):
    torchscript_model_bytes = from_torch_module(torch.jit.script(torch.nn.Sequential(
        torch.nn.Linear(3, 64),
        torch.nn.ELU(),
        torch.nn.Linear(64, 1),
    )))
    model = Dummy.create_model(weights=torchscript_model_bytes, input_shape=[None, 3])
    response = self.client.get(f"{BASE_URL}/models/{model.id}/metadata/")
    self.assertEqual(200, response.status_code)
    self.assertEqual("application/json", response["content-type"])
    response_json = response.json()
    self.assertEqual(str(model.id), response_json["id"])
    self.assertEqual(str(model.name), response_json["name"])
    self.assertEqual(str(model.description), response_json["description"])
    self.assertEqual(model.input_shape, response_json["input_shape"])
    # check stats
    stats = response_json["stats"]
    self.assertIsNotNone(stats)
    self.assertEqual([[1, 3]], stats["input_size"])
    self.assertIsNotNone(stats["total_input"])
    self.assertIsNotNone(stats["total_mult_adds"])
    self.assertIsNotNone(stats["total_output_bytes"])
    self.assertIsNotNone(stats["total_param_bytes"])
    self.assertIsNotNone(stats["total_params"])
    self.assertIsNotNone(stats["trainable_params"])
    self.assertEqual(4, len(stats["summary_list"]))
test_get_model_metadata_with_preprocessing
test_get_model_metadata_with_preprocessing()
Source code in fl_server_api/tests/test_model.py
def test_get_model_metadata_with_preprocessing(self):
    model_bytes = from_torch_module(torch.nn.Sequential(
        torch.nn.Linear(3, 64),
        torch.nn.ELU(),
        torch.nn.Linear(64, 1),
    ))
    torch_model_preprocessing = from_torch_module(transforms.Compose([
        transforms.ToImage(),
        transforms.ToDtype(torch.float32, scale=True),
        transforms.Normalize(mean=(0.,), std=(1.,)),
    ]))
    model = Dummy.create_model(weights=model_bytes, preprocessing=torch_model_preprocessing, input_shape=[None, 3])
    response = self.client.get(f"{BASE_URL}/models/{model.id}/metadata/")
    self.assertEqual(200, response.status_code)
    self.assertEqual("application/json", response["content-type"])
    response_json = response.json()
    self.assertEqual(str(model.id), response_json["id"])
    self.assertEqual(str(model.name), response_json["name"])
    self.assertEqual(str(model.description), response_json["description"])
    self.assertEqual(model.input_shape, response_json["input_shape"])
    self.assertTrue(response_json["has_preprocessing"])
test_unauthorized
test_unauthorized()
Source code in fl_server_api/tests/test_model.py
def test_unauthorized(self):
    del self.client.defaults["HTTP_AUTHORIZATION"]
    with self.assertLogs("root", level="WARNING"):
        response = self.client.post(
            f"{BASE_URL}/models/",
            {"model_file": b"Hello World!"}
        )
    self.assertEqual(401, response.status_code)
    response_json = response.json()
    self.assertIsNotNone(response_json)
    self.assertEqual("Authentication credentials were not provided.", response_json["detail"])
test_upload
test_upload()
Source code in fl_server_api/tests/test_model.py
def test_upload(self):
    torch_model = torch.jit.script(torch.nn.Sequential(
        torch.nn.Linear(3, 64),
        torch.nn.ELU(),
        torch.nn.Linear(64, 64),
        torch.nn.ELU(),
        torch.nn.Linear(64, 1),
    ))
    model_file = SimpleUploadedFile(
        "model.pt",
        from_torch_module(torch_model),  # torchscript model
        content_type="application/octet-stream"
    )
    response = self.client.post(f"{BASE_URL}/models/", {
        "model_file": model_file,
        "name": "Test Model",
        "description": "Test Model Description - Test Model Description Test",
        "input_shape": [None, 3]
    })
    self.assertEqual(201, response.status_code)
    response_json = response.json()
    self.assertIsNotNone(response_json)
    self.assertEqual("Model Upload Accepted", response_json["detail"])
    uuid = response_json["model_id"]
    self.assertIsNotNone(uuid)
    self.assertIsNot("", uuid)
    self.assertEqual(GlobalModel, type(Model.objects.get(id=uuid)))
    self.assertEqual([None, 3], Model.objects.get(id=uuid).input_shape)
test_upload_bad_metrics
test_upload_bad_metrics()
Source code in fl_server_api/tests/test_model.py
def test_upload_bad_metrics(self):
    model = Dummy.create_model(owner=self.user, round=0)
    metrics = dict(
        metric_names=["loss", "accuracy", "dummy_binary"],
        metric_values=[1999.0, b"Hello World!"],
    )
    with self.assertLogs("django.request", level="WARNING"):
        response = self.client.post(
            f"{BASE_URL}/models/{model.id}/metrics/",
            metrics,
        )
    self.assertEqual(400, response.status_code)
    response_json = response.json()
    self.assertIsNotNone(response_json)
    self.assertEqual("Metric names and values must have the same length", response_json["detail"])
test_upload_global_model_metrics
test_upload_global_model_metrics()
Source code in fl_server_api/tests/test_model.py
def test_upload_global_model_metrics(self):
    model = Dummy.create_model(owner=self.user, round=0)
    metrics = dict(
        metric_names=["loss", "accuracy", "dummy_binary"],
        metric_values=[1999.0, 0.12, b"Hello World!"],
    )
    with self.assertLogs("fl.server", level="WARNING") as cm:
        response = self.client.post(
            f"{BASE_URL}/models/{model.id}/metrics/",
            metrics,
        )
    self.assertEqual(cm.output, [
        f"WARNING:fl.server:Global model {model.id} is not connected to any training.",
    ])
    self.assertEqual(201, response.status_code)
    response_json = response.json()
    self.assertIsNotNone(response_json)
    self.assertEqual("Model Metrics Upload Accepted", response_json["detail"])
    self.assertEqual(str(model.id), response_json["model_id"])
test_upload_local_model_metrics
test_upload_local_model_metrics()
Source code in fl_server_api/tests/test_model.py
def test_upload_local_model_metrics(self):
    model = Dummy.create_model_update(owner=self.user)
    metrics = dict(
        metric_names=["loss", "accuracy", "dummy_binary"],
        metric_values=[1999.0, 0.12, b"Hello World!"],
    )
    response = self.client.post(
        f"{BASE_URL}/models/{model.id}/metrics/",
        metrics,
    )
    self.assertEqual(201, response.status_code)
    response_json = response.json()
    self.assertIsNotNone(response_json)
    self.assertEqual("Model Metrics Upload Accepted", response_json["detail"])
    self.assertEqual(str(model.id), response_json["model_id"])
test_upload_mean_model
test_upload_mean_model()
Source code in fl_server_api/tests/test_model.py
def test_upload_mean_model(self):
    models = [Dummy.create_model(owner=self.user) for _ in range(10)]
    model_uuids = [str(m.id) for m in models]
    response = self.client.post(f"{BASE_URL}/models/", {
        "type": "MEAN",
        "name": "Test MEAN Model",
        "description": "Test MEAN Model Description - Test MEAN Model Description Test",
        "models": model_uuids,
    }, "application/json")
    self.assertEqual(201, response.status_code)
    response_json = response.json()
    self.assertIsNotNone(response_json)
    self.assertEqual("Model Upload Accepted", response_json["detail"])
    uuid = response_json["model_id"]
    self.assertIsNotNone(uuid)
    self.assertIsNot("", uuid)
    self.assertEqual(MeanModel, type(Model.objects.get(id=uuid)))
test_upload_model_preprocessing
test_upload_model_preprocessing()
Source code in fl_server_api/tests/test_model.py
def test_upload_model_preprocessing(self):
    model = Dummy.create_model(owner=self.user, preprocessing=None)
    torch_model_preprocessing = torch.jit.script(torch.nn.Sequential(
        transforms.Normalize(mean=(0.,), std=(1.,)),
    ))
    model_preprocessing_file = SimpleUploadedFile(
        "preprocessing.pt",
        from_torch_module(torch_model_preprocessing),  # torchscript model
        content_type="application/octet-stream"
    )
    response = self.client.post(f"{BASE_URL}/models/{model.id}/preprocessing/", {
        "model_preprocessing_file": model_preprocessing_file,
    })
    self.assertEqual(202, response.status_code)
    response_json = response.json()
    self.assertIsNotNone(response_json)
    self.assertEqual("Proprocessing Model Upload Accepted", response_json["detail"])
    model.refresh_from_db()
    self.assertIsNotNone(model)
    self.assertIsNotNone(model.preprocessing)
    self.assertTrue(isinstance(model.get_preprocessing_torch_model(), torch.nn.Module))
test_upload_model_preprocessing_v1_Compose_bad
test_upload_model_preprocessing_v1_Compose_bad()
Source code in fl_server_api/tests/test_model.py
def test_upload_model_preprocessing_v1_Compose_bad(self):
    model = Dummy.create_model(owner=self.user, preprocessing=None)
    # torchvision.transforms.Compose (v1 not v2) does not inherit from torch.nn.Module!!
    torch_model_preprocessing = torchvision.transforms.Compose([
        torchvision.transforms.ToTensor(),
        torchvision.transforms.Normalize(mean=(0.,), std=(1.,)),
    ])
    model_preprocessing_file = SimpleUploadedFile(
        "preprocessing.pt",
        from_torch_module(torch_model_preprocessing),  # (normal) transforms.Compose
        content_type="application/octet-stream"
    )
    with self.assertLogs("fl.server", level="ERROR"):  # Loaded torch object is not of expected type.
        with self.assertLogs("django.request", level="WARNING"):  # Bad Request
            response = self.client.post(f"{BASE_URL}/models/{model.id}/preprocessing/", {
                "model_preprocessing_file": model_preprocessing_file,
            })
    self.assertEqual(400, response.status_code)
    response_json = response.json()
    self.assertIsNotNone(response_json)
    self.assertEqual(
        "Invalid preprocessing file: Loaded torch object is not of expected type.",
        response_json[0],
    )
test_upload_model_preprocessing_v2_Compose_good
test_upload_model_preprocessing_v2_Compose_good()
Source code in fl_server_api/tests/test_model.py
def test_upload_model_preprocessing_v2_Compose_good(self):
    # Maybe good now
    model = Dummy.create_model(owner=self.user, preprocessing=None)
    torch_model_preprocessing = transforms.Compose([
        transforms.ToImage(),
        transforms.ToDtype(torch.float32, scale=True),
        transforms.Normalize(mean=(0.,), std=(1.,)),
    ])
    model_preprocessing_file = SimpleUploadedFile(
        "preprocessing.pt",
        from_torch_module(torch_model_preprocessing),  # (normal) transforms.Compose
        content_type="application/octet-stream"
    )
    response = self.client.post(f"{BASE_URL}/models/{model.id}/preprocessing/", {
        "model_preprocessing_file": model_preprocessing_file,
    })
    self.assertEqual(202, response.status_code)
    response_json = response.json()
    self.assertIsNotNone(response_json)
    self.assertEqual("Proprocessing Model Upload Accepted", response_json["detail"])
    model.refresh_from_db()
    self.assertIsNotNone(model)
    self.assertIsNotNone(model.preprocessing)
    self.assertTrue(isinstance(model.get_preprocessing_torch_model(), torch.nn.Module))
test_upload_swag_model
test_upload_swag_model()
Source code in fl_server_api/tests/test_model.py
def test_upload_swag_model(self):
    torch_model = torch.jit.script(torch.nn.Sequential(
        torch.nn.Linear(3, 64),
        torch.nn.ELU(),
        torch.nn.Linear(64, 64),
        torch.nn.ELU(),
        torch.nn.Linear(64, 1),
    ))
    model_file = SimpleUploadedFile(
        "model.pt",
        from_torch_module(torch_model),  # torchscript model
        content_type="application/octet-stream"
    )
    response = self.client.post(f"{BASE_URL}/models/", {
        "type": "SWAG",
        "model_file": model_file,
        "name": "Test SWAG Model",
        "description": "Test SWAG Model Description - Test SWAG Model Description Test",
    })
    self.assertEqual(201, response.status_code)
    response_json = response.json()
    self.assertIsNotNone(response_json)
    self.assertEqual("Model Upload Accepted", response_json["detail"])
    uuid = response_json["model_id"]
    self.assertIsNotNone(uuid)
    self.assertIsNot("", uuid)
    self.assertEqual(SWAGModel, type(Model.objects.get(id=uuid)))
test_upload_swag_stats
test_upload_swag_stats(apply_async: MagicMock)
Source code in fl_server_api/tests/test_model.py
@patch("fl_server_ai.trainer.tasks.process_trainer_task.apply_async")
def test_upload_swag_stats(self, apply_async: MagicMock):
    model = Dummy.create_model(owner=self.user, round=0)
    train = Dummy.create_training(
        model=model,
        actor=self.user,
        state=TrainingState.SWAG_ROUND,
        participants=[self.user]
    )

    first_moment_file = SimpleUploadedFile(
        "first_moment.pkl",
        pickle.dumps(torch.nn.Sequential(
            torch.nn.Linear(3, 1),
            torch.nn.Sigmoid()
        ).state_dict()),
        content_type="application/octet-stream"
    )
    second_moment_file = SimpleUploadedFile(
        "second_moment.pkl",
        pickle.dumps(torch.nn.Sequential(
            torch.nn.Linear(3, 1),
            torch.nn.Sigmoid()
        ).state_dict()),
        content_type="application/octet-stream"
    )
    response = self.client.post(f"{BASE_URL}/models/{model.id}/swag/", {
        "first_moment_file": first_moment_file,
        "second_moment_file": second_moment_file,
        "sample_size": 100,
        "round": 0
    })
    self.assertEqual(201, response.status_code)
    response_json = response.json()
    self.assertIsNotNone(response_json)
    self.assertEqual("SWAG Statistic Accepted", response_json["detail"])
    self.assertTrue(apply_async.called)
    apply_async.assert_called_once_with(
        (),
        {"training_uuid": train.id, "event_cls": SWAGRoundFinished},
        retry=False
    )
test_upload_update
test_upload_update(apply_async: MagicMock)
Source code in fl_server_api/tests/test_model.py
@patch("fl_server_ai.trainer.tasks.process_trainer_task.apply_async")
def test_upload_update(self, apply_async: MagicMock):
    model = Dummy.create_model(owner=self.user, round=0)
    Dummy.create_training(model=model, actor=self.user, state=TrainingState.ONGOING,
                          participants=[self.user, Dummy.create_user()])
    model_update_file = SimpleUploadedFile(
        "model.pt",
        from_torch_module(torch.jit.script(torch.nn.Sequential(
            torch.nn.Linear(3, 1),
            torch.nn.Sigmoid()
        ))),
        content_type="application/octet-stream"
    )
    response = self.client.post(
        f"{BASE_URL}/models/{model.id}/",
        {"model_file": model_update_file, "round": 0,
         "sample_size": 100}
    )
    self.assertEqual(201, response.status_code)
    response_json = response.json()
    self.assertIsNotNone(response_json)
    self.assertEqual("Model Update Accepted", response_json["detail"])
    self.assertFalse(apply_async.called)
test_upload_update_and_aggregate
test_upload_update_and_aggregate(apply_async: MagicMock)
Source code in fl_server_api/tests/test_model.py
@patch("fl_server_ai.trainer.tasks.process_trainer_task.apply_async")
def test_upload_update_and_aggregate(self, apply_async: MagicMock):
    model = Dummy.create_model(owner=self.user, round=0)
    train = Dummy.create_training(model=model, actor=self.user, state=TrainingState.ONGOING,
                                  participants=[self.user])
    model_update_file = SimpleUploadedFile(
        "model.pt",
        from_torch_module(torch.jit.script(torch.nn.Sequential(
            torch.nn.Linear(3, 1),
            torch.nn.Sigmoid()
        ))),
        content_type="application/octet-stream"
    )
    response = self.client.post(
        f"{BASE_URL}/models/{model.id}/",
        {"model_file": model_update_file, "round": 0,
         "sample_size": 100}
    )
    self.assertEqual(201, response.status_code)
    response_json = response.json()
    self.assertIsNotNone(response_json)
    self.assertEqual("Model Update Accepted", response_json["detail"])
    self.assertTrue(apply_async.called)
    apply_async.assert_called_once_with(
        (),
        {"training_uuid": train.id, "event_cls": TrainingRoundFinished},
        retry=False
    )
test_upload_update_and_not_aggregate_since_training_is_locked
test_upload_update_and_not_aggregate_since_training_is_locked(apply_async: MagicMock)
Source code in fl_server_api/tests/test_model.py
@patch("fl_server_ai.trainer.tasks.process_trainer_task.apply_async")
def test_upload_update_and_not_aggregate_since_training_is_locked(self, apply_async: MagicMock):
    model = Dummy.create_model(owner=self.user, round=0)
    training = Dummy.create_training(
        model=model, actor=self.user, state=TrainingState.ONGOING, participants=[self.user]
    )
    training.locked = True
    training.save()
    model_update_file = SimpleUploadedFile(
        "model.pt",
        from_torch_module(torch.jit.script(torch.nn.Sequential(
            torch.nn.Linear(3, 1),
            torch.nn.Sigmoid()
        ))),
        content_type="application/octet-stream"
    )
    response = self.client.post(
        f"{BASE_URL}/models/{model.id}/",
        {"model_file": model_update_file, "round": 0,
         "sample_size": 100}
    )
    self.assertEqual(201, response.status_code)
    response_json = response.json()
    self.assertIsNotNone(response_json)
    self.assertEqual("Model Update Accepted", response_json["detail"])
    self.assertFalse(apply_async.called)
test_upload_update_bad_keys
test_upload_update_bad_keys()
Source code in fl_server_api/tests/test_model.py
def test_upload_update_bad_keys(self):
    model = Dummy.create_model(owner=self.user, round=0)
    model_update_file = SimpleUploadedFile(
        "model.pt",
        from_torch_module(torch.jit.script(torch.nn.Sequential(
            torch.nn.Linear(3, 1),
            torch.nn.Sigmoid()
        ))),
        content_type="application/octet-stream"
    )
    with self.assertLogs("django.request", level="WARNING"):
        response = self.client.post(
            f"{BASE_URL}/models/{model.id}/",
            {"xXx_model_file_xXx": model_update_file, "round": 0, "sample_size": 100}
        )
    self.assertEqual(400, response.status_code)
    response_json = response.json()
    self.assertIsNotNone(response_json)
    self.assertEqual("No uploaded file 'model_file' found.", response_json["detail"])
test_upload_update_no_participant
test_upload_update_no_participant()
Source code in fl_server_api/tests/test_model.py
def test_upload_update_no_participant(self):
    self.client.defaults["HTTP_ACCEPT"] = "application/json"
    actor = Dummy.create_actor()
    model = Dummy.create_model(owner=actor, round=0)
    training = Dummy.create_training(
        model=model, actor=actor, state=TrainingState.ONGOING,
        participants=[actor, Dummy.create_client()]
    )
    model_update_file = SimpleUploadedFile(
        "model.pt",
        from_torch_module(torch.jit.script(torch.nn.Sequential(
            torch.nn.Linear(3, 1),
            torch.nn.Sigmoid()
        ))),
        content_type="application/octet-stream"
    )
    with self.assertLogs("root", level="WARNING"):
        response = self.client.post(
            f"{BASE_URL}/models/{model.id}/",
            {"model_file": model_update_file, "round": 0,
             "sample_size": 500}
        )
    self.assertEqual(403, response.status_code)
    response_json = response.json()
    self.assertIsNotNone(response_json)
    self.assertEqual(f"You are not a participant of training {training.id}!", response_json["detail"])
test_upload_update_no_training
test_upload_update_no_training()
Source code in fl_server_api/tests/test_model.py
def test_upload_update_no_training(self):
    model = Dummy.create_model(owner=self.user, round=0)
    model_update_file = SimpleUploadedFile(
        "model.pt",
        from_torch_module(torch.jit.script(torch.nn.Sequential(
            torch.nn.Linear(3, 1),
            torch.nn.Sigmoid()
        ))),
        content_type="application/octet-stream"
    )
    with self.assertLogs("django.request", level="WARNING"):
        response = self.client.post(
            f"{BASE_URL}/models/{model.id}/",
            {"model_file": model_update_file, "round": 0, "sample_size": 100}
        )
    self.assertEqual(404, response.status_code)
    response_json = response.json()
    self.assertIsNotNone(response_json)
    self.assertEqual(f"Model with ID {model.id} does not have a training process running", response_json["detail"])
test_upload_update_with_metrics
test_upload_update_with_metrics()
Source code in fl_server_api/tests/test_model.py
def test_upload_update_with_metrics(self):
    model = Dummy.create_model(owner=self.user, round=0)
    Dummy.create_training(model=model, actor=self.user, state=TrainingState.ONGOING,
                          participants=[self.user, Dummy.create_user()])
    model_update_file = SimpleUploadedFile(
        "model.pt",
        from_torch_module(torch.jit.script(torch.nn.Sequential(
            torch.nn.Linear(3, 1),
            torch.nn.Sigmoid()
        ))),
        content_type="application/octet-stream"
    )

    response = self.client.post(
        f"{BASE_URL}/models/{model.id}/",
        {
            "model_file": model_update_file,
            "round": 0,
            "metric_names": ["loss", "accuracy", "dummy_binary"],
            "metric_values": [1999.0, 0.12, b"Hello World!"],
            "sample_size": 50
        },
    )
    self.assertEqual(201, response.status_code)
    response_json = response.json()
    self.assertIsNotNone(response_json)
    self.assertEqual("Model Update Accepted", response_json["detail"])
test_upload_update_with_metrics_bad
test_upload_update_with_metrics_bad()
Source code in fl_server_api/tests/test_model.py
def test_upload_update_with_metrics_bad(self):
    model = Dummy.create_model(owner=self.user)
    Dummy.create_training(model=model, actor=self.user, state=TrainingState.ONGOING,
                          participants=[self.user, Dummy.create_user()])
    model_update_file = SimpleUploadedFile(
        "model.pt",
        from_torch_module(torch.jit.script(torch.nn.Sequential(
            torch.nn.Linear(3, 1),
            torch.nn.Sigmoid()
        ))),
        content_type="application/octet-stream"
    )
    with self.assertLogs("root", level="WARNING"):
        response = self.client.post(
            f"{BASE_URL}/models/{model.id}/",
            {"model_file": model_update_file, "round": 0, "metric_names": 5,
             "sample_size": 500}
        )
    self.assertEqual(400, response.status_code)
test_upload_with_preprocessing
test_upload_with_preprocessing()
Source code in fl_server_api/tests/test_model.py
def test_upload_with_preprocessing(self):
    torch_model = torch.jit.script(torch.nn.Sequential(
        torch.nn.Linear(3, 64),
        torch.nn.ELU(),
        torch.nn.Linear(64, 1),
    ))
    model_file = SimpleUploadedFile(
        "model.pt",
        from_torch_module(torch_model),  # torchscript model
        content_type="application/octet-stream"
    )
    torch_model_preprocessing = torch.jit.script(torch.nn.Sequential(
        transforms.Normalize(mean=(0.,), std=(1.,)),
    ))
    model_preprocessing_file = SimpleUploadedFile(
        "preprocessing.pt",
        from_torch_module(torch_model_preprocessing),  # torchscript model
        content_type="application/octet-stream"
    )
    response = self.client.post(f"{BASE_URL}/models/", {
        "model_file": model_file,
        "model_preprocessing_file": model_preprocessing_file,
        "name": "Test Model",
        "description": "Test Model Description - Test Model Description Test",
        "input_shape": [None, 3]
    })
    self.assertEqual(201, response.status_code)
    response_json = response.json()
    self.assertIsNotNone(response_json)
    self.assertEqual("Model Upload Accepted", response_json["detail"])
    uuid = response_json["model_id"]
    self.assertIsNotNone(uuid)
    self.assertIsNot("", uuid)
    self.assertEqual(GlobalModel, type(Model.objects.get(id=uuid)))
    self.assertEqual([None, 3], Model.objects.get(id=uuid).input_shape)
    model = get_entity(GlobalModel, pk=uuid)
    self.assertIsNotNone(model)
    self.assertIsNotNone(model.weights)
    self.assertIsNotNone(model.preprocessing)
    self.assertTrue(isinstance(model.get_torch_model(), torch.nn.Module))
    self.assertTrue(isinstance(model.get_preprocessing_torch_model(), torch.nn.Module))

Functions