Log In Sign Up
Models:
Daniel Galbraith
DanielG/
slideflow
0
Downloads: 1
[78ef36]: / docs / gan / index.html

Download this file

898 lines (728 with data), 89.3 kB 

  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
<!DOCTYPE html>

<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->

<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->

<head>

  <meta charset="utf-8">

  <meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />



  <meta name="viewport" content="width=device-width, initial-scale=1.0">



  <title>slideflow.gan &mdash; slideflow 3.0.0 documentation</title>































  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />

  <!-- <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> -->

  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />

  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />

    <link rel="index" title="Index" href="../genindex/" />

    <link rel="search" title="Search" href="../search/" />

    <link rel="next" title="slideflow.grad" href="../grad/" />

    <link rel="prev" title="slideflow.io.torch" href="../io_torch/" />









  <script src="../_static/js/modernizr.min.js"></script>



  <!-- Preload the theme fonts -->



<link rel="preload" href="../_static/fonts/FreightSans/freight-sans-book.woff2" as="font" type="font/woff2" crossorigin="anonymous">

<link rel="preload" href="../_static/fonts/FreightSans/freight-sans-medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">

<link rel="preload" href="../_static/fonts/IBMPlexMono/IBMPlexMono-Medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">

<link rel="preload" href="../_static/fonts/FreightSans/freight-sans-bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">

<link rel="preload" href="../_static/fonts/FreightSans/freight-sans-medium-italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">

<link rel="preload" href="../_static/fonts/IBMPlexMono/IBMPlexMono-SemiBold.woff2" as="font" type="font/woff2" crossorigin="anonymous">



<!-- Preload the katex fonts -->



<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Math-Italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">

<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Main-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">

<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Main-Bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">

<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Size1-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">

<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Size4-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">

<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Size2-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">

<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Size3-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">

<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Caligraphic-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">

  <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.15.2/css/all.css" integrity="sha384-vSIIfh2YWi9wW0r9iZe7RJPrKwp6bG+s9QZMoITbCckVJqGCCRhc+ccxNcdpHuYu" crossorigin="anonymous">

  <script defer data-domain="slideflow.dev" src="https://plausible.io/js/script.js"></script>

</head>



<div class="container-fluid header-holder tutorials-header" id="header-holder">

  <div class="container">

    <div class="header-container">

      <a class="header-logo" href="https://slideflow.dev" aria-label="Slideflow"></a>



      <div class="main-menu">

        <ul>

          <li class="active">

            <a href="https://slideflow.dev">Docs</a>

          </li>



          <li>

            <a href="https://slideflow.dev/tutorial1/">Tutorials</a>

          </li>



          <li>

            <a href="https://github.com/slideflow/slideflow">GitHub</a>

          </li>

        </ul>

      </div>



      <a class="main-menu-open-button" href="#" data-behavior="open-mobile-menu"></a>

    </div>

  </div>

</div>



<body class="pytorch-body">











    <div class="table-of-contents-link-wrapper">

      <span>Table of Contents</span>

      <a href="#" class="toggle-table-of-contents" data-behavior="toggle-table-of-contents"></a>

    </div>



    <nav data-toggle="wy-nav-shift" class="pytorch-left-menu" id="pytorch-left-menu">

      <div class="pytorch-side-scroll">

        <div class="pytorch-menu pytorch-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">

          <div class="pytorch-left-menu-search">











                <div class="version">

                  3.0

                </div>



















<div role="search">

  <form id="rtd-search-form" class="wy-form" action="../search/" method="get">

    <input type="text" name="q" placeholder="Search Docs" />

    <input type="hidden" name="check_keywords" value="yes" />

    <input type="hidden" name="area" value="default" />

  </form>

</div>





          </div>















              <p class="caption" role="heading"><span class="caption-text">Introduction</span></p>

<ul>

<li class="toctree-l1"><a class="reference internal" href="../installation/">Installation</a></li>

<li class="toctree-l1"><a class="reference internal" href="../overview/">Overview</a></li>

<li class="toctree-l1"><a class="reference internal" href="../quickstart/">Quickstart</a></li>

<li class="toctree-l1"><a class="reference internal" href="../project_setup/">Setting up a Project</a></li>

<li class="toctree-l1"><a class="reference internal" href="../datasets_and_val/">Datasets</a></li>

<li class="toctree-l1"><a class="reference internal" href="../slide_processing/">Slide Processing</a></li>

<li class="toctree-l1"><a class="reference internal" href="../training/">Training</a></li>

<li class="toctree-l1"><a class="reference internal" href="../evaluation/">Evaluation</a></li>

<li class="toctree-l1"><a class="reference internal" href="../posthoc/">Layer Activations</a></li>

<li class="toctree-l1"><a class="reference internal" href="../uq/">Uncertainty Quantification</a></li>

<li class="toctree-l1"><a class="reference internal" href="../features/">Generating Features</a></li>

<li class="toctree-l1"><a class="reference internal" href="../mil/">Multiple-Instance Learning (MIL)</a></li>

<li class="toctree-l1"><a class="reference internal" href="../ssl/">Self-Supervised Learning (SSL)</a></li>

<li class="toctree-l1"><a class="reference internal" href="../stylegan/">Generative Networks (GANs)</a></li>

<li class="toctree-l1"><a class="reference internal" href="../saliency/">Saliency Maps</a></li>

<li class="toctree-l1"><a class="reference internal" href="../segmentation/">Tissue Segmentation</a></li>

<li class="toctree-l1"><a class="reference internal" href="../cellseg/">Cell Segmentation</a></li>

<li class="toctree-l1"><a class="reference internal" href="../custom_loops/">Custom Training Loops</a></li>

<li class="toctree-l1"><a class="reference internal" href="../studio/">Slideflow Studio: Live Visualization</a></li>

<li class="toctree-l1"><a class="reference internal" href="../troubleshooting/">Troubleshooting</a></li>

</ul>

<p class="caption" role="heading"><span class="caption-text">Developer Notes</span></p>

<ul>

