Update docs... the end!

docs/basic_data.html

@@ -241,7 +241,7 @@ <h4 id="DataBunch.export"><code>export</code><a href="https://github.com/fastai/
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="load_empty"><code>load_empty</code><a href="https://github.com/fastai/fastai/blob/master/fastai/data_block.py#L575" class="source_link">[source]</a></h4><blockquote><p><code>load_empty</code>(<code>path</code>, <code>fname</code>:<code>str</code>=<code>'export.pkl'</code>)</p>
+<h4 id="load_empty"><code>load_empty</code><a href="https://github.com/fastai/fastai/blob/master/fastai/data_block.py#L584" class="source_link">[source]</a></h4><blockquote><p><code>load_empty</code>(<code>path</code>, <code>fname</code>:<code>str</code>=<code>'export.pkl'</code>)</p>
 </blockquote>
 <p>Load an empty <a href="/basic_data.html#DataBunch"><code>DataBunch</code></a> from the exported file in <code>path/fname</code> with optional <code>tfms</code>.</p>
 

docs/collab.html

@@ -261,7 +261,7 @@ <h2 id="Overview">Overview<a class="anchor-link" href="#Overview">&#182;</a></h2
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h2 id="CollabDataBunch"><code>class</code> <code>CollabDataBunch</code><a href="https://github.com/fastai/fastai/blob/master/fastai/collab.py#L46" class="source_link">[source]</a></h2><blockquote><p><code>CollabDataBunch</code>(<code>train_dl</code>:<a href="https://pytorch.org/docs/stable/data.html#torch.utils.data.DataLoader"><code>DataLoader</code></a>, <code>valid_dl</code>:<a href="https://pytorch.org/docs/stable/data.html#torch.utils.data.DataLoader"><code>DataLoader</code></a>, <code>test_dl</code>:<code>Optional</code>[<a href="https://pytorch.org/docs/stable/data.html#torch.utils.data.DataLoader"><code>DataLoader</code></a>]=<code>None</code>, <code>device</code>:<a href="https://pytorch.org/docs/stable/tensor_attributes.html#torch-device"><code>device</code></a>=<code>None</code>, <code>tfms</code>:<code>Optional</code>[<code>Collection</code>[<code>Callable</code>]]=<code>None</code>, <code>path</code>:<code>PathOrStr</code>=<code>'.'</code>, <code>collate_fn</code>:<code>Callable</code>=<code>'data_collate'</code>) :: <a href="/basic_data.html#DataBunch"><code>DataBunch</code></a></p>
+<h2 id="CollabDataBunch"><code>class</code> <code>CollabDataBunch</code><a href="https://github.com/fastai/fastai/blob/master/fastai/collab.py#L46" class="source_link">[source]</a></h2><blockquote><p><code>CollabDataBunch</code>(<code>train_dl</code>:<a href="https://pytorch.org/docs/stable/data.html#torch.utils.data.DataLoader"><code>DataLoader</code></a>, <code>valid_dl</code>:<a href="https://pytorch.org/docs/stable/data.html#torch.utils.data.DataLoader"><code>DataLoader</code></a>, <code>fix_dl</code>:<a href="https://pytorch.org/docs/stable/data.html#torch.utils.data.DataLoader"><code>DataLoader</code></a>, <code>test_dl</code>:<code>Optional</code>[<a href="https://pytorch.org/docs/stable/data.html#torch.utils.data.DataLoader"><code>DataLoader</code></a>]=<code>None</code>, <code>device</code>:<a href="https://pytorch.org/docs/stable/tensor_attributes.html#torch-device"><code>device</code></a>=<code>None</code>, <code>tfms</code>:<code>Optional</code>[<code>Collection</code>[<code>Callable</code>]]=<code>None</code>, <code>path</code>:<code>PathOrStr</code>=<code>'.'</code>, <code>collate_fn</code>:<code>Callable</code>=<code>'data_collate'</code>, <code>no_check</code>:<code>bool</code>=<code>False</code>) :: <a href="/basic_data.html#DataBunch"><code>DataBunch</code></a></p>
 </blockquote>
 <p>Base <a href="/basic_data.html#DataBunch"><code>DataBunch</code></a> for collaborative filtering.</p>
 
