Takeoff Dataiku Plugin (v1.1.1)

The Takeoff Dataiku Plugin allows you to interaface with TitanML Takeoff via dataiku DSS. This plugin is available from dataiku's plugin store for versions of DSS >= 12.6.x. Version 12.5.x is supported on request, or you can build the plugin using the instructions below; an example build for 12.5.2 is provided here. This repo contains the plugin's source code, along with contribution information.

Important

Tutorials and guidance on how to use the plugin can be found here, or you can see a video demo of the plugin in action here.

Contributing

Getting started

This section will assume you are using IntelliJ IDEA as a development environment.

Building

A makefile is provided to build the plugin. This requires you have ant installed and on your PATH, and have your DSS install directory as the environment variable DKUINSTALLDIR.

Setting up IntelliJ for plugin development

To build the project, install the ant Intellij plugin (for more information on the plugin, Then, in the bar on the right of the page (with an ant on it), click the settings icon, and in the execution tab, in the "Ant Command Line" text field, add: see here).

 -Denv.DKUINSTALLDIR=<path/to/dataiku-dss-xx.x.x>

For example, on a Mac with the dataiku free edition:

DKUINSTALLDIR=/Users/fergusbarratt/Library/DataScienceStudio/kits/dataiku-dss
-12.5.1-osx/

Or on linux with a newer version:

DKUINSTALLDIR=/home/titan-m0/dataiku-dss-12.5.2

To give intellij access to the various Dataiku packages, navigate to the IntelliJ Project Structure modal (File->Project Structure, or CMD-;). On this page click the plus icon, and add the /lib/, /dist and /lib/shadelib folders in the DKUINSTALLDIR above.

You'll also need to install gson from maven (Press + -> From Maven -> Search for gson). An example of what your .idea folder should now look like is available in example_idea.md.

This should be enough to get IntelliJ setup to develop the Dataiku plugin. To build the package, in the ant sidebar, click the play icon with the jar task highlighted. A compiler window should appear.

Installing the plugin into Dataiku

To use the plugin in Dataiku, it should be installed as a plugin in the Plugins page. If you develop it in the dataiku dev folder, for OSX that'll look something like:

/Users/fergusbarratt/Library/DataScienceStudio/dss_home/plugins/dev/titan-ml-connector

Or an example for linux:

/home/titan-0/takeoff-dataiku/titan-ml-connector

Alternatively, you can just make symlink from your development environment to the plugins/dev folder.

Then you can make it a development plugin. To make your changes available to any workflows that use the plugin, you have to recompile the java binary (with ant, see above), and then click the reload all button on the dev plugins page.