<li class="toctree-l1"><a class="reference internal" href="../tfrecords/">TFRecords: Reading and Writing</a></li>

<li class="toctree-l1"><a class="reference internal" href="../dataloaders/">Dataloaders: Sampling and Augmentation</a></li>

<li class="toctree-l1"><a class="reference internal" href="../custom_extractors/">Custom Feature Extractors</a></li>

<li class="toctree-l1"><a class="reference internal" href="../tile_labels/">Strong Supervision with Tile Labels</a></li>

<li class="toctree-l1"><a class="reference internal" href="../plugins/">Creating a Slideflow Plugin</a></li>

</ul>

<p class="caption" role="heading"><span class="caption-text">API</span></p>

<ul class="current">

<li class="toctree-l1"><a class="reference internal" href="../slideflow/">slideflow</a></li>

<li class="toctree-l1"><a class="reference internal" href="../project/">slideflow.Project</a></li>

<li class="toctree-l1"><a class="reference internal" href="../dataset/">slideflow.Dataset</a></li>

<li class="toctree-l1"><a class="reference internal" href="../dataset_features/">slideflow.DatasetFeatures</a></li>

<li class="toctree-l1"><a class="reference internal" href="../heatmap/">slideflow.Heatmap</a></li>

<li class="toctree-l1"><a class="reference internal" href="../model_params/">slideflow.ModelParams</a></li>

<li class="toctree-l1"><a class="reference internal" href="../mosaic/">slideflow.Mosaic</a></li>

<li class="toctree-l1"><a class="reference internal" href="../slidemap/">slideflow.SlideMap</a></li>

<li class="toctree-l1"><a class="reference internal" href="../biscuit/">slideflow.biscuit</a></li>

<li class="toctree-l1"><a class="reference internal" href="../slideflow_cellseg/">slideflow.cellseg</a></li>

<li class="toctree-l1"><a class="reference internal" href="../io/">slideflow.io</a></li>

<li class="toctree-l1"><a class="reference internal" href="../io_tensorflow/">slideflow.io.tensorflow</a></li>

<li class="toctree-l1"><a class="reference internal" href="../io_torch/">slideflow.io.torch</a></li>

<li class="toctree-l1 current"><a class="current reference internal" href="#">slideflow.gan</a></li>

<li class="toctree-l1"><a class="reference internal" href="../grad/">slideflow.grad</a></li>

<li class="toctree-l1"><a class="reference internal" href="../mil_module/">slideflow.mil</a></li>

<li class="toctree-l1"><a class="reference internal" href="../model/">slideflow.model</a></li>

<li class="toctree-l1"><a class="reference internal" href="../model_tensorflow/">slideflow.model.tensorflow</a></li>

<li class="toctree-l1"><a class="reference internal" href="../model_torch/">slideflow.model.torch</a></li>

<li class="toctree-l1"><a class="reference internal" href="../norm/">slideflow.norm</a></li>

<li class="toctree-l1"><a class="reference internal" href="../simclr/">slideflow.simclr</a></li>

<li class="toctree-l1"><a class="reference internal" href="../slide/">slideflow.slide</a></li>

<li class="toctree-l1"><a class="reference internal" href="../slide_qc/">slideflow.slide.qc</a></li>

<li class="toctree-l1"><a class="reference internal" href="../stats/">slideflow.stats</a></li>

<li class="toctree-l1"><a class="reference internal" href="../util/">slideflow.util</a></li>

<li class="toctree-l1"><a class="reference internal" href="../studio_module/">slideflow.studio</a></li>

</ul>

<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>

<ul>

<li class="toctree-l1"><a class="reference internal" href="../tutorial1/">Tutorial 1: Model training (simple)</a></li>

<li class="toctree-l1"><a class="reference internal" href="../tutorial2/">Tutorial 2: Model training (advanced)</a></li>

<li class="toctree-l1"><a class="reference internal" href="../tutorial3/">Tutorial 3: Using a custom architecture</a></li>

<li class="toctree-l1"><a class="reference internal" href="../tutorial4/">Tutorial 4: Model evaluation &amp; heatmaps</a></li>

<li class="toctree-l1"><a class="reference internal" href="../tutorial5/">Tutorial 5: Creating a mosaic map</a></li>

<li class="toctree-l1"><a class="reference internal" href="../tutorial6/">Tutorial 6: Custom slide filtering</a></li>

<li class="toctree-l1"><a class="reference internal" href="../tutorial7/">Tutorial 7: Training with custom augmentations</a></li>

<li class="toctree-l1"><a class="reference internal" href="../tutorial8/">Tutorial 8: Multiple-Instance Learning</a></li>

</ul>







        </div>

      </div>

    </nav>



    <div class="pytorch-container">

      <div class="pytorch-page-level-bar" id="pytorch-page-level-bar">

        <div class="pytorch-breadcrumbs-wrapper">

































<div role="navigation" aria-label="breadcrumbs navigation">



  <ul class="pytorch-breadcrumbs">



      <li>

        <a href="../">



            Docs



        </a> &gt;

      </li>





      <li>slideflow.gan</li>





      <li class="pytorch-breadcrumbs-aside">





            <a href="../_sources/gan.rst.txt" rel="nofollow"><img src="../_static/images/view-page-source-icon.svg"></a>





      </li>



  </ul>





</div>

        </div>



        <div class="pytorch-shortcuts-wrapper" id="pytorch-shortcuts-wrapper">

          Shortcuts

        </div>

      </div>



      <section data-toggle="wy-nav-shift" id="pytorch-content-wrap" class="pytorch-content-wrap">

        <div class="pytorch-content-left">







          <div class="rst-content">



            <div role="main" class="main-content" itemscope="itemscope" itemtype="http://schema.org/Article">

             <article itemprop="articleBody" id="pytorch-article" class="pytorch-article">



  <section id="module-slideflow.gan">

<span id="slideflow-gan"></span><h1>slideflow.gan<a class="headerlink" href="#module-slideflow.gan" title="Permalink to this heading"></a></h1>

<p>Submodule used to interface with the PyTorch implementation of StyleGAN2

