Plotly

Video Walkthrough

What will you get with this integration?

Plotly is one of the most common python graphing libraries to make interactive graphs. This integration lets you log interactive charts generated in plotly to Neptune.

Introduction

This guide will show you how to:

  • Initialize Neptune and create a run,

  • Log plotly charts to Neptune.

Step 0: Before you start

Install neptune-client and plotly:

pip install --upgrade neptune-client plotly

This integration is tested with neptune-client==0.9.19 and plotly==5.0.0

Step 1: Import and initialize neptune

import neptune.new as neptune
run = neptune.init(api_token='<your_api_token>',
project='<your_project_name>')

You can use the api_token='ANONYMOUS' and project='common/plotly-support' to explore without having to create a Neptune account

Executing this cell will give you a link looking like: https://app.neptune.ai/common/plotly-support/e/PLOT-2 with common/plotly-support replaced by your project, and PLOT-2 replaced by your run.

Click on the link to open the run in Neptune. For now, it is empty but keep the tab with the run open to see what happens next.

Step 2: Log Plotly figures to Neptune

Create a sample figure

import plotly.express as px
df = px.data.iris()
plotly_fig = px.scatter_3d(df,
x='sepal_length', y='sepal_width', z='petal_width',
color='species')

Log interactive figure

run['interactive_img'].upload(neptune.types.File.as_html(plotly_fig))

Step 3: Stop logging

Once you are done logging, you should stop tracking the run using the stop() method. This is needed only while logging from a notebook environment. While logging through a script, Neptune automatically stops tracking once the script has completed execution.

run.stop()

Step 4: Explore the results in the Neptune

The images can be found in the All Metadata section:

Conclusion

You have learned how to:

  • Initialize Neptune and create a run,

  • Log plotly charts to Neptune.

What's next

Now that you know how to log charts to Neptune, you can learn: