Working with Plotly

Plotly is one of the most common Python graphing libraries for interactive graphs.

You can log interactive 2D and 3D charts generated in Plotly to Neptune.

See in Neptune  Example script 

Before you start

Tip

To follow the guide without any setup, run the Colab example.

• Set up Neptune. Instructions:
  • Installing Neptune
  • Setting your API token
  • Setting the project name
  • Creating a Neptune project

• Install Plotly:

  pipconda

  pip install -U plotly
  

  conda install -c conda-forge plotly
  

Matplotlib incompatibility

Plotly is not compatible with the latest Matplotlib (3.5.0+) due to the fact that mpl_to_plotly() uses deprecated Matplotlib functionalities.

To use Plotly together with Matplotlib, you may need to downgrade your Matplotlib version to <3.5. For more information, see Plotly issue 1568 and issue 3624 on GitHub.

Plotly logging example

1. Import Neptune and start a run:

   import neptune
   
   run = neptune.init_run()  # (1)!
   

   1. If you haven't set up your credentials, you can log anonymously: neptune.init_run(api_token=neptune.ANONYMOUS_API_TOKEN, project="common/plotly-support")

2. 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"
   )
   

3. Upload the interactive figure:

   run["interactive_img"].upload(plotly_fig)
   

4. To stop the connection to Neptune and sync all data, call the stop() method:

   run.stop()
   

5. To open the run, click the Neptune link that appears in the console output.

   Example link: https://app.neptune.ai/common/plotly-support/e/PLOT-2

6. Find the logged images in the All Metadata section.