@@ -322,6 +322,97 @@ <h2 id="Model-and-Learner">Model and <a href="/basic_train.html#Learner"><code>L
 <div class="output_area">
 
 
+<div class="output_markdown rendered_html output_subarea ">
+<h3 id="CollabLearner"><code>class</code> <code>CollabLearner</code><a href="https://github.com/fastai/fastai/blob/master/fastai/collab.py#L61" class="source_link">[source]</a></h3><blockquote><p><code>CollabLearner</code>(<code>data</code>:<a href="/basic_data.html#DataBunch"><code>DataBunch</code></a>, <code>model</code>:<a href="https://pytorch.org/docs/stable/nn.html#torch.nn.Module"><code>Module</code></a>, <code>opt_func</code>:<code>Callable</code>=<code>'Adam'</code>, <code>loss_func</code>:<code>Callable</code>=<code>None</code>, <code>metrics</code>:<code>Collection</code>[<code>Callable</code>]=<code>None</code>, <code>true_wd</code>:<code>bool</code>=<code>True</code>, <code>bn_wd</code>:<code>bool</code>=<code>True</code>, <code>wd</code>:<code>Floats</code>=<code>0.01</code>, <code>train_bn</code>:<code>bool</code>=<code>True</code>, <code>path</code>:<code>str</code>=<code>None</code>, <code>model_dir</code>:<code>str</code>=<code>'models'</code>, <code>callback_fns</code>:<code>Collection</code>[<code>Callable</code>]=<code>None</code>, <code>callbacks</code>:<code>Collection</code>[<a href="/callback.html#Callback"><code>Callback</code></a>]=<code>&lt;factory&gt;</code>, <code>layer_groups</code>:<code>ModuleList</code>=<code>None</code>) :: <a href="/basic_train.html#Learner"><code>Learner</code></a></p>
+</blockquote>
+<p><a href="/basic_train.html#Learner"><code>Learner</code></a> suitable for collaborative filtering.</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 is a subclass of <a href="/basic_train.html#Learner"><code>Learner</code></a> that just introduces helper functions to analyze results, the initialization is the same as a regular <a href="/basic_train.html#Learner"><code>Learner</code></a>.</p>
+
+</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="CollabLearner.bias"><code>bias</code><a href="https://github.com/fastai/fastai/blob/master/fastai/collab.py#L72" class="source_link">[source]</a></h4><blockquote><p><code>bias</code>(<code>arr</code>:<code>Collection</code>[<code>T_co</code>], <code>is_item</code>:<code>bool</code>=<code>True</code>)</p>
+</blockquote>
+<p>Bias for item or user (based on <code>is_item</code>) for all in <code>arr</code>. (Set model to <code>cpu</code> and no grad.)</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="CollabLearner.get_idx"><code>get_idx</code><a href="https://github.com/fastai/fastai/blob/master/fastai/collab.py#L63" class="source_link">[source]</a></h4><blockquote><p><code>get_idx</code>(<code>arr</code>:<code>Collection</code>[<code>T_co</code>], <code>is_item</code>:<code>bool</code>=<code>True</code>)</p>
+</blockquote>
+<p>Fetch item or user (based on <code>is_item</code>) for all in <code>arr</code>. (Set model to <code>cpu</code> and no grad.)</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="CollabLearner.weight"><code>weight</code><a href="https://github.com/fastai/fastai/blob/master/fastai/collab.py#L79" class="source_link">[source]</a></h4><blockquote><p><code>weight</code>(<code>arr</code>:<code>Collection</code>[<code>T_co</code>], <code>is_item</code>:<code>bool</code>=<code>True</code>)</p>
+</blockquote>
+<p>Bias for item or user (based on <code>is_item</code>) for all in <code>arr</code>. (Set model to <code>cpu</code> and no grad.)</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 ">
 <h3 id="EmbeddingDotBias"><code>class</code> <code>EmbeddingDotBias</code><a href="https://github.com/fastai/fastai/blob/master/fastai/collab.py#L31" class="source_link">[source]</a></h3><blockquote><p><code>EmbeddingDotBias</code>(<code>n_factors</code>:<code>int</code>, <code>n_users</code>:<code>int</code>, <code>n_items</code>:<code>int</code>, <code>y_range</code>:<code>Point</code>=<code>None</code>) :: <a href="https://pytorch.org/docs/stable/nn.html#torch.nn.Module"><code>Module</code></a></p>
 </blockquote>
