Installing H2O AutoDoc

H2O AutoDoc Requirements

  • Python 3.5, 3.6, or 3.7

  • H2O-3 3.24.0.1 or higher

  • A supported H2O model. Supported models include:

    • Deep Learning

    • Distributed Random Forest (including Extremely Randomized Forest)

    • Generalized Linear Model

    • Gradient Boosting Machine

    • Stacked Ensembles

    • XGBoost

H2O AutoDoc Setup & Installation

  1. Install the required dependencies for h2o_autodoc (example on an Ubuntu system).

wget https://github.com/jgm/pandoc/releases/download/2.9.1.1/pandoc-2.9.1.1-1-amd64.deb
dpkg -i pandoc*.deb

For instructions for Mac OS X, see the Pandoc Downloads page.

  1. Download and install the H2O AutoDoc wheel.

pip install h2o_autodoc-SUBST_AUTODOC_VERSION-cp36-cp36m-SUBST_OS_SUBST_ARCH.whl

After H2O AutoDoc is installed, the next step is to create a model and then generate an H2O AutoDoc report for that model.

H2O AutoDoc License Key

The H2O AutoDoc Python package requires a license key. The license key can be specified through several options:

  • Through a Config class parameters:

    • license_file: the file system location for the license file

    • license_text: the license text

  • Through an Environment variable:

    • ‘AUTODOC_LICENSE_FILE’: the location of file containing the license key

    • ‘AUTODOC_LICENSE_KEY’: the license key

  • Through License file in standard location:

    • /license/license.sig: the file containing the license key

    • ~/.h2o_autodoc/license.sig: the file containing the license key on user home