docs: notebooks: Moving between models

Signed-off-by: mHash1m <hashimchaudry23@gmail.com>

.ci/deps.sh

@@ -78,6 +78,10 @@ if [[ "x${PLUGIN}" == "xmodel/autosklearn" ]] || \
   python -m pip install liac-arff psutil smac==0.12.3
 fi
 
+if [[ "x${PLUGIN}" == "xdocs" ]]; then
+  sudo apt-get install -y pandoc
+fi
+
 # ==========================  END  INSTALL DEPENDENCIES ========================
 
 

.gitignore

@@ -21,6 +21,7 @@ htmlcov/
 html/
 pages/
 examples/shouldi/response.json
+examples/notebooks/.ipynb_checkpoints/
 docs/plugins/service/http
 *pip-wheel-metadata/
 *.gz
@@ -34,3 +35,4 @@ docs/swportal.rst
 docs/contributing/consoletest.md
 /consoletest/
 tests/service/logs/
+tests/notebooks/data/

CHANGELOG.md

@@ -10,6 +10,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Tutorial on how to load models dynamically
   https://intel.github.io/dffml/tutorials/models/load.html
 - Added download progressbar in `util/net.py`
+- Usecase example notebook for "Moving between models"
+- Documentation and testing support for notebooks
 ### Changed
 - Calls to hashlib now go through helper functions
 - Build docs using `dffml service dev docs`

docs/conf.py

@@ -62,6 +62,8 @@
     "dffml.util.testing.consoletest.builder",
     "literalinclude_diff",
     "literalinclude_relative",
+    "nbsphinx",
+    "nbsphinx_link",
 ]
 
 intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}

docs/contributing/docs.rst

@@ -1,10 +1,19 @@
 Documentation
 =============
 
-You'll want to have all of the official plugins installed when generating the
-documentation. See :ref:`dev_env_install_official_plugins`.
+Before building the docs, you'll want to have pandocs as well as all of the
+official plugins installed. See :ref:`dev_env_install_official_plugins`.
+For most Linux distros, you can install pandocs by
 
-To build, run the docs script.
+.. code-block:: console
+
+    $ sudo apt-get install pandoc
+
+For alternative ways to install, refer to
+`pandocs documentation <https://pandoc.org/installing.html>`_.
+
+After you have installed the required plugins, you can build the docs by running the
+script.
 
 .. code-block:: console
 

docs/examples/index.rst

@@ -7,6 +7,7 @@ The following are some example use cases of DFFML.
     :maxdepth: 2
     :caption: Contents:
 
+    notebooks/index
     integration
     shouldi
     dataflows

docs/examples/notebooks/index.rst

@@ -0,0 +1,7 @@
+Notebooks
+=========
+
+.. toctree::
+    :maxdepth: 2
+
+    moving_between_models

docs/examples/notebooks/moving_between_models.nblink

@@ -0,0 +1,3 @@
+{
+    "path": "../../../examples/notebooks/moving_between_models.ipynb"
+}