(maintained separately at <a class="reference external" href="https://github.com/jamesdolezal/stylegan2-slideflow">https://github.com/jamesdolezal/stylegan2-slideflow</a>).</p>

<p>See <a class="reference internal" href="../stylegan/#stylegan"><span class="std std-ref">Generative Networks (GANs)</span></a> for more information on working with GANs.</p>

<section id="stylegan2-interpolator">

<h2>StyleGAN2 Interpolator<a class="headerlink" href="#stylegan2-interpolator" title="Permalink to this heading"></a></h2>

<dl class="py class">

<dt class="sig sig-object py" id="slideflow.gan.StyleGAN2Interpolator">

<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">StyleGAN2Interpolator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gan_pkl</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">start</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">end</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">torch.device</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target_um</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target_px</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gan_um</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gan_px</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">noise_mode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'const'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">truncation_psi</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">gan_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/slideflow/gan/interpolate/#StyleGAN2Interpolator"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#slideflow.gan.StyleGAN2Interpolator" title="Permalink to this definition"></a></dt>

<dd><p>Coordinates class and embedding interpolation for a trained

class-conditional StyleGAN2.</p>

<dl class="field-list simple">

<dt class="field-odd">Parameters<span class="colon">:</span></dt>

<dd class="field-odd"><ul class="simple">

<li><p><strong>gan_pkl</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Path to saved network pkl.</p></li>

<li><p><strong>start</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Starting class index.</p></li>

<li><p><strong>end</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Ending class index.</p></li>

</ul>

</dd>

<dt class="field-even">Keyword Arguments<span class="colon">:</span></dt>

<dd class="field-even"><ul class="simple">

<li><p><strong>device</strong> (<em>torch.device</em><em>, </em><em>optional</em>) – Torch device. If None, will

automatically select a GPU if available. Defaults to None.</p></li>

<li><p><strong>target_um</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>, </em><em>optional</em>) – Target size in microns for the

interpolated images. GAN output will be cropped/resized to match

this target. If None, will match GAN output. Defaults to None.</p></li>

<li><p><strong>target_px</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>, </em><em>optional</em>) – Target size in pixels for the

interpolated images. GAN output will be cropped/resized to match

this target. If None, will match GAN output. Defaults to None.</p></li>

<li><p><strong>gan_um</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>, </em><em>optional</em>) – Size in microns of the GAN output. If None,

will attempt to auto-detect from training_options.json.

Defaults to None.</p></li>

<li><p><strong>gan_px</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>, </em><em>optional</em>) – Size in pixels of the GAN output. If None,

will attempt to auto-detect from training_options.json.

Defaults to None.</p></li>

<li><p><strong>noise_mode</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>, </em><em>optional</em>) – Noise mode for GAN. Defaults to ‘const’.</p></li>

<li><p><strong>truncation_psi</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>, </em><em>optional</em>) – Truncation psi for GAN.

Defaults to 1.</p></li>

<li><p><strong>**gan_kwargs</strong> – Additional keyword arguments for GAN inference.</p></li>

</ul>

</dd>

</dl>

<dl class="py method">

<dt class="sig sig-object py" id="slideflow.gan.StyleGAN2Interpolator.__init__">

<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gan_pkl</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">start</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">end</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">torch.device</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target_um</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target_px</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gan_um</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gan_px</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">noise_mode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'const'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">truncation_psi</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">gan_kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><a class="reference internal" href="../_modules/slideflow/gan/interpolate/#StyleGAN2Interpolator.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#slideflow.gan.StyleGAN2Interpolator.__init__" title="Permalink to this definition"></a></dt>

<dd><p>Coordinates class and embedding interpolation for a trained

class-conditional StyleGAN2.</p>

<dl class="field-list simple">

<dt class="field-odd">Parameters<span class="colon">:</span></dt>

<dd class="field-odd"><ul class="simple">

<li><p><strong>gan_pkl</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Path to saved network pkl.</p></li>

<li><p><strong>start</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Starting class index.</p></li>

<li><p><strong>end</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Ending class index.</p></li>

</ul>

</dd>

<dt class="field-even">Keyword Arguments<span class="colon">:</span></dt>

<dd class="field-even"><ul class="simple">

<li><p><strong>device</strong> (<em>torch.device</em><em>, </em><em>optional</em>) – Torch device. If None, will

automatically select a GPU if available. Defaults to None.</p></li>

<li><p><strong>target_um</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>, </em><em>optional</em>) – Target size in microns for the

interpolated images. GAN output will be cropped/resized to match

this target. If None, will match GAN output. Defaults to None.</p></li>

<li><p><strong>target_px</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>, </em><em>optional</em>) – Target size in pixels for the

interpolated images. GAN output will be cropped/resized to match

this target. If None, will match GAN output. Defaults to None.</p></li>

<li><p><strong>gan_um</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>, </em><em>optional</em>) – Size in microns of the GAN output. If None,

will attempt to auto-detect from training_options.json.

Defaults to None.</p></li>

<li><p><strong>gan_px</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>, </em><em>optional</em>) – Size in pixels of the GAN output. If None,

will attempt to auto-detect from training_options.json.

Defaults to None.</p></li>

<li><p><strong>noise_mode</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>, </em><em>optional</em>) – Noise mode for GAN. Defaults to ‘const’.</p></li>

<li><p><strong>truncation_psi</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>, </em><em>optional</em>) – Truncation psi for GAN.

Defaults to 1.</p></li>

<li><p><strong>**gan_kwargs</strong> – Additional keyword arguments for GAN inference.</p></li>

</ul>

</dd>

</dl>

</dd></dl>



<dl class="py method">

<dt class="sig sig-object py" id="slideflow.gan.StyleGAN2Interpolator.class_interpolate">

<span class="sig-name descname"><span class="pre">class_interpolate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">steps</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">100</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Generator" title="(in Python v3.12)"><span class="pre">Generator</span></a></span></span><a class="reference internal" href="../_modules/slideflow/gan/interpolate/#StyleGAN2Interpolator.class_interpolate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#slideflow.gan.StyleGAN2Interpolator.class_interpolate" title="Permalink to this definition"></a></dt>

