.. _autodoc-configuration-ref:

Downloading & Saving an ML-AutoDoc
==========================================

ML-AutoDoc can allow direct downloads to a client machine or limit downloads to files systems where Steam is running.

Options:

 - :ref:`download-autodoc-ref`
 - :ref:`save-autodoc-ref`

.. _download-autodoc-ref:

Download an ML-AutoDoc
~~~~~~~~~~~~~~~~~~~~~~

This example shows how to download an AutoDoc to your client machine (e.g., if you connect to Steam from a Jupyter notebook on your laptop, the AutoDoc will download to the path you specify on your laptop).

.. tabs::

   .. code-tab:: python Steam Python

    # import AutoDocConfig class
    from h2osteam.utils import AutoDocConfig

    # get H2O-3 objects required to create an automatic report
    model = h2o.get_model("gbm_model")

    # specify the path to the output file
    output_file_path = "autodoc_report.docx"
    config = AutoDocConfig()
    cluster.download_autodoc(
        model=model,
        config=config,
        train_frame=train,
        path=output_file_path,
    )

.. _save-autodoc-ref:

Save an ML-AutoDoc
~~~~~~~~~~~~~~~~~~

This example shows how to save an AutoDoc to the remote server's file system, where Steam is running. 

.. tabs::
   .. code-tab:: python Steam Python
    # import AutoDocConfig class
    from h2osteam.utils import AutoDocConfig

    # get H2O-3 objects required to create an automatic report
    model = h2o.get_model("gbm_model")

    # specify the path to the output file
    output_file_path = "path/to/remote/directory/autodoc_report.docx"
    config = AutoDocConfig()
    cluster.save_autodoc(
        model=model,
        config=config,
        train_frame=train,
        path=output_file_path,
    )