forked from fastai/fastai
-
Notifications
You must be signed in to change notification settings - Fork 0
/
gen_doc.nbtest.html
373 lines (272 loc) · 18.4 KB
/
gen_doc.nbtest.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
---
title: gen_doc.nbtest
keywords: fastai
sidebar: home_sidebar
summary: "Helper functions to search for api tests"
---
<!--
#################################################
### THIS FILE WAS AUTOGENERATED! DO NOT EDIT! ###
#################################################
# file to edit: docs_src/gen_doc.nbtest.ipynb
# instructions: https://docs.fast.ai/gen_doc_main.html
-->
<div class="container" id="notebook-container">
<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="Functional-Test-Documentation">Functional Test Documentation<a class="anchor-link" href="#Functional-Test-Documentation">¶</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>Generates documentation for fastai's functional tests</p>
</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">
</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="Find-tests-for-any-function/class">Find tests for any function/class<a class="anchor-link" href="#Find-tests-for-any-function/class">¶</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><a href="/gen_doc.nbtest.html#show_test"><code>show_test</code></a> and <a href="/gen_doc.nbtest.html#doctest"><code>doctest</code></a> searches for any implemented tests for a given fastai class or function</p>
<p>For test writers:</p>
<ul>
<li>Use this module to search for tests and get a better idea on which parts of the fastai api need more functional tests</li>
</ul>
<p>For fastai users:</p>
<ul>
<li>Usage is similar to <a href="/gen_doc.nbdoc.html#show_doc"><code>nbdoc.show_doc</code></a> and <a href="/gen_doc.nbdoc.html#doc"><code>nbdoc.doc</code></a>. </li>
<li>It's here to help you find associated tests for a given function can help understand usage. </li>
</ul>
</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="Usage:">Usage:<a class="anchor-link" href="#Usage:">¶</a></h2>
</div>
</div>
</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_test" class="doc_header"><code>show_test</code><a href="https://github.com/fastai/fastai/blob/master/fastai/gen_doc/nbtest.py#L20" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#show_test-pytest" style="float:right; padding-right:10px">[test]</a></h4><blockquote><p><code>show_test</code>(<strong><code>elt</code></strong>) → <code>str</code></p>
</blockquote>
<div class="collapse" id="show_test-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#show_test-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>No tests found for <code>show_test</code>. To contribute a test please refer to <a href="/dev/test.html">this guide</a> and <a href="https://forums.fast.ai/t/improving-expanding-functional-tests/32929">this discussion</a>.</p></div></div><p>Show associated tests for a fastai function/class</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><strong>Show tests from function</strong></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">fastai.basic_train</span> <span class="k">import</span> <span class="n">Learner</span>
<span class="n">show_test</span><span class="p">(</span><span class="n">Learner</span><span class="o">.</span><span class="n">fit</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>Tests found for <code>fit</code>:</p>
<ul>
<li><code>pytest -sv tests/test_train.py::test_fit</code> <a href="https://github.com/fastai/fastai/blob/master/tests/test_train.py#L28" class="source_link" style="float:right">[source]</a></li>
</ul>
<p>Some other tests where <code>fit</code> is used:</p>
<ul>
<li><code>pytest -sv tests/test_basic_train.py::test_destroy</code> <a href="https://github.com/fastai/fastai/blob/master/tests/test_basic_train.py#L170" class="source_link" style="float:right">[source]</a></li>
</ul>
<p>To run tests please refer to this <a href="/dev/test.html#quick-guide">guide</a>.</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><strong>Show tests from a Class</strong></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">fastai.basic_data</span> <span class="k">import</span> <span class="n">DataBunch</span>
<span class="n">show_test</span><span class="p">(</span><span class="n">DataBunch</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>Tests found for <code>DataBunch</code>:</p>
<ul>
<li><code>pytest -sv tests/test_data_block.py::test_custom_dataset</code> <a href="https://github.com/fastai/fastai/blob/master/tests/test_data_block.py#L152" class="source_link" style="float:right">[source]</a></li>
</ul>
<p>Some other tests where <code>DataBunch</code> is used:</p>
<ul>
<li><code>pytest -sv tests/test_basic_data.py::test_DataBunch_Create</code> <a href="https://github.com/fastai/fastai/blob/master/tests/test_basic_data.py#L30" class="source_link" style="float:right">[source]</a></li>
<li><code>pytest -sv tests/test_basic_data.py::test_DataBunch_no_valid_dl</code> <a href="https://github.com/fastai/fastai/blob/master/tests/test_basic_data.py#L44" class="source_link" style="float:right">[source]</a></li>
<li><code>pytest -sv tests/test_basic_data.py::test_DataBunch_save_load</code> <a href="https://github.com/fastai/fastai/blob/master/tests/test_basic_data.py#L83" class="source_link" style="float:right">[source]</a></li>
</ul>
<p>To run tests please refer to this <a href="/dev/test.html#quick-guide">guide</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="kn">from</span> <span class="nn">fastai.text.data</span> <span class="k">import</span> <span class="n">TextList</span>
<span class="n">show_test</span><span class="p">(</span><span class="n">TextList</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>Tests found for <code>TextList</code>:</p>
<p>Some other tests where <code>TextList</code> is used:</p>
<ul>
<li><code>pytest -sv tests/test_text_data.py::test_filter_classes</code> <a href="https://github.com/fastai/fastai/blob/master/tests/test_text_data.py#L42" class="source_link" style="float:right">[source]</a></li>
<li><code>pytest -sv tests/test_text_data.py::test_from_folder</code> <a href="https://github.com/fastai/fastai/blob/master/tests/test_text_data.py#L30" class="source_link" style="float:right">[source]</a></li>
<li><code>pytest -sv tests/test_text_data.py::test_regression</code> <a href="https://github.com/fastai/fastai/blob/master/tests/test_text_data.py#L202" class="source_link" style="float:right">[source]</a></li>
</ul>
<p>To run tests please refer to this <a href="/dev/test.html#quick-guide">guide</a>.</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">
<h2 id="Different-test-types">Different test types<a class="anchor-link" href="#Different-test-types">¶</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>Above, you will see 2 different test types: <code>Tests found for...</code> and <code>Some other tests...</code></p>
<ul>
<li><code>Tests found for...</code> - Searches for function matches in <code>test_registry.json</code>. This json file is populated from <code>doctest.this_tests</code> calls.</li>
<li><code>Some other tests...</code> - Returns any test function where the fastai function in called inside the body</li>
</ul>
</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-in-notebook-inline:">Show in notebook inline:<a class="anchor-link" href="#Show-in-notebook-inline:">¶</a></h2>
</div>
</div>
</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="doctest" class="doc_header"><code>doctest</code><a href="https://github.com/fastai/fastai/blob/master/fastai/gen_doc/nbtest.py#L25" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#doctest-pytest" style="float:right; padding-right:10px">[test]</a></h4><blockquote><p><code>doctest</code>(<strong><code>elt</code></strong>)</p>
</blockquote>
<div class="collapse" id="doctest-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#doctest-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>Tests found for <code>doctest</code>:</p><p>Some other tests where <code>doctest</code> is used:</p><ul><li><code>pytest -sv tests/test_gen_doc_nbtest.py::test_this_tests</code> <a href="https://github.com/fastai/fastai/blob/master/tests/test_gen_doc_nbtest.py#L75" class="source_link" style="float:right">[source]</a></li></ul><p>To run tests please refer to this <a href="/dev/test.html#quick-guide">guide</a>.</p></div></div><p>Inline notebook popup for <a href="/gen_doc.nbtest.html#show_test"><code>show_test</code></a></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">
<h2 id="Internal-search-methods">Internal search methods<a class="anchor-link" href="#Internal-search-methods">¶</a></h2>
</div>
</div>
</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="lookup_db" class="doc_header"><code>lookup_db</code><a href="https://github.com/fastai/fastai/blob/master/fastai/gen_doc/nbtest.py#L71" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#lookup_db-pytest" style="float:right; padding-right:10px">[test]</a></h4><blockquote><p><code>lookup_db</code>(<strong><code>elt</code></strong>) → <code>List</code>[<code>Dict</code>[<code>KT</code>, <code>VT</code>]]</p>
</blockquote>
<div class="collapse" id="lookup_db-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#lookup_db-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>No tests found for <code>lookup_db</code>. To contribute a test please refer to <a href="/dev/test.html">this guide</a> and <a href="https://forums.fast.ai/t/improving-expanding-functional-tests/32929">this discussion</a>.</p></div></div><p>Finds <code>this_test</code> entries from test_registry.json</p>
</div>
</div>
</div>
</div>
</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="find_related_tests" class="doc_header"><code>find_related_tests</code><a href="https://github.com/fastai/fastai/blob/master/fastai/gen_doc/nbtest.py#L81" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#find_related_tests-pytest" style="float:right; padding-right:10px">[test]</a></h4><blockquote><p><code>find_related_tests</code>(<strong><code>elt</code></strong>) → <code>Tuple</code>[<code>List</code>[<code>Dict</code>[<code>KT</code>, <code>VT</code>]], <code>List</code>[<code>Dict</code>[<code>KT</code>, <code>VT</code>]]]</p>
</blockquote>
<div class="collapse" id="find_related_tests-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#find_related_tests-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>No tests found for <code>find_related_tests</code>. To contribute a test please refer to <a href="/dev/test.html">this guide</a> and <a href="https://forums.fast.ai/t/improving-expanding-functional-tests/32929">this discussion</a>.</p></div></div><p>Searches <code>fastai/tests</code> folder for any test functions related to <code>elt</code></p>
</div>
</div>
</div>
</div>
</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="find_test_matches" class="doc_header"><code>find_test_matches</code><a href="https://github.com/fastai/fastai/blob/master/fastai/gen_doc/nbtest.py#L122" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#find_test_matches-pytest" style="float:right; padding-right:10px">[test]</a></h4><blockquote><p><code>find_test_matches</code>(<strong><code>elt</code></strong>, <strong><code>test_file</code></strong>:<code>Path</code>) → <code>Tuple</code>[<code>List</code>[<code>Dict</code>[<code>KT</code>, <code>VT</code>]], <code>List</code>[<code>Dict</code>[<code>KT</code>, <code>VT</code>]]]</p>
</blockquote>
<div class="collapse" id="find_test_matches-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#find_test_matches-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>No tests found for <code>find_test_matches</code>. To contribute a test please refer to <a href="/dev/test.html">this guide</a> and <a href="https://forums.fast.ai/t/improving-expanding-functional-tests/32929">this discussion</a>.</p></div></div><p>Find all functions in <code>test_file</code> related to <code>elt</code></p>
</div>
</div>
</div>
</div>
</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="find_test_files" class="doc_header"><code>find_test_files</code><a href="https://github.com/fastai/fastai/blob/master/fastai/gen_doc/nbtest.py#L100" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#find_test_files-pytest" style="float:right; padding-right:10px">[test]</a></h4><blockquote><p><code>find_test_files</code>(<strong><code>elt</code></strong>, <strong><code>exact_match</code></strong>:<code>bool</code>=<strong><em><code>False</code></em></strong>) → <code>List</code>[<code>Path</code>]</p>
</blockquote>
<div class="collapse" id="find_test_files-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#find_test_files-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>No tests found for <code>find_test_files</code>. To contribute a test please refer to <a href="/dev/test.html">this guide</a> and <a href="https://forums.fast.ai/t/improving-expanding-functional-tests/32929">this discussion</a>.</p></div></div><p>Searches in <code>fastai/tests</code> directory for module tests</p>
</div>
</div>
</div>
</div>
</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="fuzzy_test_match" class="doc_header"><code>fuzzy_test_match</code><a href="https://github.com/fastai/fastai/blob/master/fastai/gen_doc/nbtest.py#L143" class="source_link" style="float:right">[source]</a><a class="source_link" data-toggle="collapse" data-target="#fuzzy_test_match-pytest" style="float:right; padding-right:10px">[test]</a></h4><blockquote><p><code>fuzzy_test_match</code>(<strong><code>fn_name</code></strong>:<code>str</code>, <strong><code>lines</code></strong>:<code>List</code>[<code>Dict</code>[<code>KT</code>, <code>VT</code>]], <strong><code>rel_path</code></strong>:<code>str</code>) → <code>List</code>[<a href="/gen_doc.nbtest.html#TestFunctionMatch"><code>TestFunctionMatch</code></a>]</p>
</blockquote>
<div class="collapse" id="fuzzy_test_match-pytest"><div class="card card-body pytest_card"><a type="button" data-toggle="collapse" data-target="#fuzzy_test_match-pytest" class="close" aria-label="Close"><span aria-hidden="true">×</span></a><p>Tests found for <code>fuzzy_test_match</code>:</p><ul><li><code>pytest -sv tests/test_gen_doc_nbtest.py::test_fuzzy_test_match</code> <a href="https://github.com/fastai/fastai/blob/master/tests/test_gen_doc_nbtest.py#L38" class="source_link" style="float:right">[source]</a></li></ul><p>To run tests please refer to this <a href="/dev/test.html#quick-guide">guide</a>.</p></div></div><p>Find any lines where <code>fn_name</code> is invoked and return the parent test function</p>
</div>
</div>
</div>
</div>
</div>
</div>