<dd><p>Sets up a generator that returns images during class embedding

interpolation.</p>

<dl class="field-list simple">

<dt class="field-odd">Parameters<span class="colon">:</span></dt>

<dd class="field-odd"><ul class="simple">

<li><p><strong>seed</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Seed for random noise vector.</p></li>

<li><p><strong>steps</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>, </em><em>optional</em>) – Number of steps for interpolation.

Defaults to 100.</p></li>

</ul>

</dd>

<dt class="field-even">Returns<span class="colon">:</span></dt>

<dd class="field-even"><p>Generator which yields images (torch.tensor, uint8)

during interpolation.</p>

</dd>

<dt class="field-odd">Return type<span class="colon">:</span></dt>

<dd class="field-odd"><p>Generator</p>

</dd>

<dt class="field-even">Yields<span class="colon">:</span></dt>

<dd class="field-even"><p><em>Generator</em> – images (torch.tensor, dtype=uint8)</p>

</dd>

</dl>

</dd></dl>



<dl class="py method">

<dt class="sig sig-object py" id="slideflow.gan.StyleGAN2Interpolator.generate">

<span class="sig-name descname"><span class="pre">generate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.12)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">embedding</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">torch.Tensor</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">torch.Tensor</span></span></span><a class="reference internal" href="../_modules/slideflow/gan/interpolate/#StyleGAN2Interpolator.generate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#slideflow.gan.StyleGAN2Interpolator.generate" title="Permalink to this definition"></a></dt>

<dd><p>Generate an image from a given embedding.</p>

<dl class="field-list simple">

<dt class="field-odd">Parameters<span class="colon">:</span></dt>

<dd class="field-odd"><ul class="simple">

<li><p><strong>seed</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Seed for noise vector.</p></li>

<li><p><strong>embedding</strong> (<em>torch.Tensor</em>) – Class embedding.</p></li>

</ul>

</dd>

<dt class="field-even">Returns<span class="colon">:</span></dt>

<dd class="field-even"><p>Image (float32, shape=(1, 3, height, width))</p>

</dd>

<dt class="field-odd">Return type<span class="colon">:</span></dt>

<dd class="field-odd"><p>torch.Tensor</p>

</dd>

</dl>

</dd></dl>



<dl class="py method">

<dt class="sig sig-object py" id="slideflow.gan.StyleGAN2Interpolator.generate_end">

<span class="sig-name descname"><span class="pre">generate_end</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">torch.Tensor</span></span></span><a class="reference internal" href="../_modules/slideflow/gan/interpolate/#StyleGAN2Interpolator.generate_end"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#slideflow.gan.StyleGAN2Interpolator.generate_end" title="Permalink to this definition"></a></dt>

<dd><p>Generate an image from the ending class.</p>

<dl class="field-list simple">

<dt class="field-odd">Parameters<span class="colon">:</span></dt>

<dd class="field-odd"><p><strong>seed</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Seed for noise vector.</p>

</dd>

<dt class="field-even">Returns<span class="colon">:</span></dt>

<dd class="field-even"><p>Image (float32, shape=(1, 3, height, width))</p>

</dd>

<dt class="field-odd">Return type<span class="colon">:</span></dt>

<dd class="field-odd"><p>torch.Tensor</p>

</dd>

</dl>

</dd></dl>



<dl class="py method">

<dt class="sig sig-object py" id="slideflow.gan.StyleGAN2Interpolator.generate_np_end">

<span class="sig-name descname"><span class="pre">generate_np_end</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span></span></span><a class="reference internal" href="../_modules/slideflow/gan/interpolate/#StyleGAN2Interpolator.generate_np_end"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#slideflow.gan.StyleGAN2Interpolator.generate_np_end" title="Permalink to this definition"></a></dt>

<dd><p>Generate a numpy image from the ending class.</p>

<dl class="field-list simple">

<dt class="field-odd">Parameters<span class="colon">:</span></dt>

<dd class="field-odd"><p><strong>seed</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Seed for noise vector.</p>

</dd>

<dt class="field-even">Returns<span class="colon">:</span></dt>

<dd class="field-even"><p>Image (uint8, shape=(height, width, 3))</p>

</dd>

<dt class="field-odd">Return type<span class="colon">:</span></dt>

<dd class="field-odd"><p>np.ndarray</p>

</dd>

</dl>

</dd></dl>



<dl class="py method">

<dt class="sig sig-object py" id="slideflow.gan.StyleGAN2Interpolator.generate_np_from_embedding">

<span class="sig-name descname"><span class="pre">generate_np_from_embedding</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">embedding</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">torch.Tensor</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span></span></span><a class="reference internal" href="../_modules/slideflow/gan/interpolate/#StyleGAN2Interpolator.generate_np_from_embedding"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#slideflow.gan.StyleGAN2Interpolator.generate_np_from_embedding" title="Permalink to this definition"></a></dt>

<dd><p>Generate a numpy image from a given embedding.</p>

<dl class="field-list simple">

<dt class="field-odd">Parameters<span class="colon">:</span></dt>

<dd class="field-odd"><ul class="simple">

<li><p><strong>seed</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Seed for noise vector.</p></li>

<li><p><strong>embedding</strong> (<em>torch.Tensor</em>) – Class embedding.</p></li>

</ul>

</dd>

<dt class="field-even">Returns<span class="colon">:</span></dt>

<dd class="field-even"><p>Image (uint8, shape=(height, width, 3))</p>

</dd>

<dt class="field-odd">Return type<span class="colon">:</span></dt>

<dd class="field-odd"><p>np.ndarray</p>

</dd>

</dl>

</dd></dl>



<dl class="py method">

<dt class="sig sig-object py" id="slideflow.gan.StyleGAN2Interpolator.generate_np_start">

<span class="sig-name descname"><span class="pre">generate_np_start</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span></span></span><a class="reference internal" href="../_modules/slideflow/gan/interpolate/#StyleGAN2Interpolator.generate_np_start"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#slideflow.gan.StyleGAN2Interpolator.generate_np_start" title="Permalink to this definition"></a></dt>