@@ -379,7 +470,7 @@ <h3 id="EmbeddingNN"><code>class</code> <code>EmbeddingNN</code><a href="https:/
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="collab_learner"><code>collab_learner</code><a href="https://github.com/fastai/fastai/blob/master/fastai/collab.py#L85" class="source_link">[source]</a></h4><blockquote><p><code>collab_learner</code>(<code>data</code>, <code>n_factors</code>:<code>int</code>=<code>None</code>, <code>use_nn</code>:<code>bool</code>=<code>False</code>, <code>metrics</code>=<code>None</code>, <code>emb_szs</code>:<code>Dict</code>[<code>str</code>, <code>int</code>]=<code>None</code>, <code>wd</code>:<code>float</code>=<code>0.01</code>, <code>kwargs</code>) → <a href="/basic_train.html#Learner"><code>Learner</code></a></p>
+<h4 id="collab_learner"><code>collab_learner</code><a href="https://github.com/fastai/fastai/blob/master/fastai/collab.py#L86" class="source_link">[source]</a></h4><blockquote><p><code>collab_learner</code>(<code>data</code>, <code>n_factors</code>:<code>int</code>=<code>None</code>, <code>use_nn</code>:<code>bool</code>=<code>False</code>, <code>metrics</code>=<code>None</code>, <code>emb_szs</code>:<code>Dict</code>[<code>str</code>, <code>int</code>]=<code>None</code>, <code>wd</code>:<code>float</code>=<code>0.01</code>, <code>kwargs</code>) → <a href="/basic_train.html#Learner"><code>Learner</code></a></p>
 </blockquote>
 <p>Create a Learner for collaborative filtering on <code>data</code>.</p>
 

docs/datasets.html

@@ -139,7 +139,7 @@ <h4 id="untar_data"><code>untar_data</code><a href="https://github.com/fastai/fa
 
 
 <div class="output_text output_subarea output_execute_result">
