Try it with JupyterHub (recommended)

Learn how to document a model with ValidMind on JupyterHub.

Before you begin

To try out ValidMind, you need to be a registered user on the ValidMind Platform UI.

Need an account for ValidMind?

Signing up is FREE — Register with ValidMind

Steps

1. In a web browser, open Quickstart for model documentation.

   This link takes you to ValidMind’s JupyterHub instance where you can log in with the Auth0 credentials for your ValidMind account to access the QuickStart for model documentation notebook:

   

   QuickStart notebook opened in JupyterHub

   The notebook will guide you through installing the ValidMind Developer Framework, initializing the Python environment, and finally initializing the ValidMind Client Library by connecting to the ValidMind Platform UI.

2. Follow the instructions to run the first two code cells in the notebook, which will set the stage by installing and initializing ValidMind:¹

   • Hover over each cell and click the icon; OR
   • Press Shift + Enter on Windows or Cmd + Enter if you are on a Mac

   Under the cell at bottom of the Initialize the client library section, confirm that you see a success message that looks something like this:

   2024-10-08 22:06:42,610 - INFO(validmind.api_client): 🎉 Connected to ValidMind!
   📊 Model: [Demo] Customer Churn Model (ID: clwqy70qd01my22ikc49paar9)
   📁 Document Type: model_documentation

   This message verifies that the developer framework works as expected as is connected to the correct model within the platform UI.

¹ Install and initialize the client library

You can now continue running the rest of the cells if you want to see how the demo notebook works or, to save some time, you can move on to the Explore sample model documentation to explore the platform UI.

Watch the tutorial

Need more help? Experience this guide in video format:

What’s next

Continue with Explore sample model documentation to learn more about using the ValidMind AI risk platform hands-on.