<dd><p>Generate a numpy image from the starting class.</p>

<dl class="field-list simple">

<dt class="field-odd">Parameters<span class="colon">:</span></dt>

<dd class="field-odd"><p><strong>seed</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Seed for noise vector.</p>

</dd>

<dt class="field-even">Returns<span class="colon">:</span></dt>

<dd class="field-even"><p>Image (uint8, shape=(height, width, 3))</p>

</dd>

<dt class="field-odd">Return type<span class="colon">:</span></dt>

<dd class="field-odd"><p>np.ndarray</p>

</dd>

</dl>

</dd></dl>



<dl class="py method">

<dt class="sig sig-object py" id="slideflow.gan.StyleGAN2Interpolator.generate_start">

<span class="sig-name descname"><span class="pre">generate_start</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">torch.Tensor</span></span></span><a class="reference internal" href="../_modules/slideflow/gan/interpolate/#StyleGAN2Interpolator.generate_start"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#slideflow.gan.StyleGAN2Interpolator.generate_start" title="Permalink to this definition"></a></dt>

<dd><p>Generate an image from the starting class.</p>

<dl class="field-list simple">

<dt class="field-odd">Parameters<span class="colon">:</span></dt>

<dd class="field-odd"><p><strong>seed</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Seed for noise vector.</p>

</dd>

<dt class="field-even">Returns<span class="colon">:</span></dt>

<dd class="field-even"><p>Image (float32, shape=(1, 3, height, width))</p>

</dd>

<dt class="field-odd">Return type<span class="colon">:</span></dt>

<dd class="field-odd"><p>torch.Tensor</p>

</dd>

</dl>

</dd></dl>



<dl class="py method">

<dt class="sig sig-object py" id="slideflow.gan.StyleGAN2Interpolator.generate_tf_end">

<span class="sig-name descname"><span class="pre">generate_tf_end</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><span class="pre">Tuple</span></a><span class="p"><span class="pre">[</span></span><span class="pre">tf.Tensor</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">tf.Tensor</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/slideflow/gan/interpolate/#StyleGAN2Interpolator.generate_tf_end"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#slideflow.gan.StyleGAN2Interpolator.generate_tf_end" title="Permalink to this definition"></a></dt>

<dd><p>Create a processed Tensorflow image from the GAN output of a given

seed and the ending class embedding.</p>

<dl class="field-list simple">

<dt class="field-odd">Parameters<span class="colon">:</span></dt>

<dd class="field-odd"><p><strong>seed</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Seed for noise vector.</p>

</dd>

<dt class="field-even">Returns<span class="colon">:</span></dt>

<dd class="field-even"><p><p>A tuple containing</p>

<blockquote>

<div><p>tf.Tensor: Unprocessed resized image, uint8.</p>

<p>tf.Tensor: Processed resized image, standardized and normalized.</p>

</div></blockquote>

</p>

</dd>

</dl>

</dd></dl>



<dl class="py method">

<dt class="sig sig-object py" id="slideflow.gan.StyleGAN2Interpolator.generate_tf_from_embedding">

<span class="sig-name descname"><span class="pre">generate_tf_from_embedding</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.12)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">embedding</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">torch.Tensor</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><span class="pre">Tuple</span></a><span class="p"><span class="pre">[</span></span><span class="pre">tf.Tensor</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">tf.Tensor</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/slideflow/gan/interpolate/#StyleGAN2Interpolator.generate_tf_from_embedding"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#slideflow.gan.StyleGAN2Interpolator.generate_tf_from_embedding" title="Permalink to this definition"></a></dt>

<dd><p>Create a processed Tensorflow image from the GAN output from a given

seed and embedding.</p>

<dl class="field-list simple">

<dt class="field-odd">Parameters<span class="colon">:</span></dt>

<dd class="field-odd"><ul class="simple">

<li><p><strong>seed</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Seed for noise vector.</p></li>

<li><p><strong>embedding</strong> (<em>torch.tensor</em>) – Class embedding.</p></li>

</ul>

</dd>

<dt class="field-even">Returns<span class="colon">:</span></dt>

<dd class="field-even"><p><p>A tuple containing</p>

<blockquote>

<div><p>tf.Tensor: Unprocessed resized image, uint8.</p>

<p>tf.Tensor: Processed resized image, standardized and normalized.</p>

</div></blockquote>

</p>

</dd>

</dl>

</dd></dl>



<dl class="py method">

<dt class="sig sig-object py" id="slideflow.gan.StyleGAN2Interpolator.generate_tf_start">

<span class="sig-name descname"><span class="pre">generate_tf_start</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><span class="pre">Tuple</span></a><span class="p"><span class="pre">[</span></span><span class="pre">tf.Tensor</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">tf.Tensor</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/slideflow/gan/interpolate/#StyleGAN2Interpolator.generate_tf_start"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#slideflow.gan.StyleGAN2Interpolator.generate_tf_start" title="Permalink to this definition"></a></dt>

<dd><p>Create a processed Tensorflow image from the GAN output of a given

seed and the starting class embedding.</p>

<dl class="field-list simple">

<dt class="field-odd">Parameters<span class="colon">:</span></dt>

<dd class="field-odd"><p><strong>seed</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Seed for noise vector.</p>

</dd>

<dt class="field-even">Returns<span class="colon">:</span></dt>

<dd class="field-even"><p><p>A tuple containing</p>

<blockquote>

<div><p>tf.Tensor: Unprocessed image (tf.Tensor), uint8.</p>

<p>tf.Tensor: Processed image (tf.Tensor), standardized and normalized.</p>

</div></blockquote>

</p>

</dd>

</dl>

</dd></dl>



<dl class="py method">

<dt class="sig sig-object py" id="slideflow.gan.StyleGAN2Interpolator.interpolate_and_predict">

<span class="sig-name descname"><span class="pre">interpolate_and_predict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">steps</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">100</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outcome_idx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><span class="pre">Tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.12)"><span class="pre">List</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/slideflow/gan/interpolate/#StyleGAN2Interpolator.interpolate_and_predict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#slideflow.gan.StyleGAN2Interpolator.interpolate_and_predict" title="Permalink to this definition"></a></dt>

<dd><p>Interpolates between starting and ending classes for a seed,

recording raw images, processed images, and predictions.</p>

<dl class="field-list simple">

<dt class="field-odd">Parameters<span class="colon">:</span></dt>

<dd class="field-odd"><ul class="simple">

<li><p><strong>seed</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Seed for random noise vector.</p></li>

<li><p><strong>steps</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>, </em><em>optional</em>) – Number of steps during interpolation.

