Generate documentation for your model

Published

September 4, 2024

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

Need an account for ValidMind?

Signing up is FREE — Create your account.

Steps

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

    The QuickStart notebook in Colab with the section showing that you need to replace

    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
    • project: The project identifier

    This code snippet can be copied and pasted directly into your developer source code to integrate the developer framework and to be able 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.

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

  3. Reopen the QuickStart notebook you accessed earlier (in JupyterHub, for example).

  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:

    The QuickStart notebook in Colab with the section showing that you need to replace

  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 install the ValidMind library and then connect to the ValidMind Platform UI.

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.