How-to | Automate Flow documentation exports#

You can add a Flow documentation export as a scenario step in your machine learning model so Dataiku will automatically generate it and add it to the model documentation.

Before adding this step, make sure your project includes a folder to save the Flow documentation. Folders appear in the Flow with a folder icon. To add a folder:

  1. Navigate to the Flow and choose +Dataset > Folder.

  2. Give the folder a label and select Create.

Create new folder dialogue box.

With a folder created, you can now add the Flow documentation step to a scenario.

  1. From the Flow, select the Jobs menu from the top navigation bar.

  2. Choose Scenarios.

The Scenarios option in the Jobs menu.

You can add a step to an existing scenario, or create a new scenario if your project does not have any existing ones.

  1. Choose +New Scenario in the top right and give the scenario a name then choose Create.

  2. Within the scenario, navigate to the Steps tab.

  3. Select Add Step in the bottom left, and then select Export flow documentation.

  4. In Destination folder choose a folder where you want Dataiku to save the Flow documentation.

Scenario steps for exporting flow documentation.

The Flow documentation will now automatically export when you run the scenario and be saved in the designated folder in the Flow.

  1. Select Run in the top right.

  2. After the job completes, navigate to the Flow and double-click on the folder you designated to hold the documentation.

A new version of the documentation will appear in the folder each time you run the scenario. In the folder, you can view the date and time each document was last modified, as well as download, delete, rename, move, or publish the documentation.

Flow documentation exported to folder.

Note

You can also add steps to export model documentation, code notebooks, wikis and other documentation in the scenarios.