Defaults to 100.</p></li>

</ul>

</dd>

<dt class="field-even">Returns<span class="colon">:</span></dt>

<dd class="field-even"><p>Raw images, processed images, and predictions.</p>

</dd>

<dt class="field-odd">Return type<span class="colon">:</span></dt>

<dd class="field-odd"><p>Tuple[List, …]</p>

</dd>

</dl>

</dd></dl>



<dl class="py method">

<dt class="sig sig-object py" id="slideflow.gan.StyleGAN2Interpolator.linear_interpolate">

<span class="sig-name descname"><span class="pre">linear_interpolate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">steps</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">100</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Generator" title="(in Python v3.12)"><span class="pre">Generator</span></a></span></span><a class="reference internal" href="../_modules/slideflow/gan/interpolate/#StyleGAN2Interpolator.linear_interpolate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#slideflow.gan.StyleGAN2Interpolator.linear_interpolate" title="Permalink to this definition"></a></dt>

<dd><p>Sets up a generator that returns images during linear label

interpolation.</p>

<dl class="field-list simple">

<dt class="field-odd">Parameters<span class="colon">:</span></dt>

<dd class="field-odd"><ul class="simple">

<li><p><strong>seed</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Seed for random noise vector.</p></li>

<li><p><strong>steps</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>, </em><em>optional</em>) – Number of steps for interpolation.

Defaults to 100.</p></li>

</ul>

</dd>

<dt class="field-even">Returns<span class="colon">:</span></dt>

<dd class="field-even"><p>Generator which yields images (torch.tensor, uint8)

during interpolation.</p>

</dd>

<dt class="field-odd">Return type<span class="colon">:</span></dt>

<dd class="field-odd"><p>Generator</p>

</dd>

<dt class="field-even">Yields<span class="colon">:</span></dt>

<dd class="field-even"><p><em>Generator</em> – images (torch.tensor, dtype=uint8)</p>

</dd>

</dl>

</dd></dl>



<dl class="py method">

<dt class="sig sig-object py" id="slideflow.gan.StyleGAN2Interpolator.plot_comparison">

<span class="sig-name descname"><span class="pre">plot_comparison</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seeds</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.12)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">titles</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.12)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><a class="reference internal" href="../_modules/slideflow/gan/interpolate/#StyleGAN2Interpolator.plot_comparison"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#slideflow.gan.StyleGAN2Interpolator.plot_comparison" title="Permalink to this definition"></a></dt>

<dd><p>Plots side-by-side comparison of images from the starting

and ending interpolation classes.</p>

<dl class="field-list simple">

<dt class="field-odd">Parameters<span class="colon">:</span></dt>

<dd class="field-odd"><p><strong>seeds</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><em>list</em></a><em>(</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>)</em>) – Seeds to display.</p>

</dd>

</dl>

</dd></dl>



<dl class="py method">

<dt class="sig sig-object py" id="slideflow.gan.StyleGAN2Interpolator.seed_search">

<span class="sig-name descname"><span class="pre">seed_search</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seeds</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.12)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">batch_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">32</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outcome_idx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">concordance_thresholds</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Iterable" title="(in Python v3.12)"><span class="pre">Iterable</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><span class="pre">float</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">DataFrame</span></span></span><a class="reference internal" href="../_modules/slideflow/gan/interpolate/#StyleGAN2Interpolator.seed_search"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#slideflow.gan.StyleGAN2Interpolator.seed_search" title="Permalink to this definition"></a></dt>

<dd><p>Generates images for starting and ending classes for many seeds,

calculating layer activations from a set classifier.</p>

<dl class="field-list simple">

<dt class="field-odd">Parameters<span class="colon">:</span></dt>

<dd class="field-odd"><ul class="simple">

<li><p><strong>seeds</strong> (<em>List</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>]</em>) – Seeds.</p></li>

<li><p><strong>batch_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>, </em><em>optional</em>) – Batch size for GAN during generation.

Defaults to 32.</p></li>

<li><p><strong>verbose</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a><em>, </em><em>optional</em>) – Verbose output. Defaults to False.</p></li>

</ul>

</dd>

<dt class="field-even">Raises<span class="colon">:</span></dt>

<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.12)"><strong>Exception</strong></a> – If classifier model has not been been set with

    .set_classifier()</p>

</dd>

<dt class="field-odd">Returns<span class="colon">:</span></dt>

<dd class="field-odd"><p>Dataframe of results.</p>

</dd>

<dt class="field-even">Return type<span class="colon">:</span></dt>

<dd class="field-even"><p>pd.core.frame.DataFrame</p>

</dd>

</dl>

</dd></dl>



<dl class="py method">

<dt class="sig sig-object py" id="slideflow.gan.StyleGAN2Interpolator.set_classifier">

<span class="sig-name descname"><span class="pre">set_classifier</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">layers</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.12)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><a class="reference internal" href="../_modules/slideflow/gan/interpolate/#StyleGAN2Interpolator.set_classifier"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#slideflow.gan.StyleGAN2Interpolator.set_classifier" title="Permalink to this definition"></a></dt>

<dd><p>Configures a classifier model to be used for generating features

and predictions during interpolation.</p>

<dl class="field-list simple">

<dt class="field-odd">Parameters<span class="colon">:</span></dt>

<dd class="field-odd"><ul class="simple">

<li><p><strong>path</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Path to trained model.</p></li>

<li><p><strong>layers</strong> (<em>Union</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>, </em><em>List</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em><em>]</em><em>, </em><em>optional</em>) – Layers from which to