-<pre>PosixPath(&#39;/home/jhoward/.fastai/data/planet_sample&#39;)</pre>
+<pre>PosixPath(&#39;/home/ubuntu/.fastai/data/planet_sample&#39;)</pre>
 </div>
 
 </div>
@@ -197,7 +197,7 @@ <h4 id="download_data"><code>download_data</code><a href="https://github.com/fas
 
 
 <div class="output_text output_subarea output_execute_result">
-<pre>PosixPath(&#39;/home/jhoward/.fastai/data/planet_sample.tgz&#39;)</pre>
+<pre>PosixPath(&#39;/home/ubuntu/.fastai/data/planet_sample.tgz&#39;)</pre>
 </div>
 
 </div>
@@ -340,13 +340,6 @@ <h4 id="Config.model_path"><code>model_path</code><a href="https://github.com/fa
 </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>Get the <code>Path</code> where the pretrained models from fastai are stored.</p>
-
-</div>
-</div>
 </div>
 </div>
 

docs/gen_doc.nbdoc.html

@@ -40,7 +40,7 @@ <h2 id="Show-the-documentation-of-a-function">Show the documentation of a functi
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="show_doc"><code>show_doc</code><a href="https://github.com/fastai/fastai/blob/master/fastai/gen_doc/nbdoc.py#L90" class="source_link">[source]</a></h4><blockquote><p><code>show_doc</code>(<code>elt</code>, <code>doc_string</code>:<code>bool</code>=<code>True</code>, <code>full_name</code>:<code>str</code>=<code>None</code>, <code>arg_comments</code>:<code>dict</code>=<code>None</code>, <code>title_level</code>=<code>None</code>, <code>alt_doc_string</code>:<code>str</code>=<code>''</code>, <code>ignore_warn</code>:<code>bool</code>=<code>False</code>, <code>markdown</code>=<code>True</code>)</p>
+<h4 id="show_doc"><code>show_doc</code><a href="https://github.com/fastai/fastai/blob/master/fastai/gen_doc/nbdoc.py#L96" class="source_link">[source]</a></h4><blockquote><p><code>show_doc</code>(<code>elt</code>, <code>doc_string</code>:<code>bool</code>=<code>True</code>, <code>full_name</code>:<code>str</code>=<code>None</code>, <code>arg_comments</code>:<code>dict</code>=<code>None</code>, <code>title_level</code>=<code>None</code>, <code>alt_doc_string</code>:<code>str</code>=<code>''</code>, <code>ignore_warn</code>:<code>bool</code>=<code>False</code>, <code>markdown</code>=<code>True</code>)</p>
 </blockquote>
 
 </div>
@@ -74,7 +74,7 @@ <h2 id="Convenience-functions">Convenience functions<a class="anchor-link" href=
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="get_source_link"><code>get_source_link</code><a href="https://github.com/fastai/fastai/blob/master/fastai/gen_doc/nbdoc.py#L322" class="source_link">[source]</a></h4><blockquote><p><code>get_source_link</code>(<code>mod</code>, <code>lineno</code>, <code>display_text</code>=<code>'[source]'</code>) → <code>str</code></p>
+<h4 id="get_source_link"><code>get_source_link</code><a href="https://github.com/fastai/fastai/blob/master/fastai/gen_doc/nbdoc.py#L328" class="source_link">[source]</a></h4><blockquote><p><code>get_source_link</code>(<code>mod</code>, <code>lineno</code>, <code>display_text</code>=<code>'[source]'</code>) → <code>str</code></p>
 </blockquote>
 <p>Returns link to <code>lineno</code> in source code of <code>mod</code>.</p>
 
@@ -95,7 +95,7 @@ <h4 id="get_source_link"><code>get_source_link</code><a href="https://github.com
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="show_video"><code>show_video</code><a href="https://github.com/fastai/fastai/blob/master/fastai/gen_doc/nbdoc.py#L266" class="source_link">[source]</a></h4><blockquote><p><code>show_video</code>(<code>url</code>)</p>
+<h4 id="show_video"><code>show_video</code><a href="https://github.com/fastai/fastai/blob/master/fastai/gen_doc/nbdoc.py#L272" class="source_link">[source]</a></h4><blockquote><p><code>show_video</code>(<code>url</code>)</p>
 </blockquote>
 <p>Display video in <code>url</code>.</p>
 
@@ -116,7 +116,7 @@ <h4 id="show_video"><code>show_video</code><a href="https://github.com/fastai/fa
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="show_video_from_youtube"><code>show_video_from_youtube</code><a href="https://github.com/fastai/fastai/blob/master/fastai/gen_doc/nbdoc.py#L271" class="source_link">[source]</a></h4><blockquote><p><code>show_video_from_youtube</code>(<code>code</code>, <code>start</code>=<code>0</code>)</p>
+<h4 id="show_video_from_youtube"><code>show_video_from_youtube</code><a href="https://github.com/fastai/fastai/blob/master/fastai/gen_doc/nbdoc.py#L277" class="source_link">[source]</a></h4><blockquote><p><code>show_video_from_youtube</code>(<code>code</code>, <code>start</code>=<code>0</code>)</p>
 </blockquote>
 <p>Display video from Youtube with a <code>code</code> and a <code>start</code> time.</p>
 
@@ -143,7 +143,7 @@ <h2 id="Functions-for-internal-fastai-library-use">Functions for internal fastai
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="get_exports"><code>get_exports</code><a href="https://github.com/fastai/fastai/blob/master/fastai/gen_doc/nbdoc.py#L198" class="source_link">[source]</a></h4><blockquote><p><code>get_exports</code>(<code>mod</code>)</p>
+<h4 id="get_exports"><code>get_exports</code><a href="https://github.com/fastai/fastai/blob/master/fastai/gen_doc/nbdoc.py#L204" class="source_link">[source]</a></h4><blockquote><p><code>get_exports</code>(<code>mod</code>)</p>
 </blockquote>
 
 </div>
@@ -170,7 +170,7 @@ <h4 id="get_exports"><code>get_exports</code><a href="https://github.com/fastai/
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="get_fn_link"><code>get_fn_link</code><a href="https://github.com/fastai/fastai/blob/master/fastai/gen_doc/nbdoc.py#L288" class="source_link">[source]</a></h4><blockquote><p><code>get_fn_link</code>(<code>ft</code>) → <code>str</code></p>
+<h4 id="get_fn_link"><code>get_fn_link</code><a href="https://github.com/fastai/fastai/blob/master/fastai/gen_doc/nbdoc.py#L294" class="source_link">[source]</a></h4><blockquote><p><code>get_fn_link</code>(<code>ft</code>) → <code>str</code></p>
 </blockquote>
 <p>Return function link to notebook documentation of <code>ft</code>. Private functions link to source code</p>
 
@@ -191,7 +191,7 @@ <h4 id="get_fn_link"><code>get_fn_link</code><a href="https://github.com/fastai/
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="get_ft_names"><code>get_ft_names</code><a href="https://github.com/fastai/fastai/blob/master/fastai/gen_doc/nbdoc.py#L203" class="source_link">[source]</a></h4><blockquote><p><code>get_ft_names</code>(<code>mod</code>, <code>include_inner</code>=<code>False</code>) → <code>List</code>[<code>str</code>]</p>
+<h4 id="get_ft_names"><code>get_ft_names</code><a href="https://github.com/fastai/fastai/blob/master/fastai/gen_doc/nbdoc.py#L209" class="source_link">[source]</a></h4><blockquote><p><code>get_ft_names</code>(<code>mod</code>, <code>include_inner</code>=<code>False</code>) → <code>List</code>[<code>str</code>]</p>
 </blockquote>
 <p>Return all the functions of module <code>mod</code>.</p>
 
@@ -239,7 +239,7 @@ <h4 id="is_enum"><code>is_enum</code><a href="https://github.com/fastai/fastai/b
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="import_mod"><code>import_mod</code><a href="https://github.com/fastai/fastai/blob/master/fastai/gen_doc/nbdoc.py#L177" class="source_link">[source]</a></h4><blockquote><p><code>import_mod</code>(<code>mod_name</code>:<code>str</code>, <code>ignore_errors</code>=<code>False</code>)</p>
+<h4 id="import_mod"><code>import_mod</code><a href="https://github.com/fastai/fastai/blob/master/fastai/gen_doc/nbdoc.py#L183" class="source_link">[source]</a></h4><blockquote><p><code>import_mod</code>(<code>mod_name</code>:<code>str</code>, <code>ignore_errors</code>=<code>False</code>)</p>
 </blockquote>
 <p>Return module from <code>mod_name</code>.</p>
 
@@ -260,7 +260,7 @@ <h4 id="import_mod"><code>import_mod</code><a href="https://github.com/fastai/fa
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="link_docstring"><code>link_docstring</code><a href="https://github.com/fastai/fastai/blob/master/fastai/gen_doc/nbdoc.py#L153" class="source_link">[source]</a></h4><blockquote><p><code>link_docstring</code>(<code>modules</code>, <code>docstring</code>:<code>str</code>, <code>overwrite</code>:<code>bool</code>=<code>False</code>) → <code>str</code></p>
+<h4 id="link_docstring"><code>link_docstring</code><a href="https://github.com/fastai/fastai/blob/master/fastai/gen_doc/nbdoc.py#L159" class="source_link">[source]</a></h4><blockquote><p><code>link_docstring</code>(<code>modules</code>, <code>docstring</code>:<code>str</code>, <code>overwrite</code>:<code>bool</code>=<code>False</code>) → <code>str</code></p>
 </blockquote>
 <p>Search <code>docstring</code> for backticks and attempt to link those functions to respective documentation.</p>