Try it in your own developer environment

Published

October 23, 2024

Learn how to document a model with ValidMind locally in your own developer environment. You can either clone our open-source repository or download the code samples to run the notebook.

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

You should be familiar with using standard software development tools, including the command line, and have a developer environment set up locally, such as Visual Studio Code.

  • To run our sample Jupyter Notebooks locally, your developer environment must support Python ≧3.8 and <3.11.
  • To clone our open-source repository, you must have access to GitHub. Alternatively, you must be able to download a .zip file containing our code samples that include the introductory Jupyter Notebook.

Steps

Start by retrieving our notebook samples from GitHub, or download them from our website.

Option 1: Clone the open-source repository

  1. Open a terminal or command prompt.

  2. Navigate to the directory where you want to clone the repository.

  3. Run the following command:

    git clone https://github.com/validmind/developer-framework.git

  4. After the cloning process is complete, open notebooks/code_samples/quickstart_customer_churn_full_suite.ipynb in your developer environment and run the notebook.

    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.

Option 2: Download the code samples

  1. Download our selection of code samples: notebooks.zip

  2. Navigate to the location where you saved notebooks.zip and extract the contents.

    Depending on your operating system, you can right-click on notebooks.zip and select Extract All … or Extract Here, for example.

  3. Navigate to the folder where you extracted the files.

  4. Open notebooks/code_samples/quickstart_customer_churn_full_suite.ipynb in your developer environment and run the notebook.

    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.

Run the notebook

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

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

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

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.

What’s next

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