calculate activations for interpolated images.

Defaults to None.</p></li>

</ul>

</dd>

</dl>

</dd></dl>



<dl class="py method">

<dt class="sig sig-object py" id="slideflow.gan.StyleGAN2Interpolator.z">

<span class="sig-name descname"><span class="pre">z</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.12)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">torch.Tensor</span></span></span><a class="reference internal" href="../_modules/slideflow/gan/interpolate/#StyleGAN2Interpolator.z"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#slideflow.gan.StyleGAN2Interpolator.z" title="Permalink to this definition"></a></dt>

<dd><p>Returns a noise tensor for a given seed.</p>

<dl class="field-list simple">

<dt class="field-odd">Parameters<span class="colon">:</span></dt>

<dd class="field-odd"><p><strong>seed</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Seed.</p>

</dd>

<dt class="field-even">Returns<span class="colon">:</span></dt>

<dd class="field-even"><p>Noise tensor for the corresponding seed.</p>

</dd>

<dt class="field-odd">Return type<span class="colon">:</span></dt>

<dd class="field-odd"><p>torch.tensor</p>

</dd>

</dl>

</dd></dl>



</dd></dl>



</section>

<section id="module-slideflow.gan.utils">

<span id="utility-functions"></span><h2>Utility functions<a class="headerlink" href="#module-slideflow.gan.utils" title="Permalink to this heading"></a></h2>

<dl class="py function">

<dt class="sig sig-object py" id="slideflow.gan.utils.crop">

<span class="sig-name descname"><span class="pre">crop</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">img</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">torch.Tensor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gan_um</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">gan_px</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">target_um</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><span class="pre">Any</span></a></span></span><a class="reference internal" href="../_modules/slideflow/gan/utils/#crop"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#slideflow.gan.utils.crop" title="Permalink to this definition"></a></dt>

<dd><p>Process a batch of raw GAN output, converting to a Tensorflow tensor.</p>

<dl class="field-list simple">

<dt class="field-odd">Parameters<span class="colon">:</span></dt>

<dd class="field-odd"><ul class="simple">

<li><p><strong>img</strong> (<em>torch.Tensor</em>) – Raw batch of GAN images.</p></li>

<li><p><strong>gan_um</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>, </em><em>optional</em>) – Size of gan output images, in microns.</p></li>

<li><p><strong>gan_px</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>, </em><em>optional</em>) – Size of gan output images, in pixels.</p></li>

<li><p><strong>target_um</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>, </em><em>optional</em>) – Size of target images, in microns.

Will crop image to meet this target.</p></li>

</ul>

</dd>

<dt class="field-even">Returns<span class="colon">:</span></dt>

<dd class="field-even"><p>Cropped image.</p>

</dd>

</dl>

</dd></dl>



<dl class="py function">

<dt class="sig sig-object py" id="slideflow.gan.utils.noise_tensor">

<span class="sig-name descname"><span class="pre">noise_tensor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">z_dim</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">torch.Tensor</span></span></span><a class="reference internal" href="../_modules/slideflow/gan/utils/#noise_tensor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#slideflow.gan.utils.noise_tensor" title="Permalink to this definition"></a></dt>

<dd><p>Creates a noise tensor based on a given seed and dimension size.</p>

<dl class="field-list simple">

<dt class="field-odd">Parameters<span class="colon">:</span></dt>

<dd class="field-odd"><ul class="simple">

<li><p><strong>seed</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Seed.</p></li>

<li><p><strong>z_dim</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Dimension of noise vector to create.</p></li>

</ul>

</dd>

<dt class="field-even">Returns<span class="colon">:</span></dt>

<dd class="field-even"><p>Noise vector of shape (1, z_dim)</p>

</dd>

<dt class="field-odd">Return type<span class="colon">:</span></dt>

<dd class="field-odd"><p>torch.Tensor</p>

</dd>

</dl>

</dd></dl>



</section>

</section>





             </article>



            </div>

            <footer>



    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">



        <a href="../grad/" class="btn btn-neutral float-right" title="slideflow.grad" accesskey="n" rel="next">Next <img src="../_static/images/chevron-right-orange.svg" class="next-page"></a>





        <a href="../io_torch/" class="btn btn-neutral" title="slideflow.io.torch" accesskey="p" rel="prev"><img src="../_static/images/chevron-right-orange.svg" class="previous-page"> Previous</a>



    </div>









    <hr>







  <div role="contentinfo">

    <p>

        &copy; Copyright 2023, James M Dolezal.



    </p>

  </div>



      <div>

        Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

      </div>





</footer>



          </div>

        </div>



        <div class="pytorch-content-right" id="pytorch-content-right">

          <div class="pytorch-right-menu" id="pytorch-right-menu">

            <div class="pytorch-side-scroll" id="pytorch-side-scroll-right">

              <ul>

<li><a class="reference internal" href="#">slideflow.gan</a><ul>

<li><a class="reference internal" href="#stylegan2-interpolator">StyleGAN2 Interpolator</a><ul>

<li><a class="reference internal" href="#slideflow.gan.StyleGAN2Interpolator"><code class="docutils literal notranslate"><span class="pre">StyleGAN2Interpolator</span></code></a><ul>

<li><a class="reference internal" href="#slideflow.gan.StyleGAN2Interpolator.__init__"><code class="docutils literal notranslate"><span class="pre">StyleGAN2Interpolator.__init__()</span></code></a></li>

<li><a class="reference internal" href="#slideflow.gan.StyleGAN2Interpolator.class_interpolate"><code class="docutils literal notranslate"><span class="pre">StyleGAN2Interpolator.class_interpolate()</span></code></a></li>

<li><a class="reference internal" href="#slideflow.gan.StyleGAN2Interpolator.generate"><code class="docutils literal notranslate"><span class="pre">StyleGAN2Interpolator.generate()</span></code></a></li>

<li><a class="reference internal" href="#slideflow.gan.StyleGAN2Interpolator.generate_end"><code class="docutils literal notranslate"><span class="pre">StyleGAN2Interpolator.generate_end()</span></code></a></li>

