Installation

Welcome!

If you arrived here after signing up: Congratulations! Your account has also been accredited with 150€ worth of credits.

If you have not signed up yet, follow this link to sign up.

Your first step is to install the Core Engine CLI. In order to install the Command Line Utilities for the maiot Core Engine, you need to use good old pip for Python. Please note that we only support Python >= 3.5, so adjust your pip accordingly.

Virtual Environment

Also, we highly encourage you to install the Core Engine on a virtual environment. We install dependencies like PyArrow and Tensorflow that might cause your base installations to be overridden.

We like to use virtualenvwrapper to manage our Python virtual environments.

Install with pip

When you're set with your environment, run:

pip install cengine
caution

cengine requires Python 3.5 or higher.

Once the installation is completed, you can check whether the installation was successful through:

cengine --version

If you would like to learn more about the current release of the CLI, please visit the PyPi homepage.

Tensorflow Model Analysis support

In order to get the Tensoflow Model Analysis evaluation visualizations to work, you must also run:

jupyter nbextension install --py --symlink tensorflow_model_analysis
jupyter nbextension enable --py tensorflow_model_analysis
important

You might be required to run this as sudo if you're not working on a virtualenv.

warning

If you encounter a File already exists in database error error after the first command, this is most likely due to a known bug with one of our dependencies, namely PyArrow. Unfortuanetely, this will cause some features to not work on your machine (namely pipeline evaluate and compare).

We are aware of this issue and are working hard to fix it. The next release (> 0.0.15) of the cengine CLI will fix this issue.

Enabling auto completion on the CLI

For Bash, add this to ~/.bashrc:

eval "$(_CENGINE_COMPLETE=source_bash cengine)"

For Zsh, add this to ~/.zshrc:

eval "$(_CENGINE_COMPLETE=source_zsh cengine)"

For Fish, add this to ~/.config/fish/completions/foo-bar.fish:

eval (env _CENGINE_COMPLETE=source_fish cengine)