mlvis 0.0.5a1.dev3

A wrapper around react components for use in jupyter notebooks

Jupyter Bindings

Integrate MLVis packages to Jupyter notebook.

Install

pip install mlvis

Then install the nbextension into the Jupyter notebook

jupyter nbextension install --py --symlink --sys-prefix mlvis
jupyter nbextension enable --py --sys-prefix mlvis

Development

Javascript

First, copy over the contents from jupyter-manifold

cd ../jupyter-manifold
yarn
yarn build

Build the JS code

cd js
yarn
yarn build

Python

It is recommended to first start a virtual environment in the project folder:

python -m venv venv
source venv/bin/activate

To run the code directly under this directory, the Jupyter nbextension needs to be installed in this local environment:

python setup.py install

If running python setup.py install for the first time, the following two commands need to be executed (these should only need to be executed once).

jupyter nbextension install --py --symlink --sys-prefix mlvis
jupyter nbextension enable --py --sys-prefix mlvis

Run

Start the Jupyter Notebook directly under this directory:

jupyter notebook

Build

To build the package into the example directly, please use the following command:

python setup.py sdist bdist_wheel
mv dist ../../examples/jupyter/

To test the built package in the example folder, go to mlvis-toolkit/examples/jupyter, and perform the following stepts:

1. start a virtual environment
2. run pip install -r requirements.txt
3. run pip install ./dist/mlvis-[version].tar.gz
4. execute jupyter notebook there.