deploy: 25e50cf

Author: github-actions[bot]

.nojekyll

@@ -0,0 +1 @@
+nbdev.fast.ai

CNAME

@@ -0,0 +1,231 @@
+# clean
+
+
+<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
+
+To avoid pointless conflicts while working with jupyter notebooks (with
+different execution counts or cell metadata), it is recommended to clean
+the notebooks before committing anything (done automatically if you
+install the git hooks with `nbdev-install-hooks`). The following
+functions are used to do that. Cleaning also adds cell `id`s if missing
+(required by nbformat 4.5+).
+
+## Trust
+
+------------------------------------------------------------------------
+
+<a
+href="https://github.com/AnswerDotAI/nbdev/blob/main/nbdev/clean.py#L25"
+target="_blank" style="float:right; font-size:smaller">source</a>
+
+### nbdev_trust
+
+``` python
+
+def nbdev_trust(
+    fname:str=None, # A notebook name or glob to trust
+    force_all:bool=False, # Also trust notebooks that haven't changed
+):
+
+```
+
+*Trust notebooks matching `fname`.*
+
+## Clean
+
+------------------------------------------------------------------------
+
+<a
+href="https://github.com/AnswerDotAI/nbdev/blob/main/nbdev/clean.py#L87"
+target="_blank" style="float:right; font-size:smaller">source</a>
+
+### clean_nb
+
+``` python
+
+def clean_nb(
+    nb, # The notebook to clean
+    clear_all:bool=False, # Remove all cell metadata and cell outputs?
+    allowed_metadata_keys:list=None, # Preserve the list of keys in the main notebook metadata
+    allowed_cell_metadata_keys:list=None, # Preserve the list of keys in cell level metadata
+    clean_ids:bool=True, # Remove ids from plaintext reprs?
+):
+
+```
+
+*Clean `nb` from superfluous metadata*
+
+Jupyter adds a trailing <code></code> to images in cell outputs.
+Vscode-jupyter does not.  
+Notebooks should be brought to a common style to avoid unnecessary
+diffs:
+
+``` python
+test_nb = read_nb('../../tests/image.ipynb')
+assert test_nb.cells[0].outputs[0].data['image/png'][-1] == "\n" # Make sure it was not converted by acccident
+clean_nb(test_nb)
+assert test_nb.cells[0].outputs[0].data['image/png'][-1] != "\n"
+```
+
+The test notebook has metadata in both the main metadata section and
+contains cell level metadata in the second cell:
+
+``` python
+test_nb = read_nb('../../tests/metadata.ipynb')
+
+assert {'meta', 'jekyll', 'my_extra_key', 'my_removed_key'} <= test_nb.metadata.keys()
+assert {'meta', 'hide_input', 'my_extra_cell_key', 'my_removed_cell_key'} == test_nb.cells[1].metadata.keys()
+```
+
+After cleaning the notebook, all extra metadata is removed, only some
+keys are allowed by default:
+
+``` python
+clean_nb(test_nb)
+
+assert {'jekyll', 'kernelspec'} == test_nb.metadata.keys()
+assert {'hide_input'} == test_nb.cells[1].metadata.keys()
+```
+
+We can preserve some additional keys at the notebook or cell levels:
+
+``` python
+test_nb = read_nb('../../tests/metadata.ipynb')
+clean_nb(test_nb, allowed_metadata_keys={'my_extra_key'}, allowed_cell_metadata_keys={'my_extra_cell_key'})
+
+assert {'jekyll', 'kernelspec', 'my_extra_key'} == test_nb.metadata.keys()
+assert {'hide_input', 'my_extra_cell_key'} == test_nb.cells[1].metadata.keys()
+```
+
+Passing `clear_all=True` removes everything from the cell metadata:
+
+``` python
+test_nb = read_nb('../../tests/metadata.ipynb')
+clean_nb(test_nb, clear_all=True)
+
+assert {'jekyll', 'kernelspec'} == test_nb.metadata.keys()
+test_eq(test_nb.cells[1].metadata, {})
+```
+
+Passing `clean_ids=True` removes `id`s from plaintext repr outputs, to
+avoid notebooks whose contents change on each run since they often lead
+to git merge conflicts. For example:
+
+    <PIL.PngImagePlugin.PngImageFile image mode=L size=28x28 at 0x7FB4F8979690>
+
+becomes:
+
+    <PIL.PngImagePlugin.PngImageFile image mode=L size=28x28>
+
+*Cell* IDs, on the other hand, are always added if missing
+
+``` python
+test_cell = {'source': 'x=1', 'cell_type': 'code', 'metadata': {}}
+_clean_cell(test_cell, False, set(), True)
+test_cell['id']
+```
+
+    'b3c0571e'
+
+------------------------------------------------------------------------
+
+<a
+href="https://github.com/AnswerDotAI/nbdev/blob/main/nbdev/clean.py#L112"
+target="_blank" style="float:right; font-size:smaller">source</a>
+
+### process_write
+
+``` python
+
+def process_write(
+    warn_msg, proc_nb, f_in, f_out:NoneType=None, disp:bool=False
+):
+
+```
+
+------------------------------------------------------------------------
+
+<a
+href="https://github.com/AnswerDotAI/nbdev/blob/main/nbdev/clean.py#L135"
+target="_blank" style="float:right; font-size:smaller">source</a>
+
+### nbdev_clean
+
+``` python
+
+def nbdev_clean(
+    fname:str=None, # A notebook name or glob to clean
+    clear_all:bool=False, # Remove all cell metadata and cell outputs?
+    disp:bool=False, # Print the cleaned outputs
+    stdin:bool=False, # Read notebook from input stream
+):
+
+```
+
+*Clean all notebooks in `fname` to avoid merge conflicts*
+
+By default (`fname` left to `None`), all the notebooks in
+`config.nbs_path` are cleaned. You can opt in to fully clean the
+notebook by removing every bit of metadata and the cell outputs by
+passing `clear_all=True`.
+
+If you want to keep some keys in the main notebook metadata you can set
+`allowed_metadata_keys` in `[tool.nbdev]` in `pyproject.toml`. Similarly
+for cell level metadata use: `allowed_cell_metadata_keys`. For example,
+to preserve both `k1` and `k2` at both the notebook and cell level add
+the following to `pyproject.toml`:
+
+``` toml
+[tool.nbdev]
+allowed_metadata_keys = ["k1", "k2"]
+allowed_cell_metadata_keys = ["k1", "k2"]
+```
+
+------------------------------------------------------------------------
+
+<a
+href="https://github.com/AnswerDotAI/nbdev/blob/main/nbdev/clean.py#L150"
+target="_blank" style="float:right; font-size:smaller">source</a>
+
+### clean_jupyter
+
+``` python
+
+def clean_jupyter(
+    path, model, kwargs:VAR_KEYWORD
+):
+
+```
+
+*Clean Jupyter `model` pre save to `path`*
+
+This cleans notebooks on-save to avoid unnecessary merge conflicts. The
+easiest way to install it for both Jupyter Notebook and Lab is by
+running `nbdev-install-hooks`. It works by implementing a
+`pre_save_hook` from Jupyter’s [file save hook
+API](https://jupyter-server.readthedocs.io/en/latest/developers/savehooks.html).
+
+## Hooks
+
+------------------------------------------------------------------------
+
+<a
+href="https://github.com/AnswerDotAI/nbdev/blob/main/nbdev/clean.py#L191"
+target="_blank" style="float:right; font-size:smaller">source</a>
+
+### nbdev_install_hooks
+
+``` python
+
+def nbdev_install_hooks(
+    
+):
+
+```
+
+*Install Jupyter and git hooks to automatically clean, trust, and fix
+merge conflicts in notebooks*
+
+See
+[`clean_jupyter`](https://nbdev.fast.ai/api/clean.html#clean_jupyter)
+and `nbdev-merge` for more about how each hook works.