Generate documentation for your model

You are now ready to modify the QuickStart notebook you used earlier and run it to generate model documentation and test result with the ValidMind Developer Framework. The resulting artifacts are then uploaded to your model documentation in the ValidMind Platform UI.

Before you begin

• To try out ValidMind, you need to be a registered user on the ValidMind Platform UI.
• Next, make sure you’re logged in to ValidMind .

Need an account for ValidMind?

Signing up is FREE — Register with ValidMind

Steps

1. In the left sidebar, go to the Getting Started section of your previously registered model:¹

   

   Landing page for a model with the Getting Started section highlighted in the left sidebar

   The page that opens provides you with a code snippet to use with the ValidMind Developer Framework, including:

   • api_host: The location of the ValidMind API
   • api_key: The account API key
   • api_secret: The account secret key
   • model: The model identifier

   This code snippet can be copied and pasted directly into your developer source code to integrate the developer framework, enabling it to upload to the ValidMind Platform UI.

   To follow best practices, you can also store the credentials in a .env file² and pass them in via environment variables.

   ² Store project credentials in .env files

2. Locate the code snippet and click Copy snippet to clipboard.

3. Reopen the QuickStart notebook you accessed earlier.³

4. In the QuickStart notebook, replace the vm.init() lines that look like the following with your own client integration information from the earlier step when you registered your new model:

   

   QuickStart notebook in Colab with the section to be replaced highlighted

5. Run each cell in the notebook:

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

   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.

¹ Register your first model

³ In JupyterHub, for example.

What’s next

You can now switch back to the platform UI to view the documentation that has been generated by the developer framework.

Ready to learn more about how you can use ValidMind? Check out Next Steps.