/
notebook.showdoc.html
756 lines (547 loc) · 32.7 KB
/
notebook.showdoc.html
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
---
title: Show doc
keywords: fastai
sidebar: home_sidebar
summary: "Functions to show the doc cells in notebooks"
---
<!--
#################################################
### THIS FILE WAS AUTOGENERATED! DO NOT EDIT! ###
#################################################
# file to edit: dev/92_notebook_showdoc.ipynb
# instructions: https://docs.fast.ai/gen_doc_main.html
-->
<div class="container" id="notebook-container">
<div class="cell border-box-sizing code_cell rendered">
</div>
<div class="cell border-box-sizing code_cell rendered">
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="kn">from</span> <span class="nn">local.core.foundation</span> <span class="k">import</span> <span class="n">add_docs</span><span class="p">,</span> <span class="n">patch</span>
<span class="kn">from</span> <span class="nn">local.core.utils</span> <span class="k">import</span> <span class="n">compose</span>
<span class="kn">from</span> <span class="nn">local.core.transform</span> <span class="k">import</span> <span class="n">Pipeline</span>
<span class="kn">from</span> <span class="nn">local.data.external</span> <span class="k">import</span> <span class="n">untar_data</span>
<span class="n">test_cases</span> <span class="o">=</span> <span class="p">[</span>
<span class="n">Pipeline</span><span class="p">,</span> <span class="c1">#Basic class</span>
<span class="n">compose</span><span class="p">,</span> <span class="c1">#Func with star args and type annotation</span>
<span class="n">untar_data</span><span class="p">,</span> <span class="c1">#Func with defaults</span>
<span class="n">add_docs</span><span class="p">,</span> <span class="c1">#Func with kwargs</span>
<span class="n">Path</span><span class="o">.</span><span class="n">ls</span> <span class="c1">#Monkey-patched</span>
<span class="p">]</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<h2 id="Gather-the-information">Gather the information<a class="anchor-link" href="#Gather-the-information">¶</a></h2>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>The inspect module lets us know quickly if an object is a function or a class but it doesn't distinguish classes and enums.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="is_enum" class="doc_header"><code>is_enum</code><a href="https://github.com/fastai/fastai_dev/tree/master/dev/local/notebook/showdoc.py#L17" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>is_enum</code>()</p>
</blockquote>
<p>Check if <code>cls</code> is an enum or another type of class</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="n">e</span> <span class="o">=</span> <span class="n">enum</span><span class="o">.</span><span class="n">Enum</span><span class="p">(</span><span class="s1">'e'</span><span class="p">,</span> <span class="s1">'a b'</span><span class="p">)</span>
<span class="k">assert</span> <span class="n">is_enum</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
<span class="k">assert</span> <span class="ow">not</span> <span class="n">is_enum</span><span class="p">(</span><span class="n">Pipeline</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<h3 id="Links">Links<a class="anchor-link" href="#Links">¶</a></h3>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>We don't link to all PyTorch functions, just the ones in an index we keep. We can easily add a reference with the following convenience function when writing the docs.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="add_pytorch_index" class="doc_header"><code>add_pytorch_index</code><a href="https://github.com/fastai/fastai_dev/tree/master/dev/local/notebook/showdoc.py#L26" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>add_pytorch_index</code>(<strong><code>func_name</code></strong>, <strong><code>url</code></strong>)</p>
</blockquote>
<p>Add <code>func_name</code> in the PyTorch index for automatic links.</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p><code>url</code> can be the full url or just the part after <code>https://pytorch.org/docs/stable/</code>, see the example below.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="n">add_pytorch_index</span><span class="p">(</span><span class="s1">'Tensor'</span><span class="p">,</span> <span class="s1">'tensors.html#torch-tensor'</span><span class="p">)</span>
<span class="n">add_pytorch_index</span><span class="p">(</span><span class="s1">'device'</span><span class="p">,</span> <span class="s1">'tensor_attributes.html#torch-device'</span><span class="p">)</span>
<span class="n">add_pytorch_index</span><span class="p">(</span><span class="s1">'DataLoader'</span><span class="p">,</span> <span class="s1">'data.html#torch.utils.data.DataLoader'</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="is_fastai_module" class="doc_header"><code>is_fastai_module</code><a href="https://github.com/fastai/fastai_dev/tree/master/dev/local/notebook/showdoc.py#L35" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>is_fastai_module</code>(<strong><code>name</code></strong>)</p>
</blockquote>
<p>Test if <code>name</code> is a fastai module.</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="k">assert</span> <span class="n">is_fastai_module</span><span class="p">(</span><span class="s1">'data.external'</span><span class="p">)</span>
<span class="k">assert</span> <span class="n">is_fastai_module</span><span class="p">(</span><span class="s1">'learner'</span><span class="p">)</span>
<span class="k">assert</span> <span class="ow">not</span> <span class="n">is_fastai_module</span><span class="p">(</span><span class="s1">'export'</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
</div>
<div class="cell border-box-sizing code_cell rendered">
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="doc_link" class="doc_header"><code>doc_link</code><a href="https://github.com/fastai/fastai_dev/tree/master/dev/local/notebook/showdoc.py#L47" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>doc_link</code>(<strong><code>name</code></strong>, <strong><code>include_bt</code></strong>:<code>bool</code>=<em><code>True</code></em>)</p>
</blockquote>
<p>Create link to documentation for <code>name</code>.</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="k">assert</span> <span class="n">doc_link</span><span class="p">(</span><span class="s1">'core.transform'</span><span class="p">)</span> <span class="o">==</span> <span class="n">f</span><span class="s1">'[`core.transform`](</span><span class="si">{FASTAI_DOCS}</span><span class="s1">/core.transform.html)'</span>
<span class="k">assert</span> <span class="n">doc_link</span><span class="p">(</span><span class="s1">'Pipeline'</span><span class="p">)</span> <span class="o">==</span> <span class="n">f</span><span class="s1">'[`Pipeline`](</span><span class="si">{FASTAI_DOCS}</span><span class="s1">/transform.html#Pipeline)'</span>
<span class="k">assert</span> <span class="n">doc_link</span><span class="p">(</span><span class="s1">'Transform.create'</span><span class="p">)</span> <span class="o">==</span> <span class="n">f</span><span class="s1">'[`Transform.create`](</span><span class="si">{FASTAI_DOCS}</span><span class="s1">/transform.html#Transform.create)'</span>
<span class="k">assert</span> <span class="n">doc_link</span><span class="p">(</span><span class="s1">'Tensor'</span><span class="p">)</span> <span class="o">==</span> <span class="s1">'[`Tensor`](https://pytorch.org/docs/stable/tensors.html#torch-tensor)'</span>
<span class="k">assert</span> <span class="n">doc_link</span><span class="p">(</span><span class="s1">'Tenso'</span><span class="p">)</span> <span class="o">==</span> <span class="s1">'`Tenso`'</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
</div>
<div class="cell border-box-sizing code_cell rendered">
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="add_doc_links" class="doc_header"><code>add_doc_links</code><a href="https://github.com/fastai/fastai_dev/tree/master/dev/local/notebook/showdoc.py#L81" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>add_doc_links</code>(<strong><code>text</code></strong>)</p>
</blockquote>
<p>Search for doc links for any item between backticks in <code>text</code>.</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>This function not only add links to backstick keywords, it also update the links that are already in the text.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="n">tst</span> <span class="o">=</span> <span class="n">add_doc_links</span><span class="p">(</span><span class="s1">'This is an example of `Pipeline`'</span><span class="p">)</span>
<span class="k">assert</span> <span class="n">tst</span> <span class="o">==</span> <span class="s2">"This is an example of [`Pipeline`](/transform.html#Pipeline)"</span>
<span class="n">tst</span> <span class="o">=</span> <span class="n">add_doc_links</span><span class="p">(</span><span class="s1">'Here we alread add a link in [`Tensor`](fake)'</span><span class="p">)</span>
<span class="k">assert</span> <span class="n">tst</span> <span class="o">==</span> <span class="s2">"Here we alread add a link in [`Tensor`](https://pytorch.org/docs/stable/tensors.html#torch-tensor)"</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<h3 id="Links-to-source">Links to source<a class="anchor-link" href="#Links-to-source">¶</a></h3>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
</div>
<div class="cell border-box-sizing code_cell rendered">
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="get_source_link" class="doc_header"><code>get_source_link</code><a href="https://github.com/fastai/fastai_dev/tree/master/dev/local/notebook/showdoc.py#L102" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>get_source_link</code>(<strong><code>func</code></strong>)</p>
</blockquote>
<p>Return link to <code>func</code> in source code</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>As important as the source code, we want to quickly jump to where the function is defined in a dev notebook.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
</div>
<div class="cell border-box-sizing code_cell rendered">
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="get_nb_source_link" class="doc_header"><code>get_nb_source_link</code><a href="https://github.com/fastai/fastai_dev/tree/master/dev/local/notebook/showdoc.py#L123" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>get_nb_source_link</code>(<strong><code>func</code></strong>, <strong><code>local</code></strong>=<em><code>False</code></em>, <strong><code>is_name</code></strong>=<em><code>None</code></em>)</p>
</blockquote>
<p>Return a link to the notebook where <code>func</code> is defined.</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="k">assert</span> <span class="n">get_nb_source_link</span><span class="p">(</span><span class="n">Pipeline</span><span class="o">.</span><span class="n">decode</span><span class="p">)</span> <span class="o">==</span> <span class="n">get_nb_source_link</span><span class="p">(</span><span class="n">Pipeline</span><span class="p">)</span>
<span class="k">assert</span> <span class="n">get_nb_source_link</span><span class="p">(</span><span class="s1">'Pipeline'</span><span class="p">)</span> <span class="o">==</span> <span class="n">get_nb_source_link</span><span class="p">(</span><span class="n">Pipeline</span><span class="p">)</span>
<span class="k">assert</span> <span class="n">get_nb_source_link</span><span class="p">(</span><span class="n">patch</span><span class="p">)</span> <span class="o">==</span> <span class="n">f</span><span class="s1">'</span><span class="si">{FASTAI_NB_DEV}</span><span class="s1">01_core.ipynb#Foundational-functions'</span>
<span class="k">assert</span> <span class="n">get_nb_source_link</span><span class="p">(</span><span class="n">patch</span><span class="p">,</span> <span class="n">local</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="o">==</span> <span class="n">f</span><span class="s1">'01_core.ipynb#Foundational-functions'</span>
<span class="k">assert</span> <span class="n">get_nb_source_link</span><span class="p">(</span><span class="s1">'Path.ls'</span><span class="p">)</span> <span class="o">==</span> <span class="n">f</span><span class="s1">'</span><span class="si">{FASTAI_NB_DEV}</span><span class="s1">01a_utils.ipynb#File-and-network-functions'</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>You can either pass an object or its name (by default <code>is_name</code> will look if <code>func</code> is a string or not, but you can override if there is some inconsistent behavior). <code>local</code> will return a local link.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="nb_source_link" class="doc_header"><code>nb_source_link</code><a href="https://github.com/fastai/fastai_dev/tree/master/dev/local/notebook/showdoc.py#L154" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>nb_source_link</code>(<strong><code>func</code></strong>, <strong><code>is_name</code></strong>=<em><code>None</code></em>, <strong><code>disp</code></strong>=<em><code>True</code></em>)</p>
</blockquote>
<p>Show a relative link to the notebook where <code>func</code> is defined</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>This function assumes you are in one notebook in the dev folder, otherwise you use <code>disp=False</code> to get the relative link. You can either pass an object or its name (by default <code>is_name</code> will look if <code>func</code> is a string or not, but you can override if there is some inconsistent behavior).</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="n">nb_source_link</span><span class="p">(</span><span class="n">Pipeline</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<p><a href="01c_transform.ipynb#Export--">Pipeline</a></p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="k">assert</span> <span class="n">nb_source_link</span><span class="p">(</span><span class="n">patch</span><span class="p">,</span> <span class="n">disp</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span> <span class="o">==</span> <span class="n">f</span><span class="s1">'01_core.ipynb#Foundational-functions'</span>
<span class="k">assert</span> <span class="n">nb_source_link</span><span class="p">(</span><span class="s1">'patch'</span><span class="p">,</span> <span class="n">disp</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span> <span class="o">==</span> <span class="n">f</span><span class="s1">'01_core.ipynb#Foundational-functions'</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<h2 id="Show-documentation">Show documentation<a class="anchor-link" href="#Show-documentation">¶</a></h2>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="type_repr" class="doc_header"><code>type_repr</code><a href="https://github.com/fastai/fastai_dev/tree/master/dev/local/notebook/showdoc.py#L163" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>type_repr</code>(<strong><code>t</code></strong>)</p>
</blockquote>
<p>Representation of type <code>t</code> (in a type annotation)</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>The representation tries to find doc links if possible.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="kn">from</span> <span class="nn">torch</span> <span class="k">import</span> <span class="n">Tensor</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="n">tst</span> <span class="o">=</span> <span class="n">type_repr</span><span class="p">(</span><span class="n">Optional</span><span class="p">[</span><span class="n">Tensor</span><span class="p">])</span>
<span class="k">assert</span> <span class="n">tst</span> <span class="o">==</span> <span class="s1">'`Optional`</span><span class="se">\\</span><span class="s1">[[`Tensor`](https://pytorch.org/docs/stable/tensors.html#torch-tensor)</span><span class="se">\\</span><span class="s1">]'</span>
<span class="n">tst</span> <span class="o">=</span> <span class="n">type_repr</span><span class="p">(</span><span class="n">Union</span><span class="p">[</span><span class="n">Tensor</span><span class="p">,</span> <span class="nb">float</span><span class="p">])</span>
<span class="k">assert</span> <span class="n">tst</span> <span class="o">==</span> <span class="s1">'`Union`</span><span class="se">\\</span><span class="s1">[[`Tensor`](https://pytorch.org/docs/stable/tensors.html#torch-tensor), `float`</span><span class="se">\\</span><span class="s1">]'</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="format_param" class="doc_header"><code>format_param</code><a href="https://github.com/fastai/fastai_dev/tree/master/dev/local/notebook/showdoc.py#L176" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>format_param</code>(<strong><code>p</code></strong>)</p>
</blockquote>
<p>Formats function param to <code>param1:Type=val</code>. Font weights: param1=bold, val=italic</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="n">sig</span> <span class="o">=</span> <span class="n">inspect</span><span class="o">.</span><span class="n">signature</span><span class="p">(</span><span class="n">untar_data</span><span class="p">)</span>
<span class="n">params</span> <span class="o">=</span> <span class="p">[</span><span class="n">format_param</span><span class="p">(</span><span class="n">p</span><span class="p">)</span> <span class="k">for</span> <span class="n">_</span><span class="p">,</span><span class="n">p</span> <span class="ow">in</span> <span class="n">sig</span><span class="o">.</span><span class="n">parameters</span><span class="o">.</span><span class="n">items</span><span class="p">()]</span>
<span class="k">assert</span> <span class="n">params</span> <span class="o">==</span> <span class="p">[</span>
<span class="s1">'**`url`**'</span><span class="p">,</span>
<span class="s1">'**`fname`**=*`None`*'</span><span class="p">,</span>
<span class="s1">'**`dest`**=*`None`*'</span><span class="p">,</span>
<span class="s2">"**`c_key`**=*`'data'`*"</span><span class="p">,</span>
<span class="s1">'**`force_download`**=*`False`*'</span><span class="p">,</span>
<span class="s2">"**`extract_func`**=*`'tar_extract'`*"</span><span class="p">]</span>
<span class="n">sig</span> <span class="o">=</span> <span class="n">inspect</span><span class="o">.</span><span class="n">signature</span><span class="p">(</span><span class="n">compose</span><span class="p">)</span>
<span class="n">params</span> <span class="o">=</span> <span class="p">[</span><span class="n">format_param</span><span class="p">(</span><span class="n">p</span><span class="p">)</span> <span class="k">for</span> <span class="n">_</span><span class="p">,</span><span class="n">p</span> <span class="ow">in</span> <span class="n">sig</span><span class="o">.</span><span class="n">parameters</span><span class="o">.</span><span class="n">items</span><span class="p">()]</span>
<span class="k">assert</span> <span class="n">params</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s1">'**</span><span class="se">\\</span><span class="s1">*`funcs`**'</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="n">params</span>
</pre></div>
</div>
</div>
</div>
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_text output_subarea output_execute_result">
<pre>['**\\*`funcs`**', '**`order`**=*`None`*']</pre>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="n">tst</span> <span class="o">=</span> <span class="n">_format_enum_doc</span><span class="p">(</span><span class="n">e</span><span class="p">,</span> <span class="s1">'e'</span><span class="p">)</span>
<span class="k">assert</span> <span class="n">tst</span> <span class="o">==</span> <span class="p">(</span><span class="s1">'<code>e</code>'</span><span class="p">,</span> <span class="s1">'<code>Enum</code> = [a, b]'</span><span class="p">),</span><span class="n">tst</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="k">assert</span> <span class="n">_format_func_doc</span><span class="p">(</span><span class="n">compose</span><span class="p">)</span> <span class="o">==</span> <span class="p">(</span><span class="s1">'<code>compose</code>'</span><span class="p">,</span>
<span class="s1">'<code>compose</code>(**</span><span class="se">\\</span><span class="s1">*`funcs`**, **`order`**=*`None`*)'</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="k">assert</span> <span class="n">_format_cls_doc</span><span class="p">(</span><span class="n">Pipeline</span><span class="p">,</span> <span class="s1">'Pipeline'</span><span class="p">)</span> <span class="o">==</span> <span class="p">(</span><span class="s1">'<code>class</code> <code>Pipeline</code>'</span><span class="p">,</span>
<span class="s1">'<code>Pipeline</code>(**`funcs`**=*`None`*, **`as_item`**=*`False`*, **`split_idx`**=*`None`*)'</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="show_doc" class="doc_header"><code>show_doc</code><a href="https://github.com/fastai/fastai_dev/tree/master/dev/local/notebook/showdoc.py#L220" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>show_doc</code>(<strong><code>elt</code></strong>, <strong><code>doc_string</code></strong>=<em><code>True</code></em>, <strong><code>name</code></strong>=<em><code>None</code></em>, <strong><code>title_level</code></strong>=<em><code>None</code></em>, <strong><code>disp</code></strong>=<em><code>True</code></em>, <strong><code>default_cls_level</code></strong>=<em><code>2</code></em>)</p>
</blockquote>
<p>Show documentation for element <code>elt</code>. Supported types: class, function, and enum.</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p><code>doc_string</code> determines if we show the docstring of the function or not. <code>name</code> can be used to provide an alternative to the name automatically found. <code>title_level</code> determines the level of the anchor (default 3 for classes and 4 for functions). If <code>disp</code> is <code>False</code>, the function returns the markdown code instead of displaying it.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>For instance</p>
<div class="highlight"><pre><span></span><span class="n">show_doc</span><span class="p">(</span><span class="n">untar_data</span><span class="p">)</span>
</pre></div>
<p>will display</p>
<h4 id="untar_data" class="doc_header"><code>untar_data</code><a href="https://github.com/fastai/fastai_dev/tree/master/dev/local/data/external.py#L182" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>untar_data</code>(<strong><code>url</code></strong>, <strong><code>fname</code></strong>=<em><code>None</code></em>, <strong><code>dest</code></strong>=<em><code>None</code></em>, <strong><code>c_key</code></strong>=<em><code>ConfigKey.Data</code></em>, <strong><code>force_download</code></strong>=<em><code>False</code></em>, <strong><code>extract_func</code></strong>=<em><code>\'tar_extract\'</code></em>)</p>
</blockquote>
<p>Download <code>url</code> to <code>fname</code> if <code>dest</code> doesn\'t exist, and un-tgz to folder <code>dest</code>.</p>
</div>
</div>
</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<h3 id="The-doc-command">The doc command<a class="anchor-link" href="#The-doc-command">¶</a></h3>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="md2html" class="doc_header"><code>md2html</code><a href="https://github.com/fastai/fastai_dev/tree/master/dev/local/notebook/showdoc.py#L239" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>md2html</code>(<strong><code>md</code></strong>)</p>
</blockquote>
<p>Convert markdown <code>md</code> to HTML code</p>
</div>
</div>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
</div>
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="doc" class="doc_header"><code>doc</code><a href="https://github.com/fastai/fastai_dev/tree/master/dev/local/notebook/showdoc.py#L245" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>doc</code>(<strong><code>elt</code></strong>)</p>
</blockquote>
<p>Show <a href="/notebook.showdoc.html#show_doc"><code>show_doc</code></a> info in preview window</p>
</div>
</div>
</div>
</div>
</div>
</div>