<li><a class="reference internal" href="#slideflow.gan.StyleGAN2Interpolator.generate_np_end"><code class="docutils literal notranslate"><span class="pre">StyleGAN2Interpolator.generate_np_end()</span></code></a></li>

<li><a class="reference internal" href="#slideflow.gan.StyleGAN2Interpolator.generate_np_from_embedding"><code class="docutils literal notranslate"><span class="pre">StyleGAN2Interpolator.generate_np_from_embedding()</span></code></a></li>

<li><a class="reference internal" href="#slideflow.gan.StyleGAN2Interpolator.generate_np_start"><code class="docutils literal notranslate"><span class="pre">StyleGAN2Interpolator.generate_np_start()</span></code></a></li>

<li><a class="reference internal" href="#slideflow.gan.StyleGAN2Interpolator.generate_start"><code class="docutils literal notranslate"><span class="pre">StyleGAN2Interpolator.generate_start()</span></code></a></li>

<li><a class="reference internal" href="#slideflow.gan.StyleGAN2Interpolator.generate_tf_end"><code class="docutils literal notranslate"><span class="pre">StyleGAN2Interpolator.generate_tf_end()</span></code></a></li>

<li><a class="reference internal" href="#slideflow.gan.StyleGAN2Interpolator.generate_tf_from_embedding"><code class="docutils literal notranslate"><span class="pre">StyleGAN2Interpolator.generate_tf_from_embedding()</span></code></a></li>

<li><a class="reference internal" href="#slideflow.gan.StyleGAN2Interpolator.generate_tf_start"><code class="docutils literal notranslate"><span class="pre">StyleGAN2Interpolator.generate_tf_start()</span></code></a></li>

<li><a class="reference internal" href="#slideflow.gan.StyleGAN2Interpolator.interpolate_and_predict"><code class="docutils literal notranslate"><span class="pre">StyleGAN2Interpolator.interpolate_and_predict()</span></code></a></li>

<li><a class="reference internal" href="#slideflow.gan.StyleGAN2Interpolator.linear_interpolate"><code class="docutils literal notranslate"><span class="pre">StyleGAN2Interpolator.linear_interpolate()</span></code></a></li>

<li><a class="reference internal" href="#slideflow.gan.StyleGAN2Interpolator.plot_comparison"><code class="docutils literal notranslate"><span class="pre">StyleGAN2Interpolator.plot_comparison()</span></code></a></li>

<li><a class="reference internal" href="#slideflow.gan.StyleGAN2Interpolator.seed_search"><code class="docutils literal notranslate"><span class="pre">StyleGAN2Interpolator.seed_search()</span></code></a></li>

<li><a class="reference internal" href="#slideflow.gan.StyleGAN2Interpolator.set_classifier"><code class="docutils literal notranslate"><span class="pre">StyleGAN2Interpolator.set_classifier()</span></code></a></li>

<li><a class="reference internal" href="#slideflow.gan.StyleGAN2Interpolator.z"><code class="docutils literal notranslate"><span class="pre">StyleGAN2Interpolator.z()</span></code></a></li>

</ul>

</li>

</ul>

</li>

<li><a class="reference internal" href="#module-slideflow.gan.utils">Utility functions</a><ul>

<li><a class="reference internal" href="#slideflow.gan.utils.crop"><code class="docutils literal notranslate"><span class="pre">crop()</span></code></a></li>

<li><a class="reference internal" href="#slideflow.gan.utils.noise_tensor"><code class="docutils literal notranslate"><span class="pre">noise_tensor()</span></code></a></li>

</ul>

</li>

</ul>

</li>

</ul>



            </div>

          </div>

        </div>

      </section>

    </div>















       <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>

         <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>

         <script src="../_static/doctools.js"></script>

         <script src="../_static/sphinx_highlight.js"></script>







  <script type="text/javascript" src="../_static/js/vendor/jquery-3.6.3.min.js"></script>

  <script type="text/javascript" src="../_static/js/vendor/popper.min.js"></script>

  <script type="text/javascript" src="../_static/js/vendor/bootstrap.min.js"></script>

  <script src="https://cdnjs.cloudflare.com/ajax/libs/list.js/1.5.0/list.min.js"></script>

  <script type="text/javascript" src="../_static/js/theme.js"></script>



  <script type="text/javascript">

      jQuery(function () {

          SphinxRtdTheme.Navigation.enable(true);

      });

  </script>



  <!-- Begin Footer -->



  <!-- End Footer -->



  <!-- Begin Mobile Menu -->



  <div class="mobile-main-menu">

    <div class="container-fluid">

      <div class="container">

        <div class="mobile-main-menu-header-container">

          <a class="header-logo" href="https://pytorch.org/" aria-label="PyTorch"></a>

          <a class="main-menu-close-button" href="#" data-behavior="close-mobile-menu"></a>

        </div>

      </div>

    </div>



    <div class="mobile-main-menu-links-container">

      <div class="main-menu">

        <ul>

          <li>

            <a href="https://slideflow.dev">Docs</a>

          </li>



          <li>

            <a href="https://slideflow.dev/tutorial1/">Tutorials</a>

          </li>



          <li>

            <a href="https://github.com/slideflow/slideflow">Github</a>

          </li>

        </ul>

      </div>

    </div>

  </div>



  <!-- End Mobile Menu -->



  <script script type="text/javascript">

    var collapsedSections = [];

  </script>



  <script type="text/javascript" src="../_static/js/vendor/anchor.min.js"></script>



  <script type="text/javascript">

    $(document).ready(function() {

      mobileMenu.bind();

      mobileTOC.bind();

      pytorchAnchors.bind();

      sideMenus.bind();

      scrollToAnchor.bind();

      highlightNavigation.bind();

      mainMenuDropdown.bind();

      filterTags.bind();



      // Add class to links that have code blocks, since we cannot create links in code blocks

      $("article.pytorch-article a span.pre").each(function(e) {

        $(this).closest("a").addClass("has-code");

      });

    })

  </script>

</body>

</html>