diff --git a/README.md b/README.md index b2759c93b1..f9a5aa7e1f 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,9 @@ This is the home for the user-facing documentation and related infrastructure fo We believe in the power of collaboration and welcome contributions from the community. If you've noticed an issue or have ideas for improvement, please create a pull request or submit an issue. A member of ValidMind's documentation team will review your suggestions and support you in contributing to the docs. -- Follow the [Quickstart](https://docs.validmind.ai/get-started/developer/try-with-jupyterhub.html) for a 15-minute introduction to the Developer Framework and ValidMind Platform. +- Follow the [Quickstart](https://docs.validmind.ai/get-started/developer/try-with-jupyterhub.html) for a 15-minute introduction to the ValidMind Library and ValidMind Platform. -- Read the [Developer Framework docs](https://docs.validmind.ai/developer/get-started-developer-framework.html) for more information about ValidMind's open source tests and Jupyter notebooks. +- Read the [ValidMind Library docs](https://docs.validmind.ai/developer/get-started-validmind-library.html) for more information about ValidMind's open source tests and Jupyter notebooks. - Join the [Community Slack](https://docs.validmind.ai/about/contributing/join-community.html) to ask questions, get support, and connect with Model Risk Management (MRM) practioners. diff --git a/internal/templates/about-validmind.md b/internal/templates/about-validmind.md deleted file mode 100644 index f1632fde7f..0000000000 --- a/internal/templates/about-validmind.md +++ /dev/null @@ -1,48 +0,0 @@ -## About ValidMind - -ValidMind is a platform for managing model risk, including risk associated with AI and statistical models. You use the ValidMind Developer Framework to automate documentation and validation tests, and then use the ValidMind AI Risk Platform UI to collaborate on model documentation. Together, these products simplify model risk management, facilitate compliance with regulations and institutional standards, and enhance collaboration between yourself and model validators. - -### Before you begin - -This notebook assumes you have basic familiarity with Python, including an understanding of how functions work. If you are new to Python, you can still run the notebook but we recommend further familiarizing yourself with the language. - -If you encounter errors due to missing modules in your Python environment, install the modules with `pip install`, and then re-run the notebook. For more help, refer to [Installing Python Modules](https://docs.python.org/3/installing/index.html). - -### New to ValidMind? - -If you haven't already seen our [Get started with the ValidMind Developer Framework](/developer/get-started-developer-framework.qmd), we recommend you explore the available resources for developers at some point. There, you can learn more about documenting models, find code samples, or read our developer reference. - -::: {.callout-tip} - -For access to all features available in this notebook, create a free ValidMind account. - -Signing up is FREE — {{< var link.register >}} - -::: - -### Key concepts - -**Model documentation**: A structured and detailed record pertaining to a model, encompassing key components such as its underlying assumptions, methodologies, data sources, inputs, performance metrics, evaluations, limitations, and intended uses. It serves to ensure transparency, adherence to regulatory requirements, and a clear understanding of potential risks associated with the model’s application. - -**Documentation template**: Functions as a test suite and lays out the structure of model documentation, segmented into various sections and sub-sections. Documentation templates define the structure of your model documentation, specifying the tests that should be run, and how the results should be displayed. - -**Tests**: A function contained in the ValidMind Developer Framework, designed to run a specific quantitative test on the dataset or model. Tests are the building blocks of ValidMind, used to evaluate and document models and datasets, and can be run individually or as part of a suite defined by your model documentation template. - -**Metrics**: A subset of tests that do not have thresholds. In the context of this notebook, metrics and tests can be thought of as interchangeable concepts. - -**Custom metrics**: Custom metrics are functions that you define to evaluate your model or dataset. These functions can be registered with ValidMind to be used in the platform. - -**Inputs**: Objects to be evaluated and documented in the ValidMind framework. They can be any of the following: - - - **model**: A single model that has been initialized in ValidMind with [`vm.init_model()`](/validmind/validmind.html#init_model). - - **dataset**: Single dataset that has been initialized in ValidMind with [`vm.init_dataset()`](/validmind/validmind.html#init_dataset). - - **models**: A list of ValidMind models - usually this is used when you want to compare multiple models in your custom metric. - - **datasets**: A list of ValidMind datasets - usually this is used when you want to compare multiple datasets in your custom metric. See this [example](/notebooks/how_to/run_tests_that_require_multiple_datasets.ipynb) for more information. - -**Parameters**: Additional arguments that can be passed when running a ValidMind test, used to pass additional information to a metric, customize its behavior, or provide additional context. - -**Outputs**: Custom metrics can return elements like tables or plots. Tables may be a list of dictionaries (each representing a row) or a pandas DataFrame. Plots may be matplotlib or plotly figures. - -**Test suites**: Collections of tests designed to run together to automate and generate model documentation end-to-end for specific use-cases. - -Example: the [`classifier_full_suite`](/validmind/validmind/test_suites/classifier.html#ClassifierFullSuite) test suite runs tests from the [`tabular_dataset`](/validmind/validmind/test_suites/tabular_datasets.html) and [`classifier`](/validmind/validmind/test_suites/classifier.html) test suites to fully document the data and model sections for binary classification model use-cases. diff --git a/internal/templates/before_you_begin.ipynb b/internal/templates/before_you_begin.ipynb deleted file mode 100644 index 2970cd210c..0000000000 --- a/internal/templates/before_you_begin.ipynb +++ /dev/null @@ -1,97 +0,0 @@ -{ - "cells": [ - { - "attachments": {}, - "cell_type": "markdown", - "metadata": { - "id": "CAQPDHbf9J-o" - }, - "source": [ - "## Before you begin\n", - "\n", - "To use the ValidMind Developer Framework with a Jupyter notebook, you need to install and initialize the client library first, along with getting your Python environment ready.\n", - "\n", - "If you don't already have one, you should also [create a documentation project](https://docs.validmind.ai/guide/create-your-first-documentation-project.html) on the ValidMind platform. You will use this project to upload your documentation and test results." - ] - }, - { - "attachments": {}, - "cell_type": "markdown", - "metadata": { - "id": "nK4I5iddCjjN" - }, - "source": [ - "## Install the client library" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "metadata": {}, - "outputs": [], - "source": [ - "%pip install --upgrade validmind" - ] - }, - { - "attachments": {}, - "cell_type": "markdown", - "metadata": {}, - "source": [ - "## Initialize the client library\n", - "\n", - "In a browser, go to the **Client Integration** page of your documentation project and click **Copy to clipboard** next to the code snippet. This code snippet gives you the API key, API secret, and project identifier to link your notebook to your documentation project.\n", - "\n", - "::: {.column-margin}\n", - "::: {.callout-tip}\n", - "This step requires a documentation project. [Learn how you can create one](https://docs.validmind.ai/guide/create-your-first-documentation-project.html).\n", - ":::\n", - ":::\n", - "\n", - "Next, replace this placeholder with your own code snippet:" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "metadata": {}, - "outputs": [], - "source": [ - "## Replace with code snippet from your documentation project ##\n", - "\n", - "import validmind as vm\n", - "\n", - "vm.init(\n", - " api_host=\"https://api.prod.validmind.ai/api/v1/tracking\",\n", - " api_key=\"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n", - " api_secret=\"API_SECRET\",\n", - " project=\"xxxxxxxxxxxxxxxxxxxxxxxxx\"\n", - ")" - ] - } - ], - "metadata": { - "colab": { - "provenance": [] - }, - "kernelspec": { - "display_name": "Python 3", - "language": "python", - "name": "python3" - }, - "language_info": { - "codemirror_mode": { - "name": "ipython", - "version": 3 - }, - "file_extension": ".py", - "mimetype": "text/x-python", - "name": "python", - "nbconvert_exporter": "python", - "pygments_lexer": "ipython3", - "version": "3.9.7" - } - }, - "nbformat": 4, - "nbformat_minor": 0 -} \ No newline at end of file diff --git a/internal/templates/jupyter-notebooks/about-validmind.ipynb b/internal/templates/jupyter-notebooks/about-validmind.ipynb new file mode 100644 index 0000000000..e2d202ffb4 --- /dev/null +++ b/internal/templates/jupyter-notebooks/about-validmind.ipynb @@ -0,0 +1,63 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## About ValidMind\n", + "\n", + "ValidMind is a suite of tools for managing model risk, including risk associated with AI and statistical models. \n", + "\n", + "You use the ValidMind Library to automate documentation and validation tests, and then use the ValidMind Platform to collaborate on model documentation. Together, these products simplify model risk management, facilitate compliance with regulations and institutional standards, and enhance collaboration between yourself and model validators.\n", + "\n", + "### Before you begin\n", + "\n", + "This notebook assumes you have basic familiarity with Python, including an understanding of how functions work. If you are new to Python, you can still run the notebook but we recommend further familiarizing yourself with the language. \n", + "\n", + "If you encounter errors due to missing modules in your Python environment, install the modules with `pip install`, and then re-run the notebook. For more help, refer to [Installing Python Modules](https://docs.python.org/3/installing/index.html).\n", + "\n", + "### New to ValidMind?\n", + "\n", + "If you haven't already seen our [Get started with the ValidMind Library](https://docs.validmind.ai/guide/get-started-validmind-library.html), we recommend you explore the available resources for developers at some point. There, you can learn more about documenting models, find code samples, or read our developer reference.\n", + "\n", + "
For access to all features available in this notebook, create a free ValidMind account.\n", + "

\n", + "Signing up is FREE — Register with ValidMind
\n", + "\n", + "### Key concepts\n", + "\n", + "**Model documentation**: A structured and detailed record pertaining to a model, encompassing key components such as its underlying assumptions, methodologies, data sources, inputs, performance metrics, evaluations, limitations, and intended uses. It serves to ensure transparency, adherence to regulatory requirements, and a clear understanding of potential risks associated with the model’s application.\n", + "\n", + "**Documentation template**: Functions as a test suite and lays out the structure of model documentation, segmented into various sections and sub-sections. Documentation templates define the structure of your model documentation, specifying the tests that should be run, and how the results should be displayed.\n", + "\n", + "**Tests**: A function contained in the ValidMind Library, designed to run a specific quantitative test on the dataset or model. Tests are the building blocks of ValidMind, used to evaluate and document models and datasets, and can be run individually or as part of a suite defined by your model documentation template.\n", + "\n", + "**Metrics**: A subset of tests that do not have thresholds. In the context of this notebook, metrics and tests can be thought of as interchangeable concepts.\n", + "\n", + "**Custom metrics**: Custom metrics are functions that you define to evaluate your model or dataset. These functions can be registered with the ValidMind Library to be used in the ValidMind Platform.\n", + "\n", + "**Inputs**: Objects to be evaluated and documented in the ValidMind Library. They can be any of the following:\n", + "\n", + " - **model**: A single model that has been initialized in ValidMind with [`vm.init_model()`](/validmind/validmind.html#init_model).\n", + " - **dataset**: Single dataset that has been initialized in ValidMind with [`vm.init_dataset()`](/validmind/validmind.html#init_dataset).\n", + " - **models**: A list of ValidMind models - usually this is used when you want to compare multiple models in your custom metric.\n", + " - **datasets**: A list of ValidMind datasets - usually this is used when you want to compare multiple datasets in your custom metric. See this [example](/notebooks/how_to/run_tests_that_require_multiple_datasets.ipynb) for more information.\n", + "\n", + "**Parameters**: Additional arguments that can be passed when running a ValidMind test, used to pass additional information to a metric, customize its behavior, or provide additional context.\n", + "\n", + "**Outputs**: Custom metrics can return elements like tables or plots. Tables may be a list of dictionaries (each representing a row) or a pandas DataFrame. Plots may be matplotlib or plotly figures.\n", + "\n", + "**Test suites**: Collections of tests designed to run together to automate and generate model documentation end-to-end for specific use-cases.\n", + "\n", + "Example: the [`classifier_full_suite`](/validmind/validmind/test_suites/classifier.html#ClassifierFullSuite) test suite runs tests from the [`tabular_dataset`](/validmind/validmind/test_suites/tabular_datasets.html) and [`classifier`](/validmind/validmind/test_suites/classifier.html) test suites to fully document the data and model sections for binary classification model use-cases." + ] + } + ], + "metadata": { + "language_info": { + "name": "python" + } + }, + "nbformat": 4, + "nbformat_minor": 2 +} diff --git a/internal/templates/jupyter-notebooks/install-initialize-validmind.ipynb b/internal/templates/jupyter-notebooks/install-initialize-validmind.ipynb new file mode 100644 index 0000000000..bf7c62b2a7 --- /dev/null +++ b/internal/templates/jupyter-notebooks/install-initialize-validmind.ipynb @@ -0,0 +1,75 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Install the ValidMind Library\n", + "\n", + "To install the library:" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "%pip install -q validmind" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Initialize the ValidMind Library\n", + "\n", + "ValidMind generates a unique _code snippet_ for each registered model to connect with your developer environment. You initialize the ValidMind Library with this code snippet, which ensures that your documentation and tests are uploaded to the correct model when you run the notebook.\n", + "\n", + "### Get your code snippet\n", + "\n", + "1. In a browser, [log in to ValidMind](https://docs.validmind.ai/guide/configuration/log-in-to-validmind.html).\n", + "\n", + "2. In the left sidebar, navigate to **Model Inventory** and click **+ Register new model**.\n", + "\n", + "3. Enter the model details and click **Continue**. ([Need more help?](https://docs.validmind.ai/guide/model-inventory/register-models-in-inventory.html))\n", + "\n", + " For example, to register a model for use with this notebook, select:\n", + "\n", + " - Documentation template: `Template name here`\n", + " - Use case: `Use case here`\n", + "\n", + " You can fill in other options according to your preference.\n", + "\n", + "4. Go to **Getting Started** and click **Copy snippet to clipboard**.\n", + "\n", + "Next, replace this placeholder with your own code snippet:\n" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Replace with your code snippet\n", + "\n", + "import validmind as vm\n", + "\n", + "vm.init(\n", + " api_host=\"https://api.prod.validmind.ai/api/v1/tracking\",\n", + " api_key=\"...\",\n", + " api_secret=\"...\",\n", + " model=\"...\",\n", + ")" + ] + } + ], + "metadata": { + "language_info": { + "name": "python" + } + }, + "nbformat": 4, + "nbformat_minor": 2 +} diff --git a/internal/templates/jupyter-notebooks/next-steps.ipynb b/internal/templates/jupyter-notebooks/next-steps.ipynb new file mode 100644 index 0000000000..45bf565dbb --- /dev/null +++ b/internal/templates/jupyter-notebooks/next-steps.ipynb @@ -0,0 +1,70 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Next steps\n", + "\n", + "You can look at the output produced by the ValidMind Library right in the notebook where you ran the code, as you would expect. But there is a better way: use the ValidMind Platform to work with your model documentation.\n", + "\n", + "### Work with your model documentation\n", + "\n", + "1. From the **Model Inventory** in the ValidMind Platform, go to the model you registered earlier. ([Need more help?](https://docs.validmind.ai/guide/model-inventory/working-with-model-inventory.html))\n", + "\n", + "2. Click and expand the **Model Development** section.\n", + "\n", + "What you see is the full draft of your model documentation in a more easily consumable version. From here, you can make qualitative edits to model documentation, view guidelines, collaborate with validators, and submit your model documentation for approval when it's ready. [Learn more ...](https://docs.validmind.ai/guide/working-with-model-documentation.html)\n", + "\n", + "### Discover more learning resources\n", + "\n", + "We offer many interactive notebooks to help you document models:\n", + "\n", + "- [Run tests & test suites](https://docs.validmind.ai/guide/testing-overview.html)\n", + "- [Code samples](https://docs.validmind.ai/guide/samples-jupyter-notebooks.html)\n", + "\n", + "Or, visit our [documentation](https://docs.validmind.ai/) to learn more about ValidMind." + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Upgrade ValidMind\n", + "\n", + "
After installing ValidMind, you’ll want to periodically make sure you are on the latest version to access any new features and other enhancements.
\n", + "\n", + "Retrieve the information for the currently installed version of ValidMind:" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "%pip show validmind" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "If the version returned is lower than the version indicated in our [production open-source code](https://github.com/validmind/developer-framework/blob/prod/validmind/__version__.py), restart your notebook and run:\n", + "\n", + "```bash\n", + "%pip install --upgrade validmind\n", + "```\n", + "\n", + "You may need to restart your kernel after running the upgrade package for changes to be applied." + ] + } + ], + "metadata": { + "language_info": { + "name": "python" + } + }, + "nbformat": 4, + "nbformat_minor": 2 +} diff --git a/internal/templates/mermaid-diagrams.qmd b/internal/templates/mermaid-diagrams.qmd index ff4b790951..856cf55026 100644 --- a/internal/templates/mermaid-diagrams.qmd +++ b/internal/templates/mermaid-diagrams.qmd @@ -18,23 +18,23 @@ graph TD ```{mermaid} graph TD A[Create notebook
to select and
build relevant tests] --> B[From your modeling
environment,
load trained datasets
and models.] - B --> C[Initialize developer framework.] + B --> C[Initialize the ValidMind Library.] C --> D[Select relevant tests.] D --> E{Check if all
tests covered by
ValidMind or
custom test
provider?} E -- Yes --> F[Run selected tests] F --> G[Review test results] E -- No --> H[Create and register additional tests] - G --> I[ValidMind Platform UI:
Add content blocks to model documentation] + G --> I[ValidMind Platform:
Add content blocks to model documentation] H --> E ``` -### In {{< var validmind.platform >}} +### In the {{< var validmind.platform >}} ```{mermaid} graph TB A[Register new model] --> B[Select documentation template] B --> C[Review template structure] - C --> D[View framework integration instructions] + C --> D[View ValidMind Library integration instructions] D --> E[Add content blocks to model documentation:] E --> F[Select the block type:] F --> G[Test-driven block: Select from available test provider results] diff --git a/internal/templates/next-steps.md b/internal/templates/next-steps.md deleted file mode 100644 index dd419b880d..0000000000 --- a/internal/templates/next-steps.md +++ /dev/null @@ -1,20 +0,0 @@ -## Next steps - -You can look at the output produced by the ValidMind Developer Framework right in the notebook where you ran the code, as you would expect. But there is a better way: use the ValidMind platform to work with your model documentation. - -### Work with your model documentation - -1. From the [**Model Inventory**](https://app.prod.validmind.ai/model-inventory) in the ValidMind Platform UI, go to the model you registered earlier. - -2. Click and expand the **Model Development** section. - -What you see is the full draft of your model documentation in a more easily consumable version. From here, you can make qualitative edits to model documentation, view guidelines, collaborate with validators, and submit your model documentation for approval when it's ready. [Learn more ...](https://docs.validmind.ai/guide/working-with-model-documentation.html) - -### Discover more learning resources - -We offer many interactive notebooks to help you document models: - -- [Run tests & test suites](https://docs.validmind.ai/guide/testing-overview.html) -- [Code samples](https://docs.validmind.ai/guide/samples-jupyter-notebooks.html) - -Or, visit our [documentation](https://docs.validmind.ai/) to learn more about ValidMind. \ No newline at end of file diff --git a/internal/templates/tachyons-flexbox.qmd b/internal/templates/tachyons-flexbox.qmd index 2ace192b91..6492faab26 100644 --- a/internal/templates/tachyons-flexbox.qmd +++ b/internal/templates/tachyons-flexbox.qmd @@ -12,15 +12,15 @@ filters: ::: {.w-50-ns} -The ValidMind platform is a suite of tools helping developers, data scientists and risk & compliance stakeholders identify potential risks in their AI and large language models, and generate robust, high-quality model documentation that meets regulatory requirements. +{{< var vm.product >}} is a suite of tools helping developers, data scientists and risk & compliance stakeholders identify potential risks in their AI and large language models, and generate robust, high-quality model documentation that meets regulatory requirements. -The platform is adept at handling many use cases, including models compatible with the Hugging Face Transformers API, and GPT 3.5, GPT 4, and hosted LLama2 and Falcon-based models (focused on text classification and text summarization use cases). +Adept at handling many use cases, including models compatible with the Hugging Face Transformers API, and GPT 3.5, GPT 4, and hosted LLama2 and Falcon-based models (focused on text classification and text summarization use cases), {{< var vm.product >}} is purpose-built for model risk management teams. ::: ::: {.w-40-ns} -![](/assets/img/validmind-demo-compact.png){width=85% fig-alt="An image showing the main ValidMind Platform UI main dashboard"} +![{{< var validmind.platform >}} main dashboard](/assets/img/validmind-demo-compact.png){width=85% fig-alt="An image showing the ValidMind Platform main dashboard"} ::: diff --git a/internal/templates/task.qmd b/internal/templates/task.qmd index a8c9c938dc..33a4d5c0ae 100644 --- a/internal/templates/task.qmd +++ b/internal/templates/task.qmd @@ -32,5 +32,6 @@ Include any common issues or errors that may arise during the task and how to re ## What's next -Summarize the task and provide any next steps or resources for the user to continue their learning or work. +- Summarize the task and provide any next steps or resources for the user to continue their learning or work. +- For a top-level (guide with sub-guides), use listing cards in this section. diff --git a/internal/templates/videos/_revealjs_navigation.qmd b/internal/templates/videos/_revealjs_navigation.qmd index b4175701e9..0578e7f795 100644 --- a/internal/templates/videos/_revealjs_navigation.qmd +++ b/internal/templates/videos/_revealjs_navigation.qmd @@ -1,5 +1,5 @@ :::: {.tc .mt5 .f3 .ba .bg-black-10 .b--black-10 .bw1 .br3 .near-black} -Training is **interactive** —you explore ValidMind live. Try it! +Training is **interactive** — you explore {{< var vm.product >}} live. Try it! ::: {.f4} **→** , **↓** , **SPACE** , **N** — next slide     **←** , **↑** , **P** , **H** — previous slide     **?** — all keyboard shortcuts diff --git a/internal/testing/css-grid/tachyons-grid.qmd b/internal/testing/css-grid/tachyons-grid.qmd index 9de4de79c6..144a39886e 100644 --- a/internal/testing/css-grid/tachyons-grid.qmd +++ b/internal/testing/css-grid/tachyons-grid.qmd @@ -18,15 +18,15 @@ From the [About](/about/overview.qmd) page. Still can't seem to get it to go ful ::: {.w-50-ns} -The ValidMind platform is a suite of tools helping developers, data scientists and risk & compliance stakeholders identify potential risks in their AI and large language models, and generate robust, high-quality model documentation that meets regulatory requirements. +{{< var vm.product >}} is a suite of tools helping developers, data scientists and risk & compliance stakeholders identify potential risks in their AI and large language models, and generate robust, high-quality model documentation that meets regulatory requirements. -The platform is adept at handling many use cases, including models compatible with the Hugging Face Transformers API, and GPT 3.5, GPT 4, and hosted LLama2 and Falcon-based models (focused on text classification and text summarization use cases). +Adept at handling many use cases, including models compatible with the Hugging Face Transformers API, and GPT 3.5, GPT 4, and hosted LLama2 and Falcon-based models (focused on text classification and text summarization use cases), {{< var vm.product >}} is purpose-built for model risk management teams. ::: ::: {.w-40-ns} -![](/assets/img/validmind-demo-compact.png){width=85% fig-alt="An image showing the main ValidMind Platform UI main dashboard"} +![{{< var validmind.platform >}} main dashboard](/assets/img/validmind-demo-compact.png){width=85% fig-alt="An image showing the ValidMind Platform main dashboard"} ::: diff --git a/internal/testing/lightbox.qmd b/internal/testing/lightbox.qmd new file mode 100644 index 0000000000..25873688e1 --- /dev/null +++ b/internal/testing/lightbox.qmd @@ -0,0 +1,31 @@ +--- +title: "Lightbox gallery" +lightbox: true +subtitle: "CSS styling" +search: false +filters: + - tachyons +--- + +:::: {.flex .flex-wrap .justify-around} + +::: {.w-30-ns} + +![Image 1 caption](/assets/img/platform-line-1.png){group="image-group"} + +::: + +::: {.w-30-ns} + +![Image 2 caption](/assets/img/platform-line-2.png){group="image-group"} + +::: + +::: {.w-30-ns} + +![Image 3 caption](/assets/img/platform-line-3.png){group="image-group"} + +::: + +:::: + diff --git a/internal/testing/variables/variables.qmd b/internal/testing/variables/variables.qmd index 4f3fd14ba8..719d57c023 100644 --- a/internal/testing/variables/variables.qmd +++ b/internal/testing/variables/variables.qmd @@ -1,24 +1,28 @@ --- -title: "New variables" +title: "Product variables" subtitle: "Rendered examples" search: false --- -| Old Variable | Old Render | New Variable | New Render | -|---|---|---|---| -|`validmind_platform` | ValidMind Platform UI | `validmind.platform` | {{< var validmind.platform >}} | -|`validmind_developer` | ValidMind Developer Framework | `validmind.developer` | {{< var validmind.developer >}} | -|`risk_platform` | ValidMind AI risk platform | `validmind.product` | {{< var validmind.product >}}| -|`platform` | platform UI | `vm.platform` | {{< var vm.platform >}} | -|`developer` | developer framework | `vm.developer` | {{< var vm.developer >}} | -| n/a | n/a | `vm.product` | {{< var vm.product >}} | -|`vm_contact` | [**Contact Us**](https://validmind.com/contact/) | `link.contact` | {{< var link.contact >}} | -| n/a | n/a | `link.login` | {{< var link.login >}} | -|`vm_url_us1` | https://app.prod.validmind.ai | `url.us1` | {{< var url.us1 >}} | -|`vm_url_ca1` | https://app.ca1.validmind.ai | `url.ca1` | {{< var url.ca1 >}} | -|`vm_privatelink` | https://private.prod.vm.validmind.ai | `aws.privatelink` | {{< var aws.privatelink >}} | -|`vm_private_service_connect_validmind` | https://private.us3-prod.validmind.ai | `gcp.connect` | {{< var gcp.connect >}} | -|`vm_private_service_connect_auth` | https://auth.private.validmind.ai | `gcp.authentication` | {{< var gcp.authentication >}} | -|`python_version` | ≧3.8 and <3.11 | `version.python` | {{< var version.python >}} | -|`validmind_version` | v2.0.7 | `version.validmind` | {{< var version.validmind >}} | -|`api_host` | https://API_HOST.validmind.ai/api/v1 | `api.host` | {{< var api.host >}} | +| Variable | Rendered | +|---|---| +| `validmind.platform` | {{< var validmind.platform >}} | +| `validmind.developer` | {{< var validmind.developer >}} | +| `validmind.product` | {{< var validmind.product >}}| +| `validmind.vpv` | {{< var validmind.vpv >}} | +| `validmind.api` | {{< var validmind.api >}} | +| `vm.platform` | {{< var vm.platform >}} | +| `vm.developer` | {{< var vm.developer >}} | +| `vm.product` | {{< var vm.product >}} | +| `vm.api` | {{< var vm.api >}} | +| `link.contact` | {{< var link.contact >}} | +| `link.login` | {{< var link.login >}} | +| `link.register` | {{< var link.register >}} | +| `url.us1` | {{< var url.us1 >}} | +| `url.ca1` | {{< var url.ca1 >}} | +| `aws.privatelink` | {{< var aws.privatelink >}} | +| `gcp.connect` | {{< var gcp.connect >}} | +| `gcp.authentication` | {{< var gcp.authentication >}} | +| `var version.python` | {{< var version.python >}} | +| `var version.validmind` | {{< var version.validmind >}} | +| `api.host` | {{< var api.host >}} | \ No newline at end of file diff --git a/site/_quarto.yml b/site/_quarto.yml index 5fda68ccc5..8c957a185b 100644 --- a/site/_quarto.yml +++ b/site/_quarto.yml @@ -36,10 +36,10 @@ website: file: get-started/get-started.qmd - text: "Guides" file: guide/guides.qmd - - text: "{{< fa cube >}} Developer Framework" + - text: "{{< fa cube >}} Developers" menu: - text: "{{< fa rocket >}} Get Started" - file: developer/get-started-developer-framework.qmd + file: developer/get-started-validmind-library.qmd - text: "{{< fa cubes >}} Supported Models" file: developer/model-documentation/supported-models.qmd - text: "{{< fa book-medical >}} Documenting Models" @@ -105,14 +105,14 @@ website: - about/deployment/virtual-private-validmind.qmd - about/glossary/glossary.qmd - text: "---" - - text: "CONTRIBUTING" + - text: "Contributing" - about/contributing/validmind-community.qmd - file: about/contributing/style-guide/style-guide.qmd contents: - about/contributing/style-guide/voice-and-tone.qmd - about/contributing/style-guide/conventions.qmd - text: "---" - - text: "RELEASES" + - text: "Releases" # MAKE-RELEASE-NOTES-EMBED-MARKER - releases/2024-oct-22/release-notes.qmd - releases/2024-sep-25/release-notes.qmd @@ -142,7 +142,7 @@ website: - releases/2023/release-notes-2023-jun-22.qmd - releases/2023/release-notes-2023-may-30.qmd - text: "---" - - text: "FINE PRINT" + - text: "Fine Print" - about/fine-print/data-privacy-policy.qmd - text: "Software license agreement" file: about/fine-print/license-agreement.qmd @@ -155,12 +155,12 @@ website: - text: "QuickStart — 15 Minutes" file: get-started/quickstart.qmd - text: "---" - - text: "DEVELOPER FRAMEWORK" + - text: "{{< var validmind.developer >}}" - get-started/developer/try-with-jupyterhub.qmd - get-started/developer/try-with-colab.qmd - get-started/developer/try-in-your-own-environment.qmd - text: "---" - - text: "PLATFORM UI" + - text: "{{< var validmind.platform >}}" - get-started/platform/explore-sample-model-documentation.qmd - get-started/platform/register-your-first-model.qmd - get-started/platform/generate-documentation-for-your-model.qmd @@ -172,7 +172,7 @@ website: contents: - guide/guides.qmd - text: "---" - - text: "CONFIGURATION" + - text: "Configuration" - file: guide/configuration/accessing-validmind.qmd contents: - guide/configuration/register-with-validmind.qmd @@ -194,7 +194,7 @@ website: - guide/configuration/manage-your-profile.qmd - guide/configuration/customize-your-dashboard.qmd - text: "---" - - text: "MODEL WORKFLOWS" + - text: "Model Workflows" - text: "Working with workflows" file: guide/model-workflows/working-with-model-workflows.qmd contents: @@ -203,7 +203,7 @@ website: - text: "Set up workflows" file: guide/model-workflows/set-up-model-workflows.qmd - text: "---" - - text: "MODEL INVENTORY" + - text: "Model Inventory" - file: guide/model-inventory/working-with-model-inventory.qmd contents: - guide/model-inventory/register-models-in-inventory.qmd @@ -216,7 +216,7 @@ website: - guide/model-inventory/archive-delete-models.qmd - guide/model-inventory/view-model-activity.qmd - text: "---" - - text: "MODEL DOCUMENTATION" + - text: "Model Documentation" - file: guide/model-documentation/working-with-documentation-templates.qmd contents: - guide/model-documentation/view-documentation-templates.qmd @@ -233,7 +233,7 @@ website: - guide/model-documentation/submit-for-approval.qmd - guide/model-documentation/export-documentation.qmd - text: "---" - - text: "MODEL VALIDATION" + - text: "Model Validation" # - guide/customize-validation-report-templates.qmd - guide/model-validation/manage-validation-guidelines.qmd - file: guide/model-validation/preparing-validation-reports.qmd @@ -252,7 +252,7 @@ website: - guide/model-validation/view-reports.qmd - guide/model-documentation/export-documentation.qmd - text: "---" - - text: "MONITORING" + - text: "Monitoring" - file: guide/monitoring/ongoing-monitoring.qmd contents: - guide/monitoring/enable-monitoring.qmd @@ -260,12 +260,12 @@ website: - text: "Metrics over time" file: guide/monitoring/work-with-metrics-over-time.qmd - - title: "Developer Framework" + - title: "{{< var validmind.developer >}}" contents: - - text: "Developer Framework" - file: developer/get-started-developer-framework.qmd + - text: "{{< var validmind.developer >}}" + file: developer/get-started-validmind-library.qmd - text: "---" - - text: "MODEL DOCUMENTATION" + - text: "Model Documentation" - notebooks/quickstart_customer_churn_full_suite.ipynb - text: "Introduction for model developers" file: notebooks/tutorials/intro_for_model_developers.ipynb @@ -273,12 +273,12 @@ website: - file: developer/model-documentation/documenting-models.qmd contents: - developer/model-documentation/document-models.qmd - - text: "Install and initialize client library" - file: developer/model-documentation/install-and-initialize-client-library.qmd + - text: "Install and initialize {{< var validmind.developer >}}" + file: developer/model-documentation/install-and-initialize-validmind-library.qmd - developer/model-documentation/work-with-test-results.qmd - developer/model-documentation/store-credentials-in-env-file.qmd - text: "---" - - text: "MODEL TESTING" + - text: "Model Testing" - text: "Run tests & test suites" file: developer/model-testing/testing-overview.qmd contents: "notebooks/how_to/**" @@ -287,12 +287,12 @@ website: contents: tests/** - developer/model-testing/test-sandbox.qmd - text: "---" - - text: "NOTEBOOKS" + - text: "Notebooks" - text: "Code samples" file: developer/samples-jupyter-notebooks.qmd contents: "notebooks/code_samples/**" - text: "---" - - text: "REFERENCE" + - text: "Reference" - text: "{{< var validmind.developer >}} {{< fa external-link >}}" file: validmind/validmind.html target: _blank @@ -316,39 +316,20 @@ website: - text: "---" - support/troubleshooting.qmd -# TRAINING SIDEBAR - # - title: "[](/index.qmd)" - # contents: - # - text: "Training" - # file: training/training.qmd - # - text: "---" - # - text: "FUNDAMENTALS" - # - text: "For Administrators" - # file: training/administrator-fundamentals/administrator-fundamentals-register.qmd - # - text: "For Developers" - # file: training/developer-fundamentals/developer-fundamentals-register.qmd - # - text: "For Validators" - # file: training/validator-fundamentals/validator-fundamentals-register.qmd -# - text: "For model risk governance" -# file: training/training-for-model-risk-governance.qmd - # COMMENT THIS OUT WHEN DONE TESTING # - title: "Testing" # contents: # - internal/testing.qmd # - text: "---" # - text: "EXPERIMENTS" - # - file: internal/buttons.qmd + # - file: internal/lightbox.qmd # - file: internal/footnotes/footnotes.qmd - # contents: - # - internal/footnotes/hover-only.qmd - # - internal/footnotes/margin-only.qmd - # - internal/footnotes/margin-hover.qmd - # - internal/footnotes/text-notes.qmd + # contents: + # - internal/footnotes/hover-only.qmd page-footer: background: "#DE257E" - left: "© Copyright 2023-2024 ValidMind Inc. All Rights Reserved." + left: "© Copyright 2023-2024 {{< var validmind.legal >}} All Rights Reserved." right: - text: "validmind.com {{< fa external-link >}}" href: https://validmind.com/ diff --git a/site/_variables.yml b/site/_variables.yml index b654974fa3..135edfe56b 100644 --- a/site/_variables.yml +++ b/site/_variables.yml @@ -14,18 +14,21 @@ # Long form # Rendered format: `{{< var validmind.platform >}}` validmind: - platform: "ValidMind Platform UI" - developer: "ValidMind Developer Framework" + platform: "ValidMind Platform" + developer: "ValidMind Library" product: "ValidMind AI risk platform" vpv: "Virtual Private ValidMind" + api: "Python Library API" + legal: "ValidMind Inc." + training: "ValidMind Academy" # Short form # Rendered format: `{{< var vm.platform >}}` vm: - platform: "platform UI" - developer: "developer framework" + platform: "platform" + developer: "library" product: "ValidMind" - + api: "Python API" # PRODUCT URLS # Links to ValidMind hosted web applications diff --git a/site/about/contributing/style-guide/conventions.qmd b/site/about/contributing/style-guide/conventions.qmd index 6c4ae50ffe..cf6abadac7 100644 --- a/site/about/contributing/style-guide/conventions.qmd +++ b/site/about/contributing/style-guide/conventions.qmd @@ -16,7 +16,7 @@ Conveying knowledge and empowering users starts in the product interface. While - **Show only what’s necessary when necessary.** Progressive disclosure[^1] can help guide workflows as well as minimize visual clutter. ## American English -While the ValidMind community spans far and wide, its heart finds its home in Palo Alto, California. When writing for ValidMind, keep things consistent by using American English[^2] spelling and grammar conventions. +While the {{< var vm.product >}} community spans far and wide, its heart finds its home in Palo Alto, California. When writing for {{< var vm.product >}}, keep things consistent by using American English[^2] spelling and grammar conventions. | Correct | Incorrect | |------|-----| @@ -45,9 +45,9 @@ In general, follow sentence-style capitalization[^3] to minimize the confusion o | Correct | Incorrect | |------|-----| -| Get started with ValidMind | Get Started with ValidMind | +| Get started with {{< var vm.product >}} | Get Started with {{< var vm.product >}} | | In the left sidebar, click **Model Inventory**. | In the left sidebar, click **model inventory**. | -| [Honor the Human with ValidMind](https://validmind.com/honor-the-human-with-validmind/) | [Honor the human with ValidMind](https://validmind.com/honor-the-human-with-validmind/) | +| [Honor the Human with {{< var vm.product >}}](https://validmind.com/honor-the-human-with-validmind/) | [Honor the human with {{< var vm.product >}}](https://validmind.com/honor-the-human-with-validmind/) | | `On the landing page of your model, locate the [model status]{.smallcaps} section:` | `On the landing page of your model, locate the MODEL STATUS section:` | : **Sentence case** examples {.hover} @@ -58,7 +58,7 @@ In general, follow sentence-style capitalization[^3] to minimize the confusion o | Correct | Incorrect | |------|-----| -| Login to ValidMind | 1. Logging into ValidMind. | +| Login to {{< var vm.product >}} | 1. Logging into {{< var vm.product >}}. | : **Heading** examples {.hover} ### Responsive columns @@ -237,10 +237,10 @@ Use emphatic styling sparingly, in order not to overwhelm the reader with visual | Correct | Incorrect | |------|-----| -| At ValidMind, we value **transparency and accessibility** — we aim to speak simply and effectively. (e.g. Highlighting the important concept within a sentence.) | **At ValidMind, we value transparency and accessibility — we aim to speak simply and effectively.** (e.g. Highlighting the entire sentence.) | +| At {{< var vm.product >}}, we value **transparency and accessibility** — we aim to speak simply and effectively. (e.g. Highlighting the important concept within a sentence.) | **At {{< var vm.product >}}, we value transparency and accessibility — we aim to speak simply and effectively.** (e.g. Highlighting the entire sentence.) | | In the {{< var validmind.platform >}}, click **Model Inventory** on the left sidebar. | In the {{< var validmind.platform >}}, click "Model Inventory" on the left sidebar. | | *Uncertainty* can be summed up as the difference between reality and the outputs from the model selected to approximate reality. | “Uncertainty” can be summed up as the difference between reality and the outputs from the model selected to approximate reality. | -| “ValidMind is the only platform today that is purpose-built for model risk management professionals in the banking industry,” Jacobi says. | At ValidMind, we value "transparency and accessibility" — we aim to speak simply and effectively. | +| “{{< var vm.product >}} is the only platform today that is purpose-built for model risk management professionals in the banking industry,” Jacobi says. | At {{< var vm.product >}}, we value "transparency and accessibility" — we aim to speak simply and effectively. | : **Emphasis** examples {.hover} #### Callouts @@ -314,8 +314,8 @@ lightbox: true | Correct | Incorrect | |------|-----| -| ![Verification email sent by ValidMind](/guide/configuration/verify-email.png){width=70% fig-alt="Screenshot of the verification email sent by ValidMind" .screenshot .lightbox} | ![](screenshot-incorrect.png){width=90%} | -| `![Verification email sent by ValidMind](/guide/configuration/verify-email.png){width=80% fig-alt="Screenshot of the verification email sent by ValidMind" .screenshot .lightbox}` | `![](/guide/configuration/verify-email.png){width=80%}` | +| ![Verification email sent by {{< var vm.product >}}](/guide/configuration/verify-email.png){width=70% fig-alt="Screenshot of the verification email sent by ValidMind" .screenshot .lightbox} | ![](screenshot-incorrect.png){width=90%} | +| `![Verification email sent by {{< var vm.product >}}](/guide/configuration/verify-email.png){width=70% fig-alt="Screenshot of the verification email sent by ValidMind" .screenshot .lightbox}` | `![](/guide/configuration/verify-email.png){width=80%}` | : **Screenshot** examples {.hover} #### Videos @@ -390,13 +390,17 @@ Within our documentation (`https://docs.validmind.ai/`), you are able to referen | Product Name | Variable Key | Description | |---:|---|---| -| {{< var validmind.product >}} | `{{{< var validmind.product >}}}` | Risk platform with a {{< var vm.developer >}} for documenting and testing models, alongside a {{< var vm.platform >}} hosting cloud-based tools, APIs, databases, and validation engines. | -| {{< var validmind.developer >}} | `{{{< var validmind.developer >}}}` | Open-source suite of of tools that connects to the {{< var vm.platform >}}. | +| {{< var validmind.product >}} | `{{{< var validmind.product >}}}` | Comphrensive suite of tools with a {{< var vm.developer >}} for documenting and testing models, alongside a {{< var vm.platform >}} hosting cloud-based tools, APIs, databases, and validation engines. | +| {{< var validmind.developer >}} | `{{{< var validmind.developer >}}}` | Open-source library that connects to the {{< var validmind.platform >}}. | | {{< var validmind.platform >}} | `{{{< var validmind.platform >}}}` | Hosted multi-tenant architecture that includes a cloud-based web interface. | +| {{< var validmind.api >}} | `{{{< var validmind.api >}}}` | Used to make calls to the {{< var validmind.developer >}}.[^19] | +| {{< var vm.product >}} | `{{{< var vm.product >}}}` | Short form of {{< var validmind.product >}}. | | {{< var vm.developer >}} | `{{{< var vm.developer >}}}` | Short form of {{< var validmind.developer >}}. | | {{< var vm.platform >}} | `{{{< var vm.platform >}}}` | Short form of {{< var validmind.platform >}}. | -| {{< var url.us1 >}} | `{{{< var url.us1 >}}}` | One of the URLs of the {{< var validmind.platform >}}. | -: ValidMind product **variable keys** {.hover tbl-colwidths="[15,45,40]"} +| {{< var vm.api >}} | `{{{< var validmind.api >}}}` | Short form of {{< var validmind.api >}}. | +| {{< var url.us1 >}} | `{{{< var url.us1 >}}}` | US-hosted {{< var validmind.platform >}} URL. | +| {{< var url.ca1 >}} | `{{{< var url.ca1 >}}}` | CA-hosted {{< var validmind.platform >}} URL. | +: {{< var vm.product >}} product **variable keys** {.hover tbl-colwidths="[15,45,40]"} ::: {.callout} Refer also to [the glossary](/about/glossary/glossary.qmd) for extended information on product names. @@ -404,7 +408,7 @@ Refer also to [the glossary](/about/glossary/glossary.qmd) for extended informat ## Training materials -The ValidMind Academy[^20] is delivered in Revealjs presentation format,[^21] with a slightly different set of conventions: +The {{< var validmind.training >}}[^20] is delivered in Revealjs presentation format,[^21] with a slightly different set of conventions: - Training courses consist of: @@ -413,9 +417,8 @@ The ValidMind Academy[^20] is delivered in Revealjs presentation format,[^21] wi - Training materials use several supplementary style sheets to apply an alternate site theme: - a. **ValidMind Academy hub:** `training.css`[^24] - b. **Course registration pages:** `training.css`, `training-nav.css`[^25] - c. **Course slides:** `slides.scss`[^26] + a. **{{< var validmind.training >}} pages:** `training.css`[^24] + b. **Course slides:** `slides.scss`[^25] - Each course lives in its own subdirectory within our training, where the name of the directory reflects the name of the course. @@ -427,7 +430,7 @@ The ValidMind Academy[^20] is delivered in Revealjs presentation format,[^21] wi #### Course registration - Course registration pages outline what the course covers and how to sign up for the course. -- Registration pages make use of our custom `.preview` extension[^27] to display the tile card for the course. These previews act like links but they provide a live preview of the page linked to. +- Registration pages make use of our custom `.preview` extension[^26] to display the tile card for the course. These previews act like links but they provide a live preview of the page linked to. First enable course previews in the front matter: @@ -472,7 +475,7 @@ Optional #### Course slides -- Training slides make use of Tachyons CSS[^28] styled with our custom `.overlay` class to provide demonstration overlays. +- Training slides make use of Tachyons CSS[^27] styled with our custom `.overlay` class to provide demonstration overlays. Enable Tachyons CSS in the front matter with: @@ -511,7 +514,7 @@ Try it **live** on the next page. {{< fa hand-point-right >}} :::: -- Training slides use inline links only instead of footnotes,[^29] as footnotes are not visible in presentation mode. +- Training slides use inline links only instead of footnotes,[^28] as footnotes are not visible in presentation mode. ## What's next - [Voice and tone](voice-and-tone.qmd) @@ -553,11 +556,11 @@ Try it **live** on the next page. {{< fa hand-point-right >}} [^17]: [Mermaid charts](https://mermaid.js.org/) -[^18]: **ValidMind GitHub:** [`_variables.yml`](https://github.com/validmind/documentation/blob/main/site/_variables.yml) +[^18]: **{{< var vm.product >}} GitHub:** [`_variables.yml`](https://github.com/validmind/documentation/blob/main/site/_variables.yml) [^19]: [Code samples](/developer/samples-jupyter-notebooks.qmd) -[^20]: [ValidMind Academy](/training/training.qmd) +[^20]: [{{< var validmind.training >}}](/training/training.qmd) [^21]: **Quarto:** [Revealjs](https://quarto.org/docs/presentations/revealjs/) @@ -565,14 +568,12 @@ Try it **live** on the next page. {{< fa hand-point-right >}} [^23]: [Course slides](#course-slides) -[^24]: **ValidMind GitHub:** [training.css](https://github.com/validmind/documentation/blob/main/site/training/assets/training.css) +[^24]: **{{< var vm.product >}} GitHub:** [training.css](https://github.com/validmind/documentation/blob/main/site/training/assets/training.css) -[^25]: **ValidMind GitHub:** [training-nav.css](https://github.com/validmind/documentation/blob/main/site/training/assets/training-nav.css) +[^25]: **{{< var vm.product >}} GitHub:** [slides.scss](https://github.com/validmind/documentation/blob/main/site/training/assets/slides.scss) -[^26]: **ValidMind GitHub:** [slides.scss](https://github.com/validmind/documentation/blob/main/site/training/assets/slides.scss) +[^26]: **{{< var vm.product >}} GitHub:** [preview](https://github.com/validmind/documentation/tree/main/site/_extensions/nrichers/preview) extension -[^27]: **ValidMind GitHub:** [preview](https://github.com/validmind/documentation/tree/main/site/_extensions/nrichers/preview) extension +[^27]: **GitHub:** [Tachyons Extension For Quarto](https://github.com/nareal/tachyons) -[^28]: **GitHub:** [Tachyons Extension For Quarto](https://github.com/nareal/tachyons) - -[^29]: [Inline links](#inline-links) \ No newline at end of file +[^28]: [Inline links](#inline-links) \ No newline at end of file diff --git a/site/about/contributing/style-guide/style-guide.qmd b/site/about/contributing/style-guide/style-guide.qmd index 17c0af72bb..68137964bf 100644 --- a/site/about/contributing/style-guide/style-guide.qmd +++ b/site/about/contributing/style-guide/style-guide.qmd @@ -1,4 +1,5 @@ --- +# USING THE VARIABLE IN THE TITLE MESSES UP THE BREADCRUMB title: "ValidMind style guide" date: last-modified listing: @@ -18,9 +19,9 @@ aliases: A style guide helps create distinct yet unified communication across all areas of a product experience, from in-app interactions to technical documentation and blog posts. ## Goals -At ValidMind, we value **transparency and accessibility** — we aim to speak simply and effectively. We also believe in **creating community**, by presenting information in a manner that encourages collaboration and feedback from users old and new. +At {{< var vm.product >}}, we value **transparency and accessibility** — we aim to speak simply and effectively. We also believe in **creating community**, by presenting information in a manner that encourages collaboration and feedback from users old and new. -Our processes reflect a **holistic journey** — accommodating the needs of users begins in the design phase, documentation supplements instead of replaces intuitive or engaging and guided user experiences, and publications should help our audience understand value and maximize their potential with ValidMind. +Our processes reflect a **holistic journey** — accommodating the needs of users begins in the design phase, documentation supplements instead of replaces intuitive or engaging and guided user experiences, and publications should help our audience understand value and maximize their potential with {{< var vm.product >}}. The following guidelines are meant to reflect these above principles, and ensure that all of our communications adhere to our vision: @@ -31,7 +32,7 @@ The following guidelines are meant to reflect these above principles, and ensure Google offers [Technical Writing Courses for Engineers](https://developers.google.com/tech-writing) for free. Go forth and write! ### Additional style guides -This style guide is meant to help get you familiar with speaking in the ValidMind voice, but not be an exhaustive list of conventions or rules you should be following when writing. +This style guide is meant to help get you familiar with speaking in the {{< var vm.product >}} voice, but not be an exhaustive list of conventions or rules you should be following when writing. If it’s specified in our guide, follow those instructions — otherwise, you can check out the guides below for more inspiration: diff --git a/site/about/contributing/style-guide/voice-and-tone.qmd b/site/about/contributing/style-guide/voice-and-tone.qmd index 9381e07916..3685cad91b 100644 --- a/site/about/contributing/style-guide/voice-and-tone.qmd +++ b/site/about/contributing/style-guide/voice-and-tone.qmd @@ -3,7 +3,7 @@ title: "Voice and tone" date: last-modified --- -While we work closely with technology, the ValidMind voice prefers a **human-first approach**. +While we work closely with technology, the {{< var vm.product >}} voice prefers a **human-first approach**. When we adapt our tone to fit the audience and context, we always aim to build a relationship and foster understanding with the person we’re trying to reach. @@ -33,7 +33,7 @@ The quickest way to accomplish clarity is through use of the active voice. Activ - Try incorporating different mediums (such as visual aids like images, charts, etc.) to help fortify understanding, and to provide the reader respite from walls of text. ## Everybody's welcome -Engage with your audience in a friendly, open, and encouraging manner. Every reader is here to learn, and at ValidMind we believe that experts are always enthusiastic to share their knowledge. +Engage with your audience in a friendly, open, and encouraging manner. Every reader is here to learn, and at {{< var vm.product >}} we believe that experts are always enthusiastic to share their knowledge. ### Appeal to humans Behind every page, there’s a person. In every word, lies an opportunity to win your audience over. @@ -97,7 +97,7 @@ Keep your audience involved in the process. Engage the reader with questions, an | Correct | Incorrect | |------|-----| -| What if you were able to more easily, more effortlessly discern uncertainty, unleashing the full potential of your model outputs? That’s the power of ValidMind. | ValidMind easily and effortlessly discerns uncertainty, unleashing the full potential of model outputs. | +| What if you were able to more easily, more effortlessly discern uncertainty, unleashing the full potential of your model outputs? That’s the power of {{< var vm.product >}}. | {{< var vm.product >}} easily and effortlessly discerns uncertainty, unleashing the full potential of model outputs. | : **Audience engagement** examples {.hover} ## What's next diff --git a/site/about/contributing/validmind-community.qmd b/site/about/contributing/validmind-community.qmd index 2b402216ac..151e778b82 100644 --- a/site/about/contributing/validmind-community.qmd +++ b/site/about/contributing/validmind-community.qmd @@ -1,34 +1,35 @@ --- -title: "ValidMind community" +title: "{{< var vm.product >}} community" date: last-modified aliases: - ../validmind-commmunity.html --- -Work with financial models, in model risk management (MRM), or are simply enthusiastic about artificial intelligence (AI) and machine learning and how these tools are actively shaping our futures within the finance industry and beyond? Congratulations — you're already part of the ValidMind community! Come learn and play with us. +Work with financial models, in model risk management (MRM), or are simply enthusiastic about artificial intelligence (AI) and machine learning and how these tools are actively shaping our futures within the finance industry and beyond? Congratulations — you're already part of the {{< var vm.product >}} community! Come learn and play with us. -## Interact with ValidMind +## Interact with {{< var vm.product >}} - **[Join our Slack community](join-community.qmd){target="_blank"}** — Be part of building a space for AI risk practitioners and those looking to break into the industry. Get technical support, share ideas, chat about model risk, AI, large language models, and much more! -- **[Sign up for our newsletter](https://validmind.com/community/)** — Receive exciting updates from ValidMind and curated material surrounding AI risk management. -- Keep up with the latest news in AI and MRM, as well as announcements and original content from ValidMind **[on our blog](https://validmind.com/blog/)**. -- Want to connect with other inquiring minds? **[Find out what events ValidMind is hosting and attending](https://validmind.com/events/)** — we'd be delighted to see you! +- **[Sign up for our newsletter](https://validmind.com/community/)** — Receive exciting updates from {{< var vm.product >}} and curated material surrounding AI risk management. +- Keep up with the latest news in AI and MRM, as well as announcements and original content from {{< var vm.product >}} **[on our blog](https://validmind.com/blog/)**. +- Want to connect with other inquiring minds? **[Find out what events {{< var vm.product >}} is hosting and attending](https://validmind.com/events/)** — we'd be delighted to see you! -## Build with ValidMind +## Build with {{< var vm.product >}} -::: {.callout title="ValidMind style guide"} -The first step towards producing material for ValidMind is to familarize yourself with our [style guide](style-guide/style-guide.qmd). +::: {.callout} +## {{< var vm.product >}} style guide +The first step towards producing material for {{< var vm.product >}} is to familarize yourself with our [style guide](style-guide/style-guide.qmd). Learn about our company vision, get to know our brand's voice and preferred formatting conventions, and find additional resources to strengthen your writing skills. ::: -Here at ValidMind, we embrace an [open source](https://en.wikipedia.org/wiki/Open_source) ideology. This means that we think expertise is inclusive, and is also open to evolving — there's always an opportunity to learn from each other, and help each other improve. +Here at {{< var vm.product >}}, we embrace an [open source](https://en.wikipedia.org/wiki/Open_source) ideology. This means that we think expertise is inclusive, and is also open to evolving — there's always an opportunity to learn from each other, and help each other improve. -As a member of the ValidMind community, we invite you to be part of our process. From our public documentation to the code behind our [{{< var vm.developer >}}](/developer/get-started-developer-framework.qmd), we've exposed the wiring for inspection in hopes that great minds think differently and dare to spark change. +As a member of the {{< var vm.product >}} community, we invite you to be part of our process. From our public documentation to the code behind our [{{< var vm.developer >}}](/developer/get-started-validmind-library.qmd), we've exposed the wiring for inspection in hopes that great minds think differently and dare to spark change. ### Contribution ideas -Please note that all community contributions are subject to review by the ValidMind team. See our [software license agreement](/about/fine-print/license-agreement.qmd) for more details. +Please note that all community contributions are subject to review by the {{< var vm.product >}} team. See our [software license agreement](/about/fine-print/license-agreement.qmd) for more details. -- **[Code samples](/developer/samples-jupyter-notebooks.qmd)** — Have a Jupyter Notebook that works perfectly with ValidMind, or covers a sample use case not already provided? Send it to us! +- **[Code samples](/developer/samples-jupyter-notebooks.qmd)** — Have a Jupyter Notebook that works perfectly with {{< var vm.product >}}, or covers a sample use case not already provided? Send it to us! - **[{{< var validmind.developer >}}](https://github.com/validmind/developer-framework/)** — Live by the {{< var vm.developer >}}, and have an idea that will streamline the experience for others? Let us know! - **[Product documentation](https://github.com/validmind/documentation)** — Spot a typo, or have identified a gap in instruction you think would be beneficial for the community to fill? Submit an edit! diff --git a/site/about/deployment/deployment-options.qmd b/site/about/deployment/deployment-options.qmd index 0d2cfbd148..f79d7f727a 100644 --- a/site/about/deployment/deployment-options.qmd +++ b/site/about/deployment/deployment-options.qmd @@ -28,14 +28,13 @@ We offer two deployment models: ## Architecture overview - -![{{< var vm.product >}} architecture overview](validmind-architecture-overview.png){fig-alt="An image showing the ValidMind platform architecture"} +![{{< var vm.product >}} architecture overview](validmind-architecture-overview.png){fig-alt="An image showing the ValidMind architecture"} In your own environment, model developers can continue to run models using your existing tools for data science and model development, such as Python, Jupyter Notebooks, and R, accessing data from sources such as Google Cloud Storage, Amazon S3, and Snowflake. -These models are then integrated with the {{< var validmind.developer >}}, which communicates with {{< var vm.product >}} via our API. +These models are then integrated with the {{< var validmind.developer >}}, which communicates with the {{< var validmind.platform >}} via our {{< var validmind.api >}}. -The ValidMind Platform provides: +The {{< var validmind.platform >}} provides: - **Model inventory** — Centralized tracking and organization of models, accessible by developers, validators, and executives. @@ -43,7 +42,7 @@ The ValidMind Platform provides: - **Template management** — Allows for easy creation, customization, and reuse of documentation templates. -- **ValidMind dashboard** — A user-friendly interface providing insights, status updates, and governance reporting for model risk. +- **{{< var vm.product >}} dashboard** — A user-friendly interface providing insights, status updates, and governance reporting for model risk. ## Security & data privacy diff --git a/site/about/deployment/multi-tenant-cloud.qmd b/site/about/deployment/multi-tenant-cloud.qmd index 581e34a1e0..b0aa1210fb 100644 --- a/site/about/deployment/multi-tenant-cloud.qmd +++ b/site/about/deployment/multi-tenant-cloud.qmd @@ -12,7 +12,7 @@ listing: - path: https://validmind.com/contact/ image: /assets/img/hero-platform.png title: "Request a demo" - description: "Find out which ValidMind deployment is right for you by getting in touch." + description: "Find out which {{< var vm.product >}} deployment is right for you by getting in touch." author: validmind.com --- @@ -31,7 +31,7 @@ Optional private link connections offer secure integration with on-premise netwo - **Cost-efficiency** — Shared infrastructure reduces the overall cost of ownership. - **Scalability** — Resources scale dynamically based on demand. - **Streamlined updates** — Centralized software updates provide simultaneous benefits to all tenants. -- **Security** — ValidMind ensures security with data isolation, encryption, and role-based access control. +- **Security** — {{< var vm.product >}} ensures security with data isolation, encryption, and role-based access control. ## Security @@ -48,8 +48,3 @@ Optional private link connections offer secure integration with on-premise netwo :::{#request-demo} ::: - - diff --git a/site/about/deployment/virtual-private-validmind.qmd b/site/about/deployment/virtual-private-validmind.qmd index 7bb25b1454..617f16bbcb 100644 --- a/site/about/deployment/virtual-private-validmind.qmd +++ b/site/about/deployment/virtual-private-validmind.qmd @@ -1,5 +1,6 @@ --- -title: "{{< var validmind.vpv >}} (VPV)" +# USING THE VARIABLE IN THE TITLE MESSES UP THE BREADCRUMB +title: "Virtual Private ValidMind (VPV)" date: last-modified filters: - tachyons @@ -12,7 +13,7 @@ listing: - path: https://validmind.com/contact/ image: /assets/img/hero-platform.png title: "Request a demo" - description: "Find out which ValidMind deployment is right for you by getting in touch." + description: "Find out which {{< var vm.product >}} deployment is right for you by getting in touch." author: validmind.com --- @@ -40,8 +41,3 @@ This option is ideal for high-compliance industries and also supports private li :::{#request-demo} ::: - - diff --git a/site/about/fine-print/data-privacy-policy.qmd b/site/about/fine-print/data-privacy-policy.qmd index d2054c2fdc..14db974d68 100644 --- a/site/about/fine-print/data-privacy-policy.qmd +++ b/site/about/fine-print/data-privacy-policy.qmd @@ -1,55 +1,56 @@ --- title: "Data privacy policy" -keywords: "data privacy, ai risk, model risk management, ValidMind" +keywords: "data privacy, ai risk, model risk management, {{< var vm.product >}}" date: last-modified aliases: - ../data-privacy-policy.html - ../guide/data-privacy-policy.html --- -This page outlines ValidMind's data privacy policy, explaining how we protect your personal information. Our goal is to provide transparency about our data handling practices and to demonstrate our commitment to protecting your privacy and data security. +This page outlines {{< var vm.product >}}'s data privacy policy, explaining how we protect your personal information. Our goal is to provide transparency about our data handling practices and to demonstrate our commitment to protecting your privacy and data security. -## What is ValidMind's data privacy policy? +## What is {{< var vm.product >}}'s data privacy policy? The key points of our data privacy policy include: - **No personal identifiable information in documentation** — When the {{< var validmind.developer >}} generates documentation, it ensures that no personally identifiable information (PII) is included. This practice is a critical part of our commitment to protecting your privacy and maintaining the confidentiality of your data. -- **No storage of customer data** — ValidMind does not retain any customer datasets or models. This policy is in place in order to protect your data privacy and security. By not storing this information, ValidMind minimizes the risk of unauthorized access or data breaches. +- **No storage of customer data** — {{< var vm.product >}} does not retain any customer datasets or models. This policy is in place in order to protect your data privacy and security. By not storing this information, {{< var vm.product >}} minimizes the risk of unauthorized access or data breaches. -We believe it is important for users of ValidMind's products to understand these practices as they reflect our dedication to data security and privacy. +We believe it is important for users of {{< var vm.product >}}'s products to understand these practices as they reflect our dedication to data security and privacy. -::: {.callout-important title="ValidMind does NOT:"} +::: {.callout-important} +## {{< var vm.product >}} does NOT: - Include any personal identifiable information (PII) when generating documentation reports. - Store any customer datasets or models. ::: ## Do you comply with the SOC 2 security standard? -Service Organization Control 2 (SOC 2) is a type of audit report that evaluates the security and privacy controls of a service organization, such as a cloud vendor like ValidMind. The report provides assurance to customers that an organization has implemented effective security and privacy controls to protect sensitive data. +Service Organization Control 2 (SOC 2) is a type of audit report that evaluates the security and privacy controls of a service organization, such as a cloud vendor like {{< var vm.product >}}. The report provides assurance to customers that an organization has implemented effective security and privacy controls to protect sensitive data. -ValidMind's security and privacy controls are designed to align with the stringent requirements of the SOC 2 standard. This compliance means that ValidMind has established and consistently maintains a set of security measures and protocols that meet or exceed the benchmark set by SOC 2. We also regularly review and update these controls to ensure that they stay current with evolving security threats and regulatory requirements. +{{< var vm.product >}}'s security and privacy controls are designed to align with the stringent requirements of the SOC 2 standard. This compliance means that {{< var vm.product >}} has established and consistently maintains a set of security measures and protocols that meet or exceed the benchmark set by SOC 2. We also regularly review and update these controls to ensure that they stay current with evolving security threats and regulatory requirements. ## Do you offer additional data privacy options? -ValidMind's platform is a secure, multi-tenant solution that can be hosted on Amazon Web Services (AWS), Microsoft Azure Cloud (Azure), or Google Cloud Platform (GCP). For organizations that require a stricter trust model and the highest level of security, such as financial services organizations handling highly sensitive data, ValidMind also offers a _{{< var validmind.vpv >}} (VPV)_ option to host our solution in a dedicated single-tenant cloud instance. +The {{< var validmind.platform >}} is a secure, multi-tenant solution that can be hosted on Amazon Web Services (AWS), Microsoft Azure Cloud (Azure), or Google Cloud Platform (GCP). For organizations that require a stricter trust model and the highest level of security, such as financial services organizations handling highly sensitive data, {{< var vm.product >}} also offers a _{{< var validmind.vpv >}} (VPV)_ option to host our solution in a dedicated single-tenant cloud instance. -The {{< var validmind.vpv >}} option provides all the features and services of other editions of our products, but hosted within a separate environment that is isolated from other ValidMind accounts. VPV accounts do not share resources with non-VPV accounts. +The {{< var validmind.vpv >}} option provides all the features and services of other editions of our products, but hosted within a separate environment that is isolated from other {{< var vm.product >}} accounts. VPV accounts do not share resources with non-VPV accounts. -Access to any edition is available through AWS PrivateLink, Azure Private Link, or GCP Private Service Connect, all of which provide private connectivity between ValidMind and your on-premises network without exposing your traffic to the public internet. +Access to any edition is available through AWS PrivateLink, Azure Private Link, or GCP Private Service Connect, all of which provide private connectivity between {{< var vm.product >}} and your on-premises network without exposing your traffic to the public internet. ## What model artifacts are imported into documentation? -When you generate documentation or run tests, ValidMind imports the following artifacts into the documentation via our API endpoint integration: +When you generate documentation or run tests, {{< var vm.product >}} imports the following artifacts into the documentation via our {{< var validmind.api >}} endpoint integration: -![](overview-api-integration.png){width=80% fig-alt="A representation of artifacts imported into the documentation via our API"} +![Artifacts imported into the docuemntation via our {{< var vm.api >}}](overview-api-integration.jpg){width=80% fig-alt="A representation of artifacts imported into the documentation via our Python API"} -- Metadata about datasets and models, used to look up programmatic documentation content, such as the stored definition for _common logistic regression limitations_ when a logistic regression model has been passed to the ValidMind test suite to be run. +- Metadata about datasets and models, used to look up programmatic documentation content, such as the stored definition for _common logistic regression limitations_ when a logistic regression model has been passed to the {{< var vm.product >}} test suite to be run. - Quality and performance metrics collected from datasets and models. - Output from tests and test suites that have been run. - Images, plots, visuals that were generated as part of extracting metrics and running tests. -The {{< var validmind.developer >}} does not send any personally identifiable information (PII) through our API. +The {{< var validmind.developer >}} does not send any personally identifiable information (PII) through our {{< var validmind.api >}}. - -The {{< var validmind.developer >}} streamlines the process of documenting various types of models. The {{< var vm.developer >}} automates the documentation process, ensuring that your model documentation and testing aligns with regulatory and compliance standards. +The {{< var validmind.developer >}} streamlines the process of documenting various types of models. {{< var vm.product >}} automates the documentation process, ensuring that your model documentation and testing aligns with regulatory and compliance standards. ::: {.attn} ## {{< fa code >}} The {{< var validmind.developer >}} -The {{< var validmind.developer >}} is a {{< var vm.developer >}} and documentation engine designed to streamline the process of documenting various types of models, including traditional statistical models, legacy systems, artificial intelligence/machine learning models, and large language models (LLMs). +The {{< var validmind.developer >}} is a Python library and documentation engine designed to streamline the process of documenting various types of models, including traditional statistical models, legacy systems, artificial intelligence/machine learning models, and large language models (LLMs). It offers model developers a systematic approach to documenting and testing risk models with repeatability and consistency, ensuring alignment with regulatory and compliance standards. -![The two main components of ValidMind. The developer framework that integrates with your existing developer environment, and the ValidMind AI risk platform.](overview-developer-framework.png){width=80% fig-alt="An image showing the two main components of ValidMind. The developer framework that integrates with your existing developer environment, and the ValidMind AI risk platform."} +![The two main components of {{< var vm.product >}}. The {{< var validmind.developer >}} that integrates with your existing developer environment, and the {{< var validmind.platform >}}.](/about/deployment/validmind-architecture-overview.png){fig-alt="An image showing the two main components of ValidMind. The ValidMind Library that integrates with your existing developer environment, and the ValidMind Platform."} -The {{< var validmind.developer >}} consists of a client-side library, API integration for models and testing, and validation tests that streamline the model development process. Implemented as a series of independent libraries in Python and R, our {{< var vm.developer >}} ensures compatibility and flexibility with diverse sets of developer environments and requirements. +The {{< var validmind.developer >}} consists of a client-side library, a {{< var vm.api >}} integration for models and testing, and validation tests that streamline the model development process. Implemented as a series of independent libraries in Python and R, our {{< var vm.developer >}} ensures compatibility and flexibility with diverse sets of developer environments and requirements. -With the {{< var vm.developer >}}, you can: +With the {{< var validmind.developer >}}, you can: - **Automate documentation** — Add comprehensive documentation as metadata while you build models to be shared with model validators, streamlining and speeding up the process. - **Run test suites** — Identify potential risks for a diverse range of statistical and AI/LLM/ML models by assessing data quality, model outcomes, robustness, and explainability. - **Integrate with your development environment** — Seamlessly incorporate the {{< var validmind.developer >}} into your existing model development environment, connecting to your existing model code and data sets. -- **Upload documentation data** — Send qualitative and quantitative test data to the AI risk platform to generate the model documentation for review and approval, fostering effective collaboration with model reviewers and validators. +- **Upload documentation data** — Send qualitative and quantitative test data to the {{< var validmind.platform >}}[^1] to generate the model documentation for review and approval, fostering effective collaboration with model reviewers and validators. ::: @@ -108,36 +100,37 @@ How the {{< var validmind.developer >}} works: ## Extensible by design -In Financial Services, our platform supports various model types, including:[^1] +{{< var vm.product >}} supports various model types, including:[^2] - Traditional machine learning models (ML) such as tree-based models and neural network models. - Natural language processing models (NLP) for text analysis and understanding. - Large language models (LLMs) in beta testing phase, offering advanced language capabilities. - Traditional statistical models like Ordinary Least Squares (OLS) regression, Logistic regression, Time Series models, and more. -Our platform is designed to be highly extensible to cater to our customers' specific requirements. You can expand its functionality in the following ways: +{{< var vm.product >}} is designed to be highly extensible to cater to our customers' specific requirements. You can expand its functionality in the following ways: -- You can easily add support for new models and data types by defining new classes within the {{< var validmind.developer >}}. We provide templates to guide you through this process.[^2] -- To include custom tests in the library, you can define new functions. We offer templates to help you create these custom tests.[^3] -- You have the flexibility to integrate third-party test libraries seamlessly. These libraries can be hosted either locally within your infrastructure or remotely, for example, on GitHub. Leverage additional testing capabilities and resources as needed.[^4] +- You can easily add support for new models and data types by defining new classes within the {{< var validmind.developer >}}. We provide templates to guide you through this process.[^3] +- To include custom tests in the library, you can define new functions. We offer templates to help you create these custom tests.[^4] +- You have the flexibility to integrate third-party test libraries seamlessly. These libraries can be hosted either locally within your infrastructure or remotely, for example, on GitHub. Leverage additional testing capabilities and resources as needed.[^5] -## API integration +## {{< var validmind.api >}} integration -ValidMind imports the following artifacts into the documentation via our API endpoint integration: +{{< var vm.product >}} imports the following artifacts into the documentation via our {{< var validmind.api >}} integration: -- Metadata about datasets and models, used to lookup programmatic documentation content, such as the stored definition for _common logistic regression limitations_ when a logistic regression model has been passed to the ValidMind test plan to be run. +- Metadata about datasets and models, used to lookup programmatic documentation content, such as the stored definition for _common logistic regression limitations_ when a logistic regression model has been passed to the {{< var vm.product >}} test plan to be run. - Quality and performance metrics collected from datasets and models. - Output from test and test suites that have been run. - Images, plots, visuals that were generated as part of extracting metrics and running tests. -![Artifacts imported into the documentation via our SaaS API](fine-print/overview-api-integration.png){width=90% fig-alt="A representation of artifacts imported into the documentation via our SaaS API"} +![Artifacts imported into the documentation via our {{< var vm.api >}}](fine-print/overview-api-integration.jpg){width=90% fig-alt="A representation of artifacts imported into the documentation via our Python API"} -::: {.callout-important title="ValidMind does NOT:"} +::: {.callout-important} +## {{< var vm.product >}} does NOT: - Send any personal identifiable information (PII) when generating documentation reports. - Store any customer datasets or models. ::: -## Ready to try out ValidMind? +## Ready to try out {{< var vm.product >}}? :::{#quickstart} ::: @@ -146,12 +139,14 @@ ValidMind imports the following artifacts into the documentation via our API end -[^1]: [Supported models](/developer/model-documentation/supported-models.qmd) +[^1]: [Model risk management](overview-model-risk-management.qmd) + +[^2]: [Supported models](/developer/model-documentation/supported-models.qmd) -[^2]: [Customize documentation templates](/guide/model-documentation/customize-documentation-templates.qmd) +[^3]: [Customize documentation templates](/guide/model-documentation/customize-documentation-templates.qmd) -[^3]: [Implement custom tests](/notebooks/code_samples/custom_tests/implement_custom_tests.ipynb) +[^4]: [Implement custom tests](/notebooks/code_samples/custom_tests/implement_custom_tests.ipynb) -[^4]: [Integrate external test providers](/notebooks/code_samples/custom_tests/integrate_external_test_providers.ipynb) +[^5]: [Integrate external test providers](/notebooks/code_samples/custom_tests/integrate_external_test_providers.ipynb) diff --git a/site/about/overview-model-risk-management.qmd b/site/about/overview-model-risk-management.qmd index 9de543e021..b68b4bb15a 100644 --- a/site/about/overview-model-risk-management.qmd +++ b/site/about/overview-model-risk-management.qmd @@ -17,26 +17,17 @@ listing: fields: [title, description, reading-time] --- - - -The {{< var validmind.platform >}} offers an integrated platform to manage validation reports, track findings, and report on model risk compliance across your model portfolio. The {{< var vm.platform >}} enables your organization to monitor and manage models effectively, focusing on mitigating risks, maintaining governance, and ensuring compliance throughout the entire enterprise. +The {{< var validmind.platform >}} offers an integrated solution to manage validation reports, track findings, and report on model risk compliance across your model portfolio. {{< var vm.product >}} enables your organization to monitor and manage models effectively, focusing on mitigating risks, maintaining governance, and ensuring compliance throughout the entire enterprise. ::: {.attn} ## {{< fa laptop-code >}} The {{< var validmind.platform >}} -The {{< var validmind.platform >}} provides a comprehensive suite of tools, guidelines, and best practices. You use the platform to review and evaluate models and model documentation to ensure they comply with organizational and regulatory requirements. +The {{< var validmind.platform >}} provides a comprehensive suite of tools, guidelines, and best practices. You use {{< var vm.product >}} to review and evaluate models and model documentation to ensure they comply with organizational and regulatory requirements. -![The two main components of ValidMind. The developer framework that integrates with your existing developer environment, and the ValidMind AI risk platform.](overview-platform-ui.png){width=80% fig-alt="An image showing the two main components of ValidMind. The developer framework that integrates with your existing developer environment, and the ValidMind AI risk platform." .lightbox} +![The two main components of {{< var vm.product >}}. The {{< var validmind.developer >}} that integrates with your existing developer environment, and the {{< var validmind.platform >}}.](overview-platform.png){width=80% fig-alt="An image showing the two main components of ValidMind. The ValidMind Library that integrates with your existing developer environment, and the ValidMind Platform." .lightbox} The {{< var vm.platform >}} employs a multi-tenant architecture, hosting the cloud-based user interface, APIs, databases, and internal services. The design ensures efficient resource utilization and offers a highly scalable solution for organizations of varying sizes. @@ -44,7 +35,7 @@ With the {{< var vm.platform >}}, you can: - **Track your model inventory**[^1] — Manage the model lifecycle, track the workflow status for models, plan for upcoming validation dates, and more. - **Work on validation initiatives**[^2] — Collaborate with developers and validators to review documentation, add findings, keep track of review statuses, and generate validation reports. -- **Configure workflows**[^3] — Set up ValidMind to follow your existing model risk management processes, manage statuses for different parts of the workflow, and get an end-to-end view of workflows and who is involved. +- **Configure workflows**[^3] — Set up the {{< var validmind.platform >}} to follow your existing model risk management processes, manage statuses for different parts of the workflow, and get an end-to-end view of workflows and who is involved. - **Use, create, or edit tests, test suites, and templates**[^4] — Create and/or configure required validation tests, test suites, and documentation templates for specific model use cases, tailoring it to your own specific needs. - **Integrate with your stack**[^5] — Import and export model documentation and validation reports. @@ -52,7 +43,7 @@ With the {{< var vm.platform >}}, you can: ## Regulatory requirements -ValidMind's platform is designed to cater to the regulatory compliance and model risk management (MRM) requirements of financial institutions, facilitating enhanced compliance with government regulations, policies concerning MRM, and emerging legislations addressing AI model risk, including risks associated with the use of large language models (LLMs). +{{< var vm.product >}} is designed to cater to the regulatory compliance and model risk management (MRM) requirements of financial institutions, facilitating enhanced compliance with government regulations, policies concerning MRM, and emerging legislations addressing AI model risk, including risks associated with the use of large language models (LLMs). Examples of regulations or policies include: @@ -144,7 +135,7 @@ The regulation encourages a proportionate application of these principles based ### Around the globe -Other, similar guidelines and policies that our platform is designed to help you with include: +Other, similar guidelines and policies that {{< var vm.product >}} is designed to help you with include: :::: {.flex .flex-wrap .justify-around} @@ -174,19 +165,19 @@ Issued by the Financial Services Agency (FSA) in Japan in June 2021, this docume ::: -### Meeting regulatory requirements with ValidMind +### Meeting regulatory requirements with {{< var vm.product >}} -ValidMind, as a robust tool for implementing Model Risk Management (MRM) best practices, including the _three lines of defense_, significantly aids organizations in adhering to the regulatory guidelines set forth by SR 11-7 and SS1/23. + As a robust tool for implementing Model Risk Management (MRM) best practices, including the _three lines of defense_, {{< var vm.product >}} significantly aids organizations in adhering to the regulatory guidelines set forth by SR 11-7 and SS1/23. :::: {.flex .flex-wrap .justify-around} ::: {.w-40-ns} First line of defense — model developers -: ValidMind offers a suite of tools for model developers, facilitating thorough documentation and rigorous testing of models, aligning with the regulatory expectations of both SR 11-7 and SS1/23, particularly for models under regulatory purview. +: {{< var vm.product >}} offers a suite of tools for model developers, facilitating thorough documentation and rigorous testing of models, aligning with the regulatory expectations of both SR 11-7 and SS1/23, particularly for models under regulatory purview. Second line of defense — model validators -: The platform empowers model validators with the ability to independently validate models ensuring adherence to the organization's MRM principles throughout the model lifecycle, a core requirement of these regulations. +: {{< var vm.product >}} empowers model validators with the ability to independently validate models ensuring adherence to the organization's MRM principles throughout the model lifecycle, a core requirement of these regulations. Third line of defense — auditors : Enabling internal and external audits provides an independent and objective assurance to the organization by assessing the robustness of controls within the model risk management framework. It evaluates how well the first and second lines of defense are functioning, ensuring adherence to regulatory and organizational standards, thereby promoting a robust model risk management environment. @@ -198,23 +189,23 @@ Model inventory ::: {.w-50-ns} Lifecycle management and custom workflows -: ValidMind’s capabilities extend to effective model lifecycle management through configurable workflows. This structured approach to managing model risks across various lifecycle stages significantly aids in meeting the rigorous management and oversight expectations set by SR 11-7 and SS1/23. +: {{< var vm.product >}}’s capabilities extend to effective model lifecycle management through configurable workflows. This structured approach to managing model risks across various lifecycle stages significantly aids in meeting the rigorous management and oversight expectations set by SR 11-7 and SS1/23. Model documentation automation -: By automating model documentation through configurable templates and test plans, ValidMind ensures consistent and accurate documentation capture, directly aligning with the documentation standards stipulated in these regulatory guidelines. +: By automating model documentation through configurable templates and test plans, {{< var vm.product >}} ensures consistent and accurate documentation capture, directly aligning with the documentation standards stipulated in these regulatory guidelines. Model validation and approval -: With automated validation features and comprehensive risk assessment tools, ValidMind aligns with the effective validation criteria and thorough risk evaluation mandates of SR 11-7 and SS1/23. +: With automated validation features and comprehensive risk assessment tools, {{< var vm.product >}} aligns with the effective validation criteria and thorough risk evaluation mandates of SR 11-7 and SS1/23. Communication and tracking -: The built-in communication and tracking functionality of ValidMind facilitates seamless collaboration and understanding among stakeholders regarding model usage, limitations, and risks, fostering a collaborative environment as encouraged by these regulations. +: The built-in communication and tracking functionality of {{< var vm.product >}} facilitates seamless collaboration and understanding among stakeholders regarding model usage, limitations, and risks, fostering a collaborative environment as encouraged by these regulations. ::: :::: -By integrating these features, ValidMind provides a comprehensive platform that not only simplifies the path to compliance with SR 11-7 and SS1/23 but also embeds a culture of rigorous and transparent model risk management within the organization. +By integrating these features, {{< var vm.product >}} provides a comprehensive suite of tools that not only simplifies the path to compliance with SR 11-7 and SS1/23 but also embeds a culture of rigorous and transparent model risk management within the organization. -## Ready to try out ValidMind? +## Ready to try out {{< var vm.product >}}? :::{#quickstart} ::: diff --git a/site/about/overview-platform-ui.png b/site/about/overview-platform.png similarity index 100% rename from site/about/overview-platform-ui.png rename to site/about/overview-platform.png diff --git a/site/about/overview.qmd b/site/about/overview.qmd index 63bee5029e..da04ed6c8e 100644 --- a/site/about/overview.qmd +++ b/site/about/overview.qmd @@ -1,5 +1,5 @@ --- -title: "About ValidMind" +title: "About {{< var vm.product >}}" date: last-modified listing: - id: validmind-features @@ -17,44 +17,15 @@ aliases: - ../guide/overview.html --- - - :::: {.flex .flex-wrap .justify-around} ::: {.w-60-ns} -The ValidMind platform is a suite of tools helping developers, data scientists and risk and compliance stakeholders identify potential risks in their AI and large language models, and generate robust, high-quality model documentation that meets regulatory requirements. +{{< var vm.product >}} is a suite of tools helping developers, data scientists and risk and compliance stakeholders identify potential risks in their AI and large language models, and generate robust, high-quality model documentation that meets regulatory requirements. -The platform is adept at handling many use cases, including models compatible with the Hugging Face Transformers API, and GPT 3.5, GPT 4, and hosted LLama2 and Falcon-based models (focused on text classification and text summarization use cases). +Adept at handling many use cases, including models compatible with the Hugging Face Transformers API, and GPT 3.5, GPT 4, and hosted LLama2 and Falcon-based models (focused on text classification and text summarization use cases), {{< var vm.product >}} is purpose-built for model risk management teams. -In addition to LLMs, ValidMind can also handle testing and documentation generation for a wide variety of models, including: +In addition to LLMs, {{< var vm.product >}} can also handle testing and documentation generation for a wide variety of models, including: - Traditional machine learning models (ML), such as tree-based models and neural networks - Natural language processing models (NLP) @@ -79,7 +50,7 @@ In addition to LLMs, ValidMind can also handle testing and documentation generat :::: -What sets ValidMind apart is its focus on simplifying complex tasks for both model developers and validators. By automating critical and often tedious aspects of the model lifecycle, such as documentation, validation, and testing, we enable model developers to concentrate on building better models. +What sets {{< var vm.product >}} apart is its focus on simplifying complex tasks for both model developers and validators. By automating critical and often tedious aspects of the model lifecycle, such as documentation, validation, and testing, we enable model developers to concentrate on building better models. We do all of this while making it easy to align with regulatory guidelines on model risk management in the United States, the United Kingdom, and Canada. These regulations include the Federal Reserve's SR 11-7, the UK's SS1/23 and CP6/22), and Canada's Guideline E-23. @@ -90,13 +61,9 @@ We do all of this while making it easy to align with regulatory guidelines on mo ::: {.attn} -## {{< fa hand-point-right >}} Ready to try out ValidMind? +## {{< fa hand-point-right >}} Ready to try out {{< var vm.product >}}? Our [QuickStart](/get-started/quickstart.qmd) is the quickest and easiest way to try out our product features. ::: - - diff --git a/site/developer/get-started-developer-framework.qmd b/site/developer/get-started-validmind-library.qmd similarity index 69% rename from site/developer/get-started-developer-framework.qmd rename to site/developer/get-started-validmind-library.qmd index 5678ddb4a0..b1b48f3469 100644 --- a/site/developer/get-started-developer-framework.qmd +++ b/site/developer/get-started-validmind-library.qmd @@ -5,6 +5,7 @@ aliases: - ../guide/get-started-developer-framework.html - ../guide/developer-framework.html - ../guide/restapi.html + - get-started-developer-framework.html listing: - id: developer-getting-started type: grid @@ -45,26 +46,26 @@ listing: - model-documentation/documenting-models.qmd --- -The {{< var validmind.developer >}} helps you streamline model documentation by automating the generation of drafts. All you need to do is upload your documentation artifacts and test results to the ValidMind platform. +The {{< var validmind.developer >}} helps you streamline model documentation by automating the generation of drafts. All you need to do is upload your documentation artifacts and test results to the {{< var validmind.platform >}}. ## What is the {{< var validmind.developer >}}? -ValidMind's {{< var vm.developer >}} provides a rich collection of documentation tools and test suites, from documenting descriptions of your dataset to validation testing your models for weak spots and overfit areas. +The {{< var validmind.developer >}} provides a rich collection of documentation tools and test suites, from documenting descriptions of your dataset to validation testing your models for weak spots and overfit areas. -![](validmind-ai-risk-platform.png){width=70% fig-alt="An image showing the two main components of ValidMind. The developer framework that integrates with your existing developer environment, and the ValidMind Platform UI."} +![](validmind-ai-risk-platform.png){width=70% fig-alt="An image showing the two main components of ValidMind. The ValidMind Library that integrates with your existing developer environment, and the ValidMind Platform."} -ValidMind offers two primary methods for automating model documentation: +{{< var vm.product >}} offers two primary methods for automating model documentation: - **Generate documentation** — Through automation, the {{< var vm.developer >}} extracts metadata from associated datasets and models for you and generates model documentation based on a template. You can also add more documentation and tests manually using the documentation editing capabilities in the {{< var validmind.platform >}}. - **Run validation tests** — The {{< var vm.developer >}} provides a suite of validation tests for common financial services use cases. For cases where these tests do not cover everything you need, you can also extend existing test suites with your own proprietary tests or testing providers. -The {{< var vm.developer >}} is designed to be model agnostic. If your model is built in Python, ValidMind’s Python client library already provides all the standard functionality you might need without requiring your developers to rewrite any functions. +The {{< var validmind.developer >}} is designed to be model agnostic. If your model is built in Python, the {{< var vm.developer >}} provides all the standard functionality you may need without requiring you to rewrite any functions. ::: {.callout-important collapse="true" appearance="minimal"} -## {{< fa building-columns >}} Key ValidMind concepts +## {{< fa building-columns >}} Key {{< var vm.product >}} concepts @@ -80,7 +81,7 @@ The {{< var vm.developer >}} is designed to be model agnostic. If your model is ::: ::: -After you [**sign up**]({{< var url.us1 >}}) for ValidMind to get access, try one of our getting started guides: +After you [**sign up**]({{< var url.us1 >}}) for {{< var vm.product >}} to get access, try one of our getting started guides: :::{#developer-getting-started} ::: @@ -88,7 +89,7 @@ After you [**sign up**]({{< var url.us1 >}}) for ValidMind to get access, try on ## Learn how to run tests -ValidMind provides many built-in tests and test suites which make it easy for developers to automate their model documentation. Start by running a pre-made test, then modify it, and finally create your own test: +The {{< var validmind.developer >}} provides many built-in tests and test suites which make it easy for developers to automate their model documentation. Start by running a pre-made test, then modify it, and finally create your own test: :::{#developer-how-to-beginner} ::: @@ -106,13 +107,13 @@ Our code samples showcase the capabilities of the {{< var validmind.developer >} ## What's next -After you have tried out the {{< var vm.developer >}}, continue [working with your model documentation](/guide/model-documentation/working-with-model-documentation.qmd) in the AI Risk Platform ({{< var vm.platform >}}) online. There, you can: +After you have tried out the {{< var validmind.developer >}}, continue [working with your model documentation](/guide/model-documentation/working-with-model-documentation.qmd) in the {{< var validmind.platform >}} online. There, you can: - Work with documentation templates to customize them to your specific needs -- Work with model documentation in the UI to make edits, collaborate with validators, and submit your model documentation for approval +- Work with model documentation in the {{< var vm.platform >}} to make edits, collaborate with validators, and submit your model documentation for approval - Export your finalized model documentation -For more in-depth guides, check out our breakdown of your complete journey as a model developer with ValidMind: +For more in-depth guides, check out our breakdown of your complete journey as a model developer with {{< var vm.product >}}: :::{#developer-workflow} ::: diff --git a/site/developer/model-documentation/document-models.qmd b/site/developer/model-documentation/document-models.qmd index f14d402fd8..c1900abe5d 100644 --- a/site/developer/model-documentation/document-models.qmd +++ b/site/developer/model-documentation/document-models.qmd @@ -27,11 +27,11 @@ Generate model documentation starting with your model or model predictions, load 1. **From your modeling environment**, load the trained datasets and models or predictions. -2. [Install and initialize the client library.](install-and-initialize-client-library.qmd) +2. [Install and initialize the {{< var validmind.developer >}}.](install-and-initialize-validmind-library.qmd) 3. Select the relevant tests. -4. Review if all tests are covered by ValidMind or your external test provider: +4. Review if all tests are covered by {{< var vm.product >}} or your external test provider: - **If all tests are NOT covered** — Create and register additional tests. - **If all tests are covered** — @@ -67,10 +67,10 @@ Generate model documentation starting with your model or model predictions, load [^2]: **No available model?**
- You can still run tests and log documentation with ValidMind as long as you're able to [load the model predictions](/faq/faq-documentation.qmd#can-i-run-tests-and-log-documentation-without-having-a-model-available). + You can still run tests and log documentation with {{< var vm.product >}} as long as you're able to [load the model predictions](/faq/faq-documentation.qmd#can-i-run-tests-and-log-documentation-without-having-a-model-available). [^3]: [Work with content blocks](/guide/model-documentation/work-with-content-blocks.qmd) -[^4]: [Install and initialize the client library](install-and-initialize-client-library.qmd) +[^4]: [Install and initialize the {{< var validmind.developer >}}](install-and-initialize-validmind-library.qmd) [^5]: [Work with test results](work-with-test-results.qmd) diff --git a/site/developer/model-documentation/documenting-models.qmd b/site/developer/model-documentation/documenting-models.qmd index 225aee733d..d5fd2f47f9 100644 --- a/site/developer/model-documentation/documenting-models.qmd +++ b/site/developer/model-documentation/documenting-models.qmd @@ -10,7 +10,7 @@ listing: fields: [title, description] contents: - document-models.qmd - - install-and-initialize-client-library.qmd + - install-and-initialize-validmind-library.qmd - work-with-test-results.qmd - store-credentials-in-env-file.qmd aliases: @@ -86,11 +86,11 @@ When you have registered all the required tests as content blocks in the documen run_documentation_tests() ``` -::: {.callout-important title="ValidMind may not support all potential use cases or provide a universally applicable documentation template."} - Typically, you initiate the process of putting ValidMind into production by constructing a template specific for your own use case and then refine your model documentation. +::: {.callout-important} +## {{< var vm.product >}} may not support all potential use cases or provide a universally applicable documentation template. + Typically, you initiate the process of putting {{< var vm.product >}} into production by constructing a template specific for your own use case and then refine your model documentation. ::: - ## What's next :::{#generate-documentation} @@ -102,4 +102,4 @@ When you have registered all the required tests as content blocks in the documen [^1]: **No available model?**
- You can still run tests and log documentation with ValidMind as long as you're able to [load the model predictions](/faq/faq-documentation.qmd#can-i-run-tests-and-log-documentation-without-having-a-model-available). \ No newline at end of file + You can still run tests and log documentation with {{< var vm.product >}} as long as you're able to [load the model predictions](/faq/faq-documentation.qmd#can-i-run-tests-and-log-documentation-without-having-a-model-available). \ No newline at end of file diff --git a/site/developer/model-documentation/install-and-initialize-client-library.qmd b/site/developer/model-documentation/install-and-initialize-validmind-library.qmd similarity index 68% rename from site/developer/model-documentation/install-and-initialize-client-library.qmd rename to site/developer/model-documentation/install-and-initialize-validmind-library.qmd index 8f471ca959..ca1351c77f 100644 --- a/site/developer/model-documentation/install-and-initialize-client-library.qmd +++ b/site/developer/model-documentation/install-and-initialize-validmind-library.qmd @@ -1,14 +1,17 @@ --- -title: "Install and initialize the client library" +# USING THE VARIABLE IN THE TITLE MESSES UP THE BREADCRUMB +title: "Install and initialize the ValidMind Library" date: last-modified aliases: - install-and-initialize-validmind.html + - ../../guide/install-and-initialize-validmind-library.html - ../../guide/install-and-initialize-developer-framework.html + - install-and-initialize-client-library.html filters: - tachyons --- -ValidMind generates a unique _code snippet_ for each registered model to connect with your developer environment. You initialize the client library with this code snippet, ensuring that your documentation and tests are uploaded to the correct model. +{{< var vm.product >}} generates a unique _code snippet_ for each registered model to connect with your developer environment. You initialize the {{< var validmind.developer >}} with this code snippet, ensuring that your documentation and tests are uploaded to the correct model. ::: {.attn} @@ -22,7 +25,7 @@ In order to integrate the {{< var vm.developer >}} and to be able to upload to t | Argument | Description | |---------------|------------------------------------| -| `api_host` | The location of the ValidMind API | +| `api_host` | The location of the {{< var vm.product >}} API | | `api_key` | The account API key | | `api_secret` | The account secret key | | `model` | The model identifier | @@ -33,7 +36,7 @@ The {{< var vm.developer >}} also requires access to the data sources where data ::: -## Install ValidMind +## Install {{< var vm.product >}} ### Locate the {{< var vm.developer >}} integration instructions @@ -47,17 +50,17 @@ For existing models, this information can be found in the {{< var validmind.plat 4. Locate the code snippet and click **{{< fa regular copy >}} Copy snippet to clipboard**. -### Install the client library +### Install the {{< var vm.developer >}} -To install the client library: +To install the {{< var vm.developer >}}: ```python %pip install validmind ``` -### Initialize the client library +### Initialize the {{< var vm.developer >}} -To initialize the client library, paste the code snippet with the client integration details directly into your development source code, replacing this example with your own: +To initialize the {{< var vm.developer >}}, paste the code snippet with the client integration details directly into your development source code, replacing this example with your own: ```python import validmind as vm @@ -74,13 +77,13 @@ vm.init( To also enable monitoring, add `monitoring=True` to the `vm.init` method in your code snippet. [^4] ::: -After you have pasted the code snippet into your development source code and run your code, the Python client library will connect and register with ValidMind. You can now use the {{< var vm.developer >}} to document and test your models, and to upload model documentation and test results to the {{< var vm.platform >}}. +After you have pasted the code snippet into your development source code and run your code, the {{< var validmind.developer >}} will connect and register with the {{< var validmind.platform >}}. You can now use the {{< var vm.developer >}} to document and test your models, and to upload model documentation and test results to the {{< var vm.platform >}}. -## Upgrade ValidMind +## Upgrade {{< var vm.product >}} -After installing ValidMind,[^5] you'll want to periodically make sure you are on the latest version to access any new features and other enhancements: +After installing {{< var vm.product >}},[^5] you'll want to periodically make sure you are on the latest version to access any new features and other enhancements: -1. In your Jupyter Notebook or developer environment, retrieve the information for the currently installed version of ValidMind: +1. In your Jupyter Notebook or developer environment, retrieve the information for the currently installed version of {{< var vm.product >}}: ```python %pip show validmind @@ -118,6 +121,6 @@ Version: 2.5.15 [^4]: [Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd) -[^5]: [Install ValidMind](#install-validmind) +[^5]: [Install {{< var vm.product >}}](#install-validmind) [^6]: **GitHub:** [validmind/developer-framework/validmind/__version__.py](https://github.com/validmind/developer-framework/blob/prod/validmind/__version__.py) \ No newline at end of file diff --git a/site/developer/model-documentation/store-credentials-in-env-file.qmd b/site/developer/model-documentation/store-credentials-in-env-file.qmd index 415f0ed67a..6a8b5ab845 100644 --- a/site/developer/model-documentation/store-credentials-in-env-file.qmd +++ b/site/developer/model-documentation/store-credentials-in-env-file.qmd @@ -76,7 +76,7 @@ Keeing model credentials in a separate file also allows for precise access contr ## What's next - [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd) -- [Get started with the {{< var validmind.developer >}}](/developer/get-started-developer-framework.qmd) +- [Get started with the {{< var validmind.developer >}}](/developer/get-started-validmind-library.qmd) diff --git a/site/developer/model-documentation/supported-models.qmd b/site/developer/model-documentation/supported-models.qmd index 7448b74efa..447af35642 100644 --- a/site/developer/model-documentation/supported-models.qmd +++ b/site/developer/model-documentation/supported-models.qmd @@ -7,13 +7,13 @@ aliases: - ../../guide/supported-models.html --- -ValidMind's {{< var vm.developer >}} provides out-of-the-box support for testing and documentation for an array of model types and modeling packages. +The {{< var validmind.developer >}} provides out-of-the-box support for testing and documentation for an array of model types and modeling packages. ## What is a supported model? -A _supported model_ refers to a model for which predefined testing or documentation functions exist in the {{< var validmind.developer >}}, provided that the model you are developing is documented using a supported version of our client library. These model types cover a very large portion of the models used in commercial and retail banking. +A _supported model_ refers to a model for which predefined testing or documentation functions exist in the {{< var validmind.developer >}}, provided that the model you are developing is documented using a supported version of our {{< var vm.developer >}}. These model types cover a very large portion of the models used in commercial and retail banking. -Given the rapid developments in the AI space, including the advent of large language models (LLMs), ValidMind product development has also focused on making sure that our {{< var vm.developer >}} is extensible to support future model types or modeling packages, so that we do not limit our users to specific model types. You always have the flexibility to: +Given the rapid developments in the AI space, including the advent of large language models (LLMs), {{< var vm.product >}} product development has also focused on making sure that our {{< var vm.developer >}} is extensible to support future model types or modeling packages, so that we do not limit our users to specific model types. You always have the flexibility to: - [Implement custom tests](/notebooks/code_samples/custom_tests/implement_custom_tests.ipynb) - [Integrate external test providers](/notebooks/code_samples/custom_tests/integrate_external_test_providers.ipynb) @@ -58,7 +58,7 @@ Large language models (LLMs) - Text summarization — Generates concise summaries from longer texts. :::{.callout} -ValidMind offers support for both first-party models and [third-party vendor models](/about/glossary/glossary.qmd#vendor-model). +{{< var vm.product >}} offers support for both first-party models and [third-party vendor models](/about/glossary/glossary.qmd#vendor-model). ::: ## Supported modeling libraries and other tools diff --git a/site/developer/model-testing/testing-overview.qmd b/site/developer/model-testing/testing-overview.qmd index d6e1a94da4..a0d3d2111a 100644 --- a/site/developer/model-testing/testing-overview.qmd +++ b/site/developer/model-testing/testing-overview.qmd @@ -55,10 +55,10 @@ filters: - tachyons --- -ValidMind provides many built-in tests and test suites, which help you produce documentation during stages of the model development lifecycle where you need to validate that your work satisfies MRM (model risk management) requirements. +{{< var vm.product >}} provides many built-in tests and test suites, which help you produce documentation during stages of the model development lifecycle where you need to validate that your work satisfies MRM (model risk management) requirements. ::: {.callout-important collapse="true" appearance="minimal"} -## {{< fa building-columns >}} Key ValidMind concepts +## {{< fa building-columns >}} Key {{< var vm.product >}} concepts @@ -102,7 +102,7 @@ Need more? Try some of the advanced features provided by the {{< var vm.develope ## When do I use tests and test suites? -While you have the flexibility to decide when to use which ValidMind tests, we have identified a few typical scenarios with their own characteristics and needs: +While you have the flexibility to decide when to use which {{< var vm.product >}} tests, we have identified a few typical scenarios with their own characteristics and needs: :::: {.flex .flex-wrap .justify-around} @@ -142,7 +142,7 @@ Use the [`classifier_full_suite`](/validmind/validmind/test_suites/classifier.ht ## Can I use my own tests? -Absolutely! ValidMind supports custom tests that you develop yourself or that are provided by third-party test libraries, also referred to as _test providers_. We provide instructions with code examples that you can adapt: +Absolutely! {{< var vm.product >}} supports custom tests that you develop yourself or that are provided by third-party test libraries, also referred to as _test providers_. We provide instructions with code examples that you can adapt: :::{#tests-custom} ::: diff --git a/site/faq/faq-documentation.qmd b/site/faq/faq-documentation.qmd index d8e87380e3..cc91ceab62 100644 --- a/site/faq/faq-documentation.qmd +++ b/site/faq/faq-documentation.qmd @@ -7,7 +7,7 @@ aliases: ## Can I run tests and log documentation without having a model available? -If you do not have a model ready, or your model can't be loaded directly, or you only have access to model predictions, you can still run tests and log documentation with ValidMind as long as you're able to load the model predictions. +If you do not have a model ready, or your model can't be loaded directly, or you only have access to model predictions, you can still run tests and log documentation with {{< var vm.product >}} as long as you're able to load the model predictions. - Use [`assign_predictions()`](/validmind/validmind/vm_models.html#VMDataset.assign_predictions){target="_blank"} to load predictions from a separate file or a dataset with predictions. - Call [`init_model()`](/validmind/validmind.html#init_model){target="_blank"} but instead of a trained model instance, pass an `input_id` and model metadata. [`ModelMetadata()`](/validmind/validmind/tests/model_validation/ModelMetadata.html#ModelMetadata){target="_blank"} will use the provided metadata instead of trying to calculate it from the model's library. @@ -27,13 +27,13 @@ However, tests that need a trained model will not work with "empty" models. ## Can documentation templates be configured per model use case or to match our existing templates? -ValidMind's platform allows you to configure multiple templates based on documentation requirements for each model use case. During the model registration process, the platform automatically selects the template based on the provided model use case information. +The {{< var validmind.platform >}} allows you to configure multiple templates based on documentation requirements for each model use case. During the model registration process, the {{< var vm.platform >}} automatically selects the template based on the provided model use case information. Documentation templates can be modified by configuring a YAML file in the backend. ## Can the documentation be exported? -ValidMind supports exporting documentation and validation reports in Word (.docx) or PDF formats. +{{< var vm.product >}} supports exporting documentation and validation reports in Word (.docx) or PDF formats. ## Can we attach files to the documentation on the UI? What file formats are supported? @@ -50,14 +50,14 @@ You can attach image files to documentation cells and comments on the UI. The fo - HEIF - PSD -Additionally, ValidMind is working on enabling you to attach Excel, CSV, Word, and PDF files to the documentation in the UI (Roadmap item – Q2 2023). +Additionally, {{< var vm.product >}} is working on enabling you to attach Excel, CSV, Word, and PDF files to the documentation in the UI (Roadmap item – Q2 2023). -## Can the documentation be initialized from the UI instead of the {{< var vm.developer >}}? +## Can the documentation be initialized from the {{< var validmind.platform >}} instead of the {{< var validmind.developer >}}? -ValidMind allows you to write documentation directly in the online UI editor, without having to use the {{< var vm.developer >}}. +{{< var vm.product >}} allows you to write documentation directly in the {{< var validmind.platform >}}, without having to use the {{< var validmind.developer >}}. -From the online UI editor, you can edit text and tables and upload your test results, including images. Using the {{< var vm.developer >}}, you can execute test suites and generate the corresponding documentation. +You can edit text and tables and upload your test results using the {{< var vm.platform >}}, including images. Using the {{< var vm.developer >}}, you can execute test suites and generate the corresponding documentation. -## Can we export the documentation produced by ValidMind to the storage/workflow system used by the model validation team? +## Can we export the documentation produced by {{< var vm.product >}} to the storage/workflow system used by the model validation team? -Documentation and validation reports produced in ValidMind can be exported to Word and PDF formats. Depending on the integration requirements of the systems used by your validation teams, such as connectivity via API, SharePoint, and more, ValidMind can work with you to automate the export and storage of documentation into these systems. +Documentation and validation reports produced in {{< var vm.product >}} can be exported to Word and PDF formats. Depending on the integration requirements of the systems used by your validation teams, such as connectivity via API, SharePoint, and more, {{< var vm.product >}} can work with you to automate the export and storage of documentation into these systems. diff --git a/site/faq/faq-integrations.qmd b/site/faq/faq-integrations.qmd index 24c772a10a..5c7fe5f211 100644 --- a/site/faq/faq-integrations.qmd +++ b/site/faq/faq-integrations.qmd @@ -7,11 +7,11 @@ aliases: ## Can you integrate with JIRA to connect with our Model Development pipeline? -ValidMind is planning to provide integration with JIRA tickets via the JIRA Python API. You will be able to configure ValidMind to update the status of a particular JIRA ticket when a specific state or approval is triggered from the workflow (roadmap item – Q3’2023). +{{< var vm.product >}} is planning to provide integration with JIRA tickets via the JIRA Python API. You will be able to configure {{< var vm.product >}} to update the status of a particular JIRA ticket when a specific state or approval is triggered from the workflow (roadmap item – Q3’2023). ## What libraries beyond XGBoost are supported? -ValidMind supports the most popular open-source model development libraries in Python and R, such as: +{{< var vm.product >}} supports the most popular open-source model development libraries in Python and R, such as: - scikit-learn - XGBoost @@ -19,11 +19,11 @@ ValidMind supports the most popular open-source model development libraries in P - PyTorch - TensorFlow -ValidMind supports ingesting test results from your training and evaluation pipeline, such as using batch prediction or online prediction mechanisms. We are also implementing standard documentation via the {{< var vm.developer >}} for additional modeling techniques, check [Do you include explainability-related testing and documentation?](faq-testing.qmd#do-you-include-explainability-related-testing-and-documentation) for more information. +{{< var vm.product >}} supports ingesting test results from your training and evaluation pipeline, such as using batch prediction or online prediction mechanisms. We are also implementing standard documentation via the {{< var vm.developer >}} for additional modeling techniques, check [Do you include explainability-related testing and documentation?](faq-testing.qmd#do-you-include-explainability-related-testing-and-documentation) for more information. ## What other programming languages and development environments do you support beyond Python and Jupyter Notebook, such as R and SAS? -ValidMind's {{< var vm.developer >}} is designed to be platform-agnostic and compatible with the most popular open-source programming languages and model development environments. +The {{< var validmind.developer >}} is designed to be platform-agnostic and compatible with the most popular open-source programming languages and model development environments. Currently, we support **Python {{< var version.python >}}** and the most popular AI/ML and data science libraries (scikit-learn, XGBoost, statsmodels, PyTorch, TensorFlow). @@ -39,7 +39,7 @@ We will be implementing connector interfaces allowing extraction of relationship ## Which model development packages/libraries are supported by the {{< var validmind.developer >}}? What about complex/distributed models built with TensorFlow? -ValidMind supports the most popular open-source model development libraries in Python and R, such as: +{{< var vm.product >}} supports the most popular open-source model development libraries in Python and R, such as: - scikit-learn - XGBoost @@ -47,18 +47,18 @@ ValidMind supports the most popular open-source model development libraries in P - PyTorch - TensorFlow -For distributed training pipelines built with frameworks like TensorFlow, ValidMind can directly access the trained model instance to extract metadata stored in the model object, if the {{< var vm.developer >}} is imported from within the pipeline's code. ValidMind can also ingest test results from the customer's training or evaluation pipeline, using batch prediction or online prediction mechanisms. +For distributed training pipelines built with frameworks like TensorFlow, {{< var vm.product >}} can directly access the trained model instance to extract metadata stored in the model object, if the {{< var vm.developer >}} is imported from within the pipeline's code. {{< var vm.product >}} can also ingest test results from the customer's training or evaluation pipeline, using batch prediction or online prediction mechanisms. ## Is it possible for us to integrate the tool with LLMs like GPT-3? -ValidMind is integrating LLMs tools into our documentation features, enabling the following documentation features: +{{< var vm.product >}} is integrating LLMs tools into our documentation features, enabling the following documentation features: - Generating content recommendations (or “starting points”) for model developers for specific sections of the documentation, based on historical documentations (roadmap item — Q3’2023). - Providing insights to model developers and model reviewers on possible model risks, and mitigation actions/improvements to the model, based on historical model documentations (roadmap item currently in research – not scheduled). ## Can you handle more sophisticated AI/ML libraries such as Pytorch, TensorFlow? -ValidMind supports the most popular open-source model development libraries in Python, R, such as : +{{< var vm.product >}} supports the most popular open-source model development libraries in Python, R, such as : - scikit-learn - XGBoost @@ -66,9 +66,9 @@ ValidMind supports the most popular open-source model development libraries in P - PyTorch - TensorFlow -For distributed training pipelines built with frameworks, such as TensorFlow, ValidMind can directly access the trained model instance to extract metadata stored in the model object if the {{< var validmind.developer >}} is imported from within the pipeline’s code. -ValidMind can also ingest test results from the customer’s training/evaluation pipeline, such as using batch prediction or online prediction mechanisms. +For distributed training pipelines built with frameworks, such as TensorFlow, {{< var vm.product >}} can directly access the trained model instance to extract metadata stored in the model object if the {{< var validmind.developer >}} is imported from within the pipeline’s code. +{{< var vm.product >}} can also ingest test results from the customer’s training/evaluation pipeline, such as using batch prediction or online prediction mechanisms. -## Does ValidMind support data dictionaries? +## Does {{< var vm.product >}} support data dictionaries? -You can pass a data dictionary to ValidMind via the {{< var vm.developer >}}, such as in CSV format. +You can pass a data dictionary to {{< var vm.product >}} via the {{< var vm.developer >}}, such as in CSV format. diff --git a/site/faq/faq-inventory.qmd b/site/faq/faq-inventory.qmd index 0fcc1aebd5..1c75a60ffc 100644 --- a/site/faq/faq-inventory.qmd +++ b/site/faq/faq-inventory.qmd @@ -7,7 +7,7 @@ aliases: ## Can permissions for the model inventory be configured? -ValidMind allows you to configure view and edit permissions for the model inventory and documentation or validation reports based on user roles. +{{< var vm.product >}} allows you to configure view and edit permissions for the model inventory and documentation or validation reports based on user roles. ## Is it possible to track or view a summary of questions asked by validators? @@ -15,10 +15,10 @@ Questions, comments, and findings from model validations are centrally tracked a ## Can the model inventory track revalidation, periodic validation dates, and more? -In addition to initial validation exercises, ValidMind can manage activities throughout the entire model risk management lifecycle, including periodic reviews, change validations, and ongoing monitoring deadlines (roadmap item – Q3 2023). +In addition to initial validation exercises, {{< var vm.product >}} can manage activities throughout the entire model risk management lifecycle, including periodic reviews, change validations, and ongoing monitoring deadlines (roadmap item – Q3 2023). ## Do you support executive reporting for senior leaders in our BUs? -ValidMind is working on a dashboard feature that provides executive metrics, such as model documentation compliance reporting across BUs, findings by status and model use case, and more. +{{< var vm.product >}} is working on a dashboard feature that provides executive metrics, such as model documentation compliance reporting across BUs, findings by status and model use case, and more. These metrics can be exported into a customizable report for the customer. diff --git a/site/faq/faq-models.qmd b/site/faq/faq-models.qmd index b317ac1dd0..2f5fd89294 100644 --- a/site/faq/faq-models.qmd +++ b/site/faq/faq-models.qmd @@ -5,9 +5,9 @@ aliases: - ../guide/faq-models.html --- -## How do models get registered in ValidMind? +## How do models get registered in {{< var vm.product >}}? -Models get registered into ValidMind via the Model Inventory. To add a model into the Inventory, you need to fill out a customizable registration questionnaire capturing the required registration metadata, such as: +Models get registered into {{< var vm.product >}} via the Model Inventory. To add a model into the Inventory, you need to fill out a customizable registration questionnaire capturing the required registration metadata, such as: - Model Name - Model Use @@ -17,13 +17,13 @@ Models get registered into ValidMind via the Model Inventory. To add a model int ## Can the fields for model registration questionnaires be configured? -ValidMind enables you to configure model registration fields, including options for model risk tiers, model use cases, and documentation templates. +{{< var vm.product >}} enables you to configure model registration fields, including options for model risk tiers, model use cases, and documentation templates. You can modify these fields as needed and on an ongoing basis: [Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd) ## Can we leverage content from historical documentations?  -ValidMind is in the process of developing features that allow you to benefit from content in historical documentation by: +{{< var vm.product >}} is in the process of developing features that allow you to benefit from content in historical documentation by: - Allowing users to select definitions and specific documentation artifacts from previous model documentation for particular model use cases - Offering users AI-generated content suggestions for specific areas of the documentation (e.g., qualitative sections) based on high-quality historical documentation @@ -32,15 +32,15 @@ These features are currently on the roadmap and under research, no release sched ## Can we customize illustrations? -ValidMind utilizes open-source libraries (such as Seaborn and Matplotlib) to generate plots and illustrations. We are working on implementing the ability for model developers to customize styling parameters for these libraries directly within the {{< var vm.developer >}}. +{{< var vm.product >}} utilizes open-source libraries (such as Seaborn and Matplotlib) to generate plots and illustrations. We are working on implementing the ability for model developers to customize styling parameters for these libraries directly within the {{< var vm.developer >}}. This feature is currently scheduled for Q4 2023. -Additionally, ValidMind is developing a feature that enables developers to create custom visualization widgets by writing JavaScript-based rendering code. +Additionally, {{< var vm.product >}} is developing a feature that enables developers to create custom visualization widgets by writing JavaScript-based rendering code. -## Can ValidMind manage complex model hierarchies or use cases with multiple models? +## Can {{< var vm.product >}} manage complex model hierarchies or use cases with multiple models? -ValidMind is enhancing support for complex or modular models in two ways: +{{< var vm.product >}} is enhancing support for complex or modular models in two ways: - By adding parent/sub-model relational attributes to the model inventory. This is a roadmap item currently scheduled for Q2’2023. - By enabling tests to run on multiple models simultaneously and aggregating the results. This is a roadmap item currently scheduled for Q3’2023. diff --git a/site/faq/faq-privacy.qmd b/site/faq/faq-privacy.qmd index b9042d78b1..cdfd5e3840 100644 --- a/site/faq/faq-privacy.qmd +++ b/site/faq/faq-privacy.qmd @@ -7,28 +7,28 @@ aliases: - ../guide/faq-data-handling.html --- -## How are users added to ValidMind? +## How are users added to {{< var vm.product >}}? -ValidMind provides a built-in user management interface that allows new users to be registered on the platform and assigned user roles. User roles and access permissions are configured during initial onboarding. In addition, ValidMind also provides support for Single Sign-On (SSO) integration as part of our Enterprise and our {{< var validmind.vpv >}} (VPV) edition. +{{< var vm.product >}} provides a built-in user management interface that allows new users to be registered on the {{< var validmind.platform >}} and assigned user roles. User roles and access permissions are configured during initial onboarding. In addition, {{< var vm.product >}} also provides support for Single Sign-On (SSO) integration as part of our Enterprise and our {{< var validmind.vpv >}} (VPV) edition. -## How does ValidMind handle end-user computing and spreadsheet models? +## How does {{< var vm.product >}} handle end-user computing and spreadsheet models? -Customers can register spreadsheet models in the model inventory and centralize tracking of the associated documentation files with the inventory metadata (roadmap item – Q3’2023). However, ValidMind cannot automate documentation generation for spreadsheet models. +Customers can register spreadsheet models in the model inventory and centralize tracking of the associated documentation files with the inventory metadata (roadmap item – Q3’2023). However, {{< var vm.product >}} cannot automate documentation generation for spreadsheet models. ## What model artifacts are automatically imported into documentation and how are they retained? -ValidMind stores the following artifacts in the documentation via our API: +{{< var vm.product >}} stores the following artifacts in the documentation via our {{< var validmind.api >}}: -- Dataset and model metadata which allow generating documentation snippets programmatically (example: stored definition for "common logistic regression limitations" when a logistic regression model has been passed to the ValidMind test suite execution) +- Dataset and model metadata which allow generating documentation snippets programmatically (example: stored definition for "common logistic regression limitations" when a logistic regression model has been passed to the {{< var vm.product >}} test suite execution) - Quality and performance metrics collected from the dataset and model - Outputs from executed test suites - Images, plots, and visuals generated as part of extracting metrics and running tests -ValidMind is a multi-tenant or single-tenant solution hosted on cloud providers.[^1] With multi-tenant deployments, infrastructure is shared but with strict data isolation protocols that ensure that no tenant can access another's sensitive information. For organizations requiring the highest degree of data security, ValidMind offers a {{< var validmind.vpv >}} (VPV) option to host the solution in a dedicated single-tenant cloud instance on the ValidMind cloud account. Furthermore, ValidMind's data retention policy complies with the SOC 2 security standard. +{{< var vm.product >}} is a multi-tenant or single-tenant solution hosted on cloud providers.[^1] With multi-tenant deployments, infrastructure is shared but with strict data isolation protocols that ensure that no tenant can access another's sensitive information. For organizations requiring the highest degree of data security, {{< var vm.product >}} offers a {{< var validmind.vpv >}} (VPV) option to host the solution in a dedicated single-tenant cloud instance on the {{< var vm.product >}} cloud account. Furthermore, {{< var vm.product >}}'s data retention policy complies with the SOC 2 security standard. -## How does ValidMind handle large datasets? What about the confidentiality of data sent to ValidMind? +## How does {{< var vm.product >}} handle large datasets? What about the confidentiality of data sent to {{< var vm.product >}}? -ValidMind does not send datasets outside the client's environment. The {{< var vm.developer >}} executes test suites and functions locally in your environment and is not limited by dataset size. +{{< var vm.product >}} does not send datasets outside the client's environment. The {{< var vm.developer >}} executes test suites and functions locally in your environment and is not limited by dataset size. ::: {.callout} For more information, refer to our [data privacy policy](/about/fine-print/data-privacy-policy.qmd). @@ -36,13 +36,13 @@ For more information, refer to our [data privacy policy](/about/fine-print/data- ## What solutions do you offer and how do you handle privacy? -ValidMind is a {{< var vm.developer >}} and cloud platform available in multiple editions catering to different organizational needs: +{{< var vm.product >}} is a {{< var vm.developer >}} and cloud {{< var vm.platform >}} available in multiple editions catering to different organizational needs: - **Standard Edition**: Our introductory offering, providing essential features and services. - **Enterprise Edition**: Builds upon the Standard Edition by adding features tailored for large-scale organizations. -- **{{< var validmind.vpv >}} (VPV)**: Our most secure offering for organizations requiring a higher level of privacy, such as financial services handling sensitive data. Includes all Enterprise Edition features but in a separate, isolated ValidMind environment. VPV accounts do not share resources with accounts outside the VPV. +- **{{< var validmind.vpv >}} (VPV)**: Our most secure offering for organizations requiring a higher level of privacy, such as financial services handling sensitive data. Includes all Enterprise Edition features but in a separate, isolated {{< var vm.product >}} environment. VPV accounts do not share resources with accounts outside the VPV. -Access to any edition is facilitated through AWS PrivateLink, which provides private connectivity between ValidMind and your on-premises networks without exposing your traffic to the public internet. To learn more, check [Configure AWS PrivateLink](/guide/configuration/configure-aws-privatelink.qmd). ValidMind does not send any personally identifiable information (PII) through our API. +Access to any edition is facilitated through AWS PrivateLink, which provides private connectivity between {{< var vm.product >}} and your on-premises networks without exposing your traffic to the public internet. To learn more, check [Configure AWS PrivateLink](/guide/configuration/configure-aws-privatelink.qmd). {{< var vm.product >}} does not send any personally identifiable information (PII) through our {{< var vm.api >}}. ## Can the tool automatically document other non-standard ETL steps or performance metrics from notebooks? @@ -50,11 +50,11 @@ Support for more complex data processing pipelines is on our roadmap, currently ## How does the tool manage model changes? -ValidMind allows model developers to re-run documentation functions with the {{< var vm.developer >}} to capture changes in the model, such as changes in the number of features or hyperparameters. +{{< var vm.product >}} allows model developers to re-run documentation functions with the {{< var vm.developer >}} to capture changes in the model, such as changes in the number of features or hyperparameters. -After a model developer has made a change in their development environment, such as to a Jupyter Notebook, they can execute the relevant ValidMind documentation function to update the corresponding documentation section. ValidMind will then automatically recreate the relevant figures and tables and update them in the online documentation. +After a model developer has made a change in their development environment, such as to a Jupyter Notebook, they can execute the relevant {{< var vm.product >}} documentation function to update the corresponding documentation section. {{< var vm.product >}} will then automatically recreate the relevant figures and tables and update them in the online documentation. -ValidMind is currently working on a version history function, which will allow users to see the history of changes made to the documentation. +{{< var vm.product >}} is currently working on a version history function, which will allow users to see the history of changes made to the documentation. ## Can you accommodate Spark DataFrames? diff --git a/site/faq/faq-testing.qmd b/site/faq/faq-testing.qmd index 90dae7e6dd..5c2dd36d74 100644 --- a/site/faq/faq-testing.qmd +++ b/site/faq/faq-testing.qmd @@ -5,25 +5,25 @@ aliases: - ../guide/faq-testing.html --- -## How did ValidMind develop the tests that are currently in the library? +## How did {{< var vm.product >}} develop the tests that are currently in the library? All the existing tests were developed using open-source Python and R libraries. -The {{< var vm.developer >}} test interface is a light wrapper that defines some utility functions to interact with different dataset and model backends in an agnostic way, and other functions to collect and post results to the ValidMind backend using a generic results schema. +The {{< var vm.developer >}} test interface is a light wrapper that defines some utility functions to interact with different dataset and model backends in an agnostic way, and other functions to collect and post results to the {{< var vm.product >}} backend using a generic results schema. ## Can tests be configured or customized, and can we add our own tests? -ValidMind allows tests to be configured at several levels: +{{< var vm.product >}} allows tests to be configured at several levels: - Administrators can configure which tests are required to run programmatically depending on the model use case - You can change the thresholds and parameters for tests already available in the {{< var vm.developer >}} (for instance, changing the threshold parameter for class imbalance flag). -- In addition, ValidMind is implementing a feature that allows you to add your own tests to the {{< var vm.developer >}}. You will also be able to connect your own custom tests with the {{< var vm.developer >}}. These custom tests will be configurable and able to run programmatically, just like the rest of the {{< var vm.developer >}} libraries (roadmap item – Q3’2023). +- In addition, {{< var vm.product >}} is implementing a feature that allows you to add your own tests to the {{< var vm.developer >}}. You will also be able to connect your own custom tests with the {{< var vm.developer >}}. These custom tests will be configurable and able to run programmatically, just like the rest of the {{< var vm.developer >}} libraries (roadmap item – Q3’2023). ## Do you include explainability-related testing and documentation? Our {{< var vm.developer >}} currently includes test kits to test and document global explainability features of the model, specifically, permutation feature importance and Shapley values. -In addition, ValidMind is implementing standard documentation via the {{< var vm.developer >}} for the following items and modeling techniques: +In addition, {{< var vm.product >}} is implementing standard documentation via the {{< var vm.developer >}} for the following items and modeling techniques: - Conceptual soundness - Model use case description (Q2’2023) @@ -53,9 +53,9 @@ In addition, ValidMind is implementing standard documentation via the {{< var vm - Deep learning (2024) - Computer vision (2024) -## Is there a use case for synthetic data on the platform? +## Is there a use case for synthetic data within {{< var vm.product >}}? -ValidMind's {{< var vm.developer >}} supports you bringing your own datasets, including synthetic datasets, for testing and benchmarking purposes, such as for fair lending and bias testing. +The {{< var validmind.developer >}} supports you bringing your own datasets, including synthetic datasets, for testing and benchmarking purposes, such as for fair lending and bias testing. We are happy to discuss exploring specific use cases for synthetic data generation with you further. diff --git a/site/faq/faq-workflows.qmd b/site/faq/faq-workflows.qmd index acd6379691..793dbc58e4 100644 --- a/site/faq/faq-workflows.qmd +++ b/site/faq/faq-workflows.qmd @@ -7,36 +7,33 @@ aliases: ### How are parallel editing and version control handled? -ValidMind currently allows multiple users to simultaneously edit documentation in the {{< var validmind.platform >}}. If two users are editing the same cell on the UI, the most recently saved version of the content will prevail. +{{< var vm.product >}} currently allows multiple users to simultaneously edit documentation in the {{< var validmind.platform >}}. If two users are editing the same cell on the UI, the most recently saved version of the content will prevail. -ValidMind is implementing more sophisticated version control features: +{{< var vm.product >}} is implementing more sophisticated version control features: -- ValidMind will provide a detailed version and revision history, and notification system, for you to view what changes have been applied to the documentation (roadmap item for Q2’2023). -- The platform will provide an indication if another user is currently editing the same cell on the online UI (roadmap item for Q3’2023). +- {{< var vm.product >}} will provide a detailed version and revision history, and notification system, for you to view what changes have been applied to the documentation (roadmap item for Q2’2023). +- The {{< var vm.platform >}} will provide an indication if another user is currently editing the same cell on the online UI (roadmap item for Q3’2023). - Administrators will be given the ability to configure content syncing and session management preferences (roadmap item currently scheduled for Q4’2023). ### Can we work with disconnected workflows? -ValidMind supports disconnected workflows natively at the data-collection level since the {{< var vm.developer >}} creates individual test runs every time a new test iteration is executed. This allows for running parallel/disconnected tests that individually send results to the ValidMind API. +{{< var vm.product >}} supports disconnected workflows natively at the data-collection level since the {{< var validmind.developer >}} creates individual test runs every time a new test iteration is executed. This allows for running parallel/disconnected tests that individually send results to the {{< var validmind.platform >}}. Visualizing the disconnected workflow in terms of model testing and documentation will depend on requirements at the use-case level. ### Can the workflow accommodate an additional review step, before the documentation gets sent to the 2nd line model validation team? -With ValidMind, administrators can create custom workflows for the review and approval of models throughout their lifecycles. +With {{< var vm.product >}}, administrators can create custom workflows for the review and approval of models throughout their lifecycles. These workflows can be configured to include any number of review stages before submission, and administrators can configure which stakeholders will be involved at each stage. -ValidMind is also implementing the ability for administrators to configure default user roles and user groups or teams as part of initial onboarding onto the tool (roadmap item – Q2 2023). +{{< var vm.product >}} is also implementing the ability for administrators to configure default user roles and user groups or teams as part of initial onboarding onto the tool (roadmap item – Q2 2023). - -### How flexible is ValidMind to accommodate our own model development and review workflows? +### How flexible is {{< var vm.product >}} to accommodate our own model development and review workflows? -ValidMind allows administrators to create custom workflows for the review and approval of models based on your model risk management processes, once the user decides it is ready for review. +{{< var vm.product >}} allows administrators to create custom workflows for the review and approval of models based on your model risk management processes, once the user decides it is ready for review. These workflows can be configured to include any number of review stages before submission, and administrators can configure which stakeholders are involved at each stage. -You can also leverage ValidMind’s {{< var vm.developer >}} once you are ready to document a specific model for review and validation. That is, you do not need to use ValidMind while you are in the exploration or R&D phase of model development. +You can also leverage {{< var vm.product >}}’s {{< var vm.developer >}} once you are ready to document a specific model for review and validation. That is, you do not need to use {{< var vm.product >}} while you are in the exploration or R&D phase of model development. diff --git a/site/get-started/developer/try-in-your-own-environment.qmd b/site/get-started/developer/try-in-your-own-environment.qmd index c46cea4adb..43a5230f36 100644 --- a/site/get-started/developer/try-in-your-own-environment.qmd +++ b/site/get-started/developer/try-in-your-own-environment.qmd @@ -6,15 +6,16 @@ aliases: - ../../guide/quickstart-try-developer-framework-in-your-own-developer-environment.html --- -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. +Learn how to document a model with {{< var vm.product >}} locally in your own developer environment. You can either clone our open-source repository or download the code samples to run the notebook. ::: {.attn} ## {{< fa star-of-life >}} Before you begin -To try out ValidMind, you need to be a registered user on the {{< var validmind.platform >}}. +To try out {{< var vm.product >}}, you need to be a registered user on the {{< var validmind.platform >}}. -::: {.callout title="Need an account for ValidMind?"} +::: {.callout} +## Need an account for {{< var vm.product >}}? Signing up is FREE — {{< var link.register >}} ::: @@ -43,7 +44,7 @@ Start by retrieving our notebook samples from GitHub, or download them from our 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](#run-the-notebook). - The notebook will guide you through installing the {{< var validmind.developer >}}, initializing the Python environment, and finally initializing the ValidMind Client Library by connecting to the {{< var validmind.platform >}}. + The notebook will guide you through installing the {{< var validmind.developer >}}, initializing the Python environment, and finally connecting the {{< var vm.developer >}} to the {{< var validmind.platform >}}. #### Option 2: Download the code samples @@ -57,20 +58,20 @@ Start by retrieving our notebook samples from GitHub, or download them from our 4. Open `notebooks/code_samples/quickstart_customer_churn_full_suite.ipynb` in your developer environment and [run the notebook](#run-the-notebook). - The notebook will guide you through installing the {{< var validmind.developer >}}, initializing the Python environment, and finally initializing the ValidMind Client Library by connecting to the {{< var validmind.platform >}}. + The notebook will guide you through installing the {{< var validmind.developer >}}, initializing the Python environment, and finally connecting the {{< var vm.developer >}} to the {{< var validmind.platform >}}. ### 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] +1. Follow the instructions to run the first two code cells in the notebook, which will set the stage by installing and initializing {{< var vm.product >}}:[^1] - Hover over each cell and click the {{< fa circle-play >}} **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: +2. Under the cell at bottom of the **Initialize the ValidMind Library** section, confirm that you see a success message that looks something like this: ```bash - 2024-10-08 22:06:42,610 - INFO(validmind.api_client): 🎉 Connected to ValidMind! + 2024-10-08 22:06:42,610 - INFO(validmind.api_client): 🎉 Connected to {{< var vm.product >}}! 📊 Model: [Demo] Customer Churn Model (ID: clwqy70qd01my22ikc49paar9) 📁 Document Type: model_documentation ``` @@ -81,9 +82,9 @@ You can now continue running the rest of the cells if you want to see how the de ## What's next -Continue with [Explore sample model documentation](/get-started/platform/explore-sample-model-documentation.qmd) to learn more about using the {{< var validmind.product >}} hands-on. +Continue with [Explore sample model documentation](/get-started/platform/explore-sample-model-documentation.qmd) to learn more about using the {{< var validmind.platform >}} hands-on. -[^1]: [Install and initialize the client library](/developer/model-documentation/install-and-initialize-client-library.qmd) +[^1]: [Install and initialize the {{< var validmind.developer >}}](/developer/model-documentation/install-and-initialize-validmind-library.qmd) diff --git a/site/get-started/developer/try-with-colab.qmd b/site/get-started/developer/try-with-colab.qmd index 1ba80b149e..c5b9a9bca9 100644 --- a/site/get-started/developer/try-with-colab.qmd +++ b/site/get-started/developer/try-with-colab.qmd @@ -6,23 +6,24 @@ aliases: - ../../guide/quickstart-try-developer-framework-with-colab.html --- -Learn how to document a model with ValidMind on Google Colaboratory. +Learn how to document a model with {{< var vm.product >}} on Google Colaboratory. ::: {.attn} ## {{< fa star-of-life >}} Before you begin -- [x] To try out ValidMind, you need to be a registered user on the {{< var validmind.platform >}}. +- [x] To try out {{< var vm.product >}}, you need to be a registered user on the {{< var validmind.platform >}}. - [x] You must have access to [Google Colaboratory (Colab)](https://colab.research.google.com/). -::: {.callout title="Need an account for ValidMind?"} +::: {.callout} +## Need an account for {{< var vm.product >}}? Signing up is FREE — {{< var link.register >}} ::: Google Colaboratory (Colab) is a free Jupyter Notebook environment that runs in the cloud. You can work with, run, and download our sample Jupyter Notebooks from there. #### About our Jupyter Notebooks -- **Notebooks from ValidMind are safe to run** — If you get a warning that this notebook was not authored by Google, we welcome you to inspect the notebook source. +- **Notebooks from {{< var vm.product >}} are safe to run** — If you get a warning that this notebook was not authored by Google, we welcome you to inspect the notebook source. - **Runtime errors** — We recommend that you not use the *Run all* option. Run each cell individually to see what is happening in the notebook. If you do see errors, re-run the notebook cells. ::: @@ -33,18 +34,18 @@ Google Colaboratory (Colab) is a free Jupyter Notebook environment that runs in ![QuickStart notebook opened in Google Colab](google-colab.png){width=90% fig-alt="A screenshot showing the QuickStart notebook opened in Google Colab" .screenshot} - The notebook will guide you through installing the {{< var validmind.developer >}}, initializing the Python environment, and finally initializing the ValidMind Client Library by connecting to the {{< var validmind.platform >}}. + The notebook will guide you through installing the {{< var validmind.developer >}}, initializing the Python environment, and finally connecting the {{< var vm.developer >}} to the {{< var validmind.platform >}}. 2. Click **File** > **Save a copy in Drive** to make a copy of the QuickStart notebook so that you can modify it. Alternatively, you can download the notebook source and work with it in your own developer environment. -3. Follow the instructions to run the first two code cells in the notebook, which will set the stage by installing and initializing ValidMind.[^1] +3. Follow the instructions to run the first two code cells in the notebook, which will set the stage by installing and initializing {{< var vm.product >}}.[^1] - Under the cell at bottom of the **Initialize the client library** section, confirm that you see a success message that looks something like this: + Under the cell at bottom of the **Initialize the ValidMind Library** section, confirm that you see a success message that looks something like this: ```bash - 2024-10-08 22:06:42,610 - INFO(validmind.api_client): 🎉 Connected to ValidMind! + 2024-10-08 22:06:42,610 - INFO(validmind.api_client): 🎉 Connected to {{< var vm.product >}}! 📊 Model: [Demo] Customer Churn Model (ID: clwqy70qd01my22ikc49paar9) 📁 Document Type: model_documentation ``` @@ -56,10 +57,10 @@ You can now continue running the rest of the cells if you want to see how the de ## What's next -Continue with [Explore sample model documentation](/get-started/platform/explore-sample-model-documentation.qmd) to learn more about using the {{< var validmind.product >}} hands-on. +Continue with [Explore sample model documentation](/get-started/platform/explore-sample-model-documentation.qmd) to learn more about using the {{< var validmind.platform >}} hands-on. -[^1]: [Install and initialize the client library](/developer/model-documentation/install-and-initialize-client-library.qmd) +[^1]: [Install and initialize the {{< var validmind.developer >}}](/developer/model-documentation/install-and-initialize-validmind-library.qmd) diff --git a/site/get-started/developer/try-with-jupyterhub.qmd b/site/get-started/developer/try-with-jupyterhub.qmd index e9262fb1a7..c7b7bfd838 100644 --- a/site/get-started/developer/try-with-jupyterhub.qmd +++ b/site/get-started/developer/try-with-jupyterhub.qmd @@ -6,15 +6,16 @@ aliases: - ../../guide/quickstart-try-developer-framework-with-jupyterhub.html --- -Learn how to document a model with ValidMind on JupyterHub. +Learn how to document a model with {{< var vm.product >}} on JupyterHub. ::: {.attn} ## {{< fa star-of-life >}} Before you begin -To try out ValidMind, you need to be a registered user on the {{< var validmind.platform >}}. +To try out {{< var vm.product >}}, you need to be a registered user on the {{< var validmind.platform >}}. -::: {.callout title="Need an account for ValidMind?"} +::: {.callout} +## Need an account for {{< var vm.product >}}? Signing up is FREE — {{< var link.register >}} ::: @@ -24,21 +25,21 @@ Signing up is FREE — {{< var link.register >}} 1. In a web browser, open [Quickstart for model documentation](https://jupyterhub.validmind.ai/hub/user-redirect/lab/tree/quickstart_customer_churn_full_suite.ipynb). - 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: + This link takes you to {{< var vm.product >}}'s JupyterHub instance where you can log in with the Auth0 credentials for your {{< var vm.product >}} account to access the **QuickStart for model documentation** notebook: ![QuickStart notebook opened in JupyterHub](jupyterhub-dashboard.png){width=90% fig-alt="A screenshot showing the QuickStart notebook opened in JupyterHub" .screenshot} - The notebook will guide you through installing the {{< var validmind.developer >}}, initializing the Python environment, and finally initializing the ValidMind Client Library by connecting to the {{< var validmind.platform >}}. + The notebook will guide you through installing the {{< var validmind.developer >}}, initializing the Python environment, and finally connecting the {{< var vm.developer >}} to the {{< var validmind.platform >}}. -2. Follow the instructions to run the first two code cells in the notebook, which will set the stage by installing and initializing ValidMind:[^1] +2. Follow the instructions to run the first two code cells in the notebook, which will set the stage by installing and initializing {{< var vm.product >}}:[^1] - Hover over each cell and click the {{< fa circle-play >}} **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: + Under the cell at bottom of the **Initialize the ValidMind Library** section, confirm that you see a success message that looks something like this: ```bash - 2024-10-08 22:06:42,610 - INFO(validmind.api_client): 🎉 Connected to ValidMind! + 2024-10-08 22:06:42,610 - INFO(validmind.api_client): 🎉 Connected to {{< var vm.product >}}! 📊 Model: [Demo] Customer Churn Model (ID: clwqy70qd01my22ikc49paar9) 📁 Document Type: model_documentation ``` @@ -57,9 +58,9 @@ Need more help? Experience this guide in video format: ## What's next -Continue with [Explore sample model documentation](/get-started/platform/explore-sample-model-documentation.qmd) to learn more about using the {{< var validmind.product >}} hands-on. +Continue with [Explore sample model documentation](/get-started/platform/explore-sample-model-documentation.qmd) to learn more about using the {{< var validmind.platform >}} hands-on. -[^1]: [Install and initialize the client library](/developer/model-documentation/install-and-initialize-client-library.qmd) \ No newline at end of file +[^1]: [Install and initialize the {{< var validmind.developer >}}](/developer/model-documentation/install-and-initialize-validmind-library.qmd) \ No newline at end of file diff --git a/site/get-started/get-started.qmd b/site/get-started/get-started.qmd index 45d4656e04..d6b10bf94c 100644 --- a/site/get-started/get-started.qmd +++ b/site/get-started/get-started.qmd @@ -13,28 +13,28 @@ listing: contents: - path: quickstart.qmd title: "QuickStart" - description: "The fastest way to explore what ValidMind can offer is with our QuickStart — Try out the {{< var validmind.developer >}} and explore the {{< var validmind.platform >}}." + description: "The fastest way to explore what {{< var vm.product >}} can offer is with our QuickStart — Try out the {{< var validmind.developer >}} and explore the {{< var validmind.platform >}}." - path: platform/next-steps.qmd title: "Next steps" description: "If you have already tried the QuickStart, more how-to instructions and links to our FAQs can be found under our next steps." fields: [title, description, reading-time] --- -ValidMind is a platform designed to streamline the management of risk for AI models, including those used in machine learning (ML), natural language processing (NLP), and large language models (LLMs). ValidMind offers tools that cater to both model developers and validators, simplifying key aspects of model risk management. +{{< var vm.product >}} is designed to streamline the management of risk for AI models, including those used in machine learning (ML), natural language processing (NLP), and large language models (LLMs). {{< var vm.product >}} offers tools that cater to both model developers and validators, simplifying key aspects of model risk management. -## What do I use the ValidMind platform for? +## What do I use {{< var vm.product >}} for? Model developers and validators play important roles in managing model risk, including risk that stems from generative AI and machine learning models. From complying with regulations to ensuring that institutional standards are followed, your team members are tasked with the careful documentation, testing, and independent validation of models. -The purpose of these efforts is to ensure that good risk management principles are followed throughout the model lifecycle. To assist you with these processes of documenting and validating models, ValidMind provides a number of tools that you can employ regardless of the technology used to build your models. +The purpose of these efforts is to ensure that good risk management principles are followed throughout the model lifecycle. To assist you with these processes of documenting and validating models, {{< var vm.product >}} provides a number of tools that you can employ regardless of the technology used to build your models. -![The two main components of ValidMind. The developer framework that integrates with your existing developer environment, and the ValidMind Platform UI.](validmind-lifecycle.jpg){width=70% fig-alt="An image showing the two main components of ValidMind. The developer framework that integrates with your existing developer environment, and the ValidMind Platform UI."} +![The two main components of {{< var vm.product >}}. The {{< var validmind.developer >}} that integrates with your existing developer environment, and the {{< var validmind.platform >}}.](validmind-lifecycle.jpg){width=70% fig-alt="An image showing the two main components of ValidMind. The ValidMind Library that integrates with your existing developer environment, and the ValidMind Platform."} The {{< var validmind.product >}} provides two main product components: -1. The **{{< var validmind.developer >}}** is a library of tools and methods designed to automate generating model documentation and running validation tests. The {{< var vm.developer >}} is designed to be platform agnostic and integrates with your existing development environment. +1. The **{{< var validmind.developer >}}** is a Python library of tools and methods designed to automate generating model documentation and running validation tests. The {{< var vm.developer >}} is designed to be platform agnostic and integrates with your existing development environment. For Python developers, a single installation command provides access to all the functions: @@ -42,26 +42,24 @@ The {{< var validmind.product >}} provides two main product components: %pip install validmind ``` -2. The **{{< var validmind.platform >}}** is an easy-to-use web-based UI that enables you to track the model lifecycle: +2. The **{{< var validmind.platform >}}** is an easy-to-use web-based interface that enables you to track the model lifecycle: - Customize workflows to adhere to and oversee your model risk management process. - Review and edit the documentation and test metrics generated by the {{< var vm.developer >}}. - Collaborate with and capture feedback from model developers and model validators. - Generate validation reports and approvals. -For more information about the benefits that ValidMind can offer, **check out the [ValidMind overview](/about/overview.qmd).** +For more information about the benefits that {{< var vm.product >}} can offer, **check out the [{{< var vm.product >}} overview](/about/overview.qmd).** ::: {.callout-important collapse="false" appearance="minimal"} -## {{< fa building-columns >}} Key ValidMind concepts - - +## {{< fa building-columns >}} Key {{< var vm.product >}} concepts {{< include /about/glossary/key_concepts/_key-concepts.qmd >}} ::: ## How do I get started? -On the ValidMind platform, everything starts with the model inventory — you first register a new model and then manage the model lifecycle through the different activities that are part of your existing model risk management processes. +On the {{< var validmind.platform >}}, everything starts with the model inventory — you first register a new model and then manage the model lifecycle through the different activities that are part of your existing model risk management processes. ### Approval workflow @@ -98,7 +96,8 @@ Periodic review and revalidation :::{#next-steps} ::: -::: {.callout title="Need an account for ValidMind?"} +::: {.callout} +## Need an account for {{< var vm.product >}}? Signing up is FREE — {{< var link.register >}} ::: diff --git a/site/get-started/platform/explore-sample-model-documentation.qmd b/site/get-started/platform/explore-sample-model-documentation.qmd index 3349b68cdd..8e3dea35b7 100644 --- a/site/get-started/platform/explore-sample-model-documentation.qmd +++ b/site/get-started/platform/explore-sample-model-documentation.qmd @@ -6,11 +6,11 @@ aliases: - ../../guide/quickstart-explore-sample-model-documentation.html --- -First, let's take a look at how the ValidMind handles model documentation. The best place to start is with the {{< var validmind.platform >}}. +First, let's take a look at how the {{< var vm.product >}} handles model documentation. The best place to start is with the {{< var validmind.platform >}}. -![ValidMind Platform UI main dashboard](platform-dashboard.png){width=90% fig-alt="A screenshot showing the ValidMind Platform UI main dashboard" .screenshot} +![{{< var validmind.platform >}} main dashboard](platform-dashboard.png){width=90% fig-alt="A screenshot showing the ValidMind Platform main dashboard" .screenshot} The {{< var validmind.platform >}} is the central place to: @@ -22,10 +22,11 @@ The {{< var validmind.platform >}} is the central place to: ## {{< fa star-of-life >}} Before you begin -- [x] To try out ValidMind, you need to be a registered user on the {{< var validmind.platform >}}. -- [x] Next, make sure you're [logged in to ValidMind {{< fa hand-point-right >}}](/guide/configuration/log-in-to-validmind.qmd). +- [x] To try out {{< var vm.product >}}, you need to be a registered user on the {{< var validmind.platform >}}. +- [x] Next, make sure you're [logged in to {{< var vm.product >}} {{< fa hand-point-right >}}](/guide/configuration/log-in-to-validmind.qmd). -::: {.callout title="Need an account for ValidMind?"} +::: {.callout} +## Need an account for {{< var vm.product >}}? Signing up is FREE — {{< var link.register >}} ::: @@ -68,7 +69,7 @@ This is the status that a model starts in as part of the default workflow, as de - ![Data description page in the platform UI within a model's documentation](data-description.png){width=90% fig-align="left" fig-alt="A screenshot showing the data description page in the platform UI within a model's documentation" .screenshot} + ![Data description page in the {{< var validmind.platform >}} within a model's documentation](data-description.png){width=90% fig-align="left" fig-alt="A screenshot showing the data description page in the ValidMind Platform within a model's documentation" .screenshot} - This content is generated by the {{< var validmind.developer >}} and provides information about the dataset used, including histograms, information about dataset quality, and test results. - Sections that need your attention get flagged with `Requires Attention`. These sections get flagged automatically whenever a test result is above or below a certain threshold. @@ -80,7 +81,7 @@ This is the status that a model starts in as part of the default workflow, as de - **Model Explainability and Interpretability** - **Model Diagnosis** - a. If you expand the **ValidMind Insights™** right sidebar, the Documentation Guidelines[^11] can tell you more about what these sections mean and help you with the task of documenting the model as a developer. + a. If you expand the **{{< var vm.product >}} Insights™** right sidebar, the Documentation Guidelines[^11] can tell you more about what these sections mean and help you with the task of documenting the model as a developer. b. If you are a validator, this is also where you can add findings associated with a documentation section.[^12] 8. Finally, take a look at section **4. Monitoring and Governance**. @@ -89,7 +90,7 @@ This is the status that a model starts in as part of the default workflow, as de ## What's next -Continue with [Register your first model](register-your-first-model.qmd) to learn more about using the ValidMind Platform UI hands-on. +Continue with [Register your first model](register-your-first-model.qmd) to learn more about using the {{< var validmind.platform >}} hands-on. @@ -107,7 +108,7 @@ Continue with [Register your first model](register-your-first-model.qmd) to lear [^7]: [View model activity](/guide/model-inventory/view-model-activity.qmd) -[^8]: [Get started with the {{< var validmind.developer >}}](/developer/get-started-developer-framework.qmd) +[^8]: [Get started with the {{< var validmind.developer >}}](/developer/get-started-validmind-library.qmd) [^9]: [Working with documentation templates](/guide/model-documentation/working-with-documentation-templates.qmd) diff --git a/site/get-started/platform/generate-documentation-for-your-model.qmd b/site/get-started/platform/generate-documentation-for-your-model.qmd index 8083afb924..d5b8c61470 100644 --- a/site/get-started/platform/generate-documentation-for-your-model.qmd +++ b/site/get-started/platform/generate-documentation-for-your-model.qmd @@ -12,10 +12,11 @@ You are now ready to modify the QuickStart notebook you used earlier and run it ## {{< fa star-of-life >}} Before you begin -- [x] To try out ValidMind, you need to be a registered user on the {{< var validmind.platform >}}. -- [x] Next, make sure you're [logged in to ValidMind {{< fa hand-point-right >}}](/guide/configuration/log-in-to-validmind.qmd). +- [x] To try out {{< var vm.product >}}, you need to be a registered user on the {{< var validmind.platform >}}. +- [x] Next, make sure you're [logged in to {{< var vm.product >}} {{< fa hand-point-right >}}](/guide/configuration/log-in-to-validmind.qmd). -::: {.callout title="Need an account for ValidMind?"} +::: {.callout} +## Need an account for {{< var vm.product >}}? Signing up is FREE — {{< var link.register >}} ::: @@ -29,7 +30,7 @@ Signing up is FREE — {{< var link.register >}} The page that opens provides you with a _code snippet_ to use with the {{< var validmind.developer >}}, including: - - `api_host`: The location of the ValidMind API + - `api_host`: The location of the {{< var vm.product >}} API - `api_key`: The account API key - `api_secret`: The account secret key - `model`: The model identifier @@ -53,13 +54,13 @@ Signing up is FREE — {{< var link.register >}} - Hover over each cell and click the {{< fa circle-play >}} **icon**; OR - Press `Shift + Enter` on Windows or `Cmd + Enter` if you are on a Mac - The notebook will guide you through installing the {{< var validmind.developer >}}, initializing the Python environment, and finally initializing the ValidMind Client Library by connecting to the {{< var validmind.platform >}}. + The notebook will guide you through installing the {{< var validmind.developer >}}, initializing the Python environment, and finally connecting the {{< var vm.developer >}} to the {{< var validmind.platform >}}. ## What's next You can now [switch back to the {{< var vm.platform >}}](/guide/configuration/log-in-to-validmind.qmd) to view the documentation that has been generated by the {{< var vm.developer >}}. -Ready to learn more about how you can use ValidMind? Check out [Next Steps](next-steps.qmd). +Ready to learn more about how you can use {{< var vm.product >}}? Check out [Next Steps](next-steps.qmd). diff --git a/site/get-started/platform/next-steps.qmd b/site/get-started/platform/next-steps.qmd index 81b8e95fd3..c25b23daa7 100644 --- a/site/get-started/platform/next-steps.qmd +++ b/site/get-started/platform/next-steps.qmd @@ -19,7 +19,7 @@ listing: sort: false fields: [title, description] contents: - - ../../developer/get-started-developer-framework.qmd + - ../../developer/get-started-validmind-library.qmd - ../../developer/samples-jupyter-notebooks.qmd - ../../guide/guides.qmd - id: next-validators @@ -42,7 +42,7 @@ listing: - ../../guide/configuration/personalize-validmind.qmd --- -Ready to use ValidMind for production with your own use cases? Our documentation includes how-to instructions for the following user roles: +Ready to use {{< var vm.product >}} for production with your own use cases? Our documentation includes how-to instructions for the following user roles: - [Platform administrators](#platform-administrators) - [Model developers](#model-developers) @@ -51,14 +51,14 @@ Ready to use ValidMind for production with your own use cases? Our documentation ### Platform administrators -Learn how to configure the {{< var validmind.product >}}, from onboarding new users to setting up connectivity via AWS PrivateLink, to customizing the {{< var vm.platform >}} to suit your existing workflows, and more: +Learn how to configure the {{< var validmind.platform >}}, from onboarding new users to setting up connectivity via AWS PrivateLink, to customizing the {{< var vm.platform >}} to suit your existing workflows, and more: :::{#next-admin} ::: ### Model developers -Find information for ValidMind tests and test suites, additional Jupyter Notebooks, the {{< var validmind.developer >}} reference, and how to use the ValidMind platform: +Find information for {{< var vm.product >}} tests and test suites, additional Jupyter Notebooks, the {{< var validmind.developer >}} reference, and how to use the {{< var validmind.platform >}}: :::{#next-developers} ::: @@ -73,7 +73,7 @@ Learn how to step through the approval process after review and generate validat ### All users -Learn how to collaborate on documentation, and customize ValidMind to fit your needs: +Learn how to collaborate on documentation, and customize {{< var vm.product >}} to fit your needs: :::{#next-all} ::: diff --git a/site/get-started/platform/register-your-first-model.qmd b/site/get-started/platform/register-your-first-model.qmd index 574041cb52..ce495e3f1d 100644 --- a/site/get-started/platform/register-your-first-model.qmd +++ b/site/get-started/platform/register-your-first-model.qmd @@ -12,10 +12,11 @@ To be able to document models with the {{< var validmind.platform >}}, you need ## {{< fa star-of-life >}} Before you begin -- [x] To try out ValidMind, you need to be a registered user on the {{< var validmind.platform >}}. -- [x] Next, make sure you're [logged in to ValidMind {{< fa hand-point-right >}}](/guide/configuration/log-in-to-validmind.qmd). +- [x] To try out {{< var vm.product >}}, you need to be a registered user on the {{< var validmind.platform >}}. +- [x] Next, make sure you're [logged in to {{< var vm.product >}} {{< fa hand-point-right >}}](/guide/configuration/log-in-to-validmind.qmd). -::: {.callout title="Need an account for ValidMind?"} +::: {.callout} +## Need an account for {{< var vm.product >}}? Signing up is FREE — {{< var link.register >}} ::: diff --git a/site/get-started/quickstart.qmd b/site/get-started/quickstart.qmd index bd80208f51..91b37a21aa 100644 --- a/site/get-started/quickstart.qmd +++ b/site/get-started/quickstart.qmd @@ -5,15 +5,16 @@ aliases: - ../guide/quickstart.html --- -The easiest way to get started with ValidMind is to try out our {{< var vm.developer >}} in JupyterHub and to explore the {{< var validmind.platform >}} online. +The easiest way to get started with {{< var vm.product >}} is to try out our {{< var vm.developer >}} in JupyterHub and to explore the {{< var validmind.platform >}} online. ::: {.attn} ## {{< fa star-of-life >}} Before you begin -To try out ValidMind, you need to be a registered user on the {{< var validmind.platform >}}. +To try out {{< var vm.product >}}, you need to be a registered user on the {{< var validmind.platform >}}. -::: {.callout title="Need an account for ValidMind?"} +::: {.callout} +## Need an account for {{< var vm.product >}}? Signing up is FREE — {{< var link.register >}} ::: @@ -52,9 +53,9 @@ If necessary, ask a network administrator to add these domains to your firewall ### What's next -If you're ready to do more with ValidMind, check out [Next steps](platform/next-steps.qmd). +If you're ready to do more with {{< var vm.product >}}, check out [Next steps](platform/next-steps.qmd). -[^1]: For additional help setting up a VPN or PrivateLink with the {{< var validmind.product >}} please visit [configure AWS PrivateLink](/guide/configuration/configure-aws-privatelink.qmd) or send an email to . +[^1]: For additional help setting up a VPN or PrivateLink with {{< var vm.product >}} please visit [configure AWS PrivateLink](/guide/configuration/configure-aws-privatelink.qmd) or send an email to . diff --git a/site/get-started/validmind-lifecycle.jpg b/site/get-started/validmind-lifecycle.jpg index 77794c7a86..02e38a6e4a 100644 Binary files a/site/get-started/validmind-lifecycle.jpg and b/site/get-started/validmind-lifecycle.jpg differ diff --git a/site/guide/configuration/accessing-validmind.qmd b/site/guide/configuration/accessing-validmind.qmd index d034576cd3..744e1ec837 100644 --- a/site/guide/configuration/accessing-validmind.qmd +++ b/site/guide/configuration/accessing-validmind.qmd @@ -1,5 +1,6 @@ --- -title: "Accessing Validmind" +# USING THE VARIABLE IN THE TITLE MESSES UP THE BREADCRUMB +title: "Accessing ValidMind" date: last-modified listing: - id: guides-access @@ -13,4 +14,4 @@ listing: - log-in-to-validmind.qmd --- -To use ValidMind to track your models and oversee your model management process, you'll need to first sign up and then log in to the {{< var vm.platform >}}. \ No newline at end of file +To use {{< var vm.product >}} to track your models and oversee your model management process, you'll need to first sign up and then log in to the {{< var vm.platform >}}. \ No newline at end of file diff --git a/site/guide/configuration/configure-aws-privatelink.qmd b/site/guide/configuration/configure-aws-privatelink.qmd index 223a53fd2b..af6ba64e9b 100644 --- a/site/guide/configuration/configure-aws-privatelink.qmd +++ b/site/guide/configuration/configure-aws-privatelink.qmd @@ -6,13 +6,13 @@ aliases: - ../configure-aws-privatelink.html --- -To keep your network traffic private and minimize its attack surface, configure AWS PrivateLink[^1] to establish a private connection between ValidMind and your company network. +To keep your network traffic private and minimize its attack surface, configure AWS PrivateLink[^1] to establish a private connection between {{< var vm.product >}} and your company network. -![AWS PrivateLink establishing a private connection to ValidMind](aws-privatelink.png){fig-alt="A graphic showing AWS PrivateLink establishing a private connection to ValidMind"} +![AWS PrivateLink establishing a private connection to {{< var vm.product >}}](aws-privatelink.png){fig-alt="A graphic showing AWS PrivateLink establishing a private connection to ValidMind"} -AWS PrivateLink is a networking service that allows secure and private communication between Amazon Virtual Private Cloud (VPC) resources and services hosted in other VPCs or in AWS partner services, such as ValidMind. With AWS PrivateLink, you can connect to services over the Amazon network, without needing to expose your network traffic to the public internet. +AWS PrivateLink is a networking service that allows secure and private communication between Amazon Virtual Private Cloud (VPC) resources and services hosted in other VPCs or in AWS partner services, such as {{< var vm.product >}}. With AWS PrivateLink, you can connect to services over the Amazon network, without needing to expose your network traffic to the public internet. -PrivateLink works by creating a private _VPC endpoint_ for a supported AWS service within your virtual private cloud. This endpoint acts as a proxy between your VPC and ValidMind, allowing traffic to be routed privately over the AWS network. To make the endpoint easier to use, ValidMind provides a _private DNS name_ that model developers and validators can connect to in a browser. +PrivateLink works by creating a private _VPC endpoint_ for a supported AWS service within your virtual private cloud. This endpoint acts as a proxy between your VPC and {{< var vm.product >}}, allowing traffic to be routed privately over the AWS network. To make the endpoint easier to use, {{< var vm.product >}} provides a _private DNS name_ that model developers and validators can connect to in a browser. ::: {.callout-important title="The responsibility of setting up a VPC endpoint for AWS PrivateLink falls to your IT department, such as the cloud engineering, infrastructure, or security teams."}
@@ -39,7 +39,7 @@ Recording: 46:00 FR InfoSec log in and set up endpoint > request pending, need t 56:00 FR InfoSec login 58:55 VM login to verify "Owner" 59:30 FR InfoSec login, verify the endpoint is available, enable private DNS names -1:03 FR Murat private DNS name is availabe, can log into the ValidMind UI +1:03 FR Murat private DNS name is available, can log into the ValidMind Platform ---> | Region | Service name | Private DNS name | @@ -55,7 +55,7 @@ Recording: 46:00 FR InfoSec log in and set up endpoint > request pending, need t ## Steps -1. Create a VPC endpoint for ValidMind: +1. Create a VPC endpoint for {{< var vm.product >}}: a. Log into the [AWS Console](https://aws.amazon.com/console/). b. In the VPC dashboard, click **Endpoints** in the navigation pane. @@ -69,12 +69,12 @@ Recording: 46:00 FR InfoSec log in and set up endpoint > request pending, need t The status for the endpoint should show `Pending`. -2. Contact ValidMind at [support@validmind.ai](mailto:support@validmind.ai?subject=VPC%20Endpoint%20Connection%20Request) to get your new VPC endpoint connection request accepted. Include the following information: +2. Contact {{< var vm.product >}} at [support@validmind.ai](mailto:support@validmind.ai?subject=VPC%20Endpoint%20Connection%20Request) to get your new VPC endpoint connection request accepted. Include the following information: - The owner or account ID - The VPC endpoint ID -3. After ValidMind has accepted your endpoint connection request, verify the endpoint is available: +3. After {{< var vm.product >}} has accepted your endpoint connection request, verify the endpoint is available: a. In the VPC console, go to the **Endpoints** section. b. Verify that status for the endpoint shows `Available`. @@ -87,14 +87,14 @@ Recording: 46:00 FR InfoSec log in and set up endpoint > request pending, need t 5. Test the connection: - a. From your company network, access ValidMind using the private DNS name from the [VPC service information](#vpc-service-information). - b. In a browser, confirm that you can successfully connect to ValidMind and log in. - c. From your developer environment, confirm that you can connect to ValidMind with the {{< var vm.developer >}}. + a. From your company network, access {{< var vm.product >}} using the private DNS name from the [VPC service information](#vpc-service-information). + b. In a browser, confirm that you can successfully connect to {{< var vm.product >}} and log in. + c. From your developer environment, confirm that you can connect to {{< var vm.product >}} with the {{< var vm.developer >}}. ## What's next -After completing these steps, users on your company network can connect to ValidMind via AWS PrivateLink using the private DNS name from the [VPC service information](#vpc-service-information). +After completing these steps, users on your company network can connect to {{< var vm.product >}} via AWS PrivateLink using the private DNS name from the [VPC service information](#vpc-service-information). diff --git a/site/guide/configuration/configure-azure-private-link.qmd b/site/guide/configuration/configure-azure-private-link.qmd index f15e046ba1..c74046e4b7 100644 --- a/site/guide/configuration/configure-azure-private-link.qmd +++ b/site/guide/configuration/configure-azure-private-link.qmd @@ -6,13 +6,13 @@ aliases: - ../configure-aws-privatelink.html --- -To keep your network traffic private and minimize its attack surface, configure Azure Private Link[^1] to establish a private connection between ValidMind and your company network. +To keep your network traffic private and minimize its attack surface, configure Azure Private Link[^1] to establish a private connection between {{< var vm.product >}} and your company network. -![Azure Private Link establishing a private connection to ValidMind](azure-private-link.png){fig-alt="A graphic showing Azure Private Link establishing a private connection to ValidMind"} +![Azure Private Link establishing a private connection to {{< var vm.product >}}](azure-private-link.png){fig-alt="A graphic showing Azure Private Link establishing a private connection to ValidMind"} -Azure Private Link is a networking service that allows secure and private communication between Azure Virtual Network (VNet) resources and services hosted in other VNets or in Azure partner services, such as ValidMind. With Azure Private Link, you can connect to services over the Azure network without exposing your network traffic to the public internet. +Azure Private Link is a networking service that allows secure and private communication between Azure Virtual Network (VNet) resources and services hosted in other VNets or in Azure partner services, such as {{< var vm.product >}}. With Azure Private Link, you can connect to services over the Azure network without exposing your network traffic to the public internet. -Private Link works by creating a _private endpoint_ for a supported Azure service within your virtual private cloud. This endpoint acts as a proxy between your VNet and ValidMind, allowing traffic to be routed privately over the Azure network. To make the endpoint easier to use, ValidMind provides a _private DNS name_ that model developers and validators can connect to in a browser. +Private Link works by creating a _private endpoint_ for a supported Azure service within your virtual private cloud. This endpoint acts as a proxy between your VNet and {{< var vm.product >}}, allowing traffic to be routed privately over the Azure network. To make the endpoint easier to use, {{< var vm.product >}} provides a _private DNS name_ that model developers and validators can connect to in a browser. ::: {.callout-important title="The responsibility of setting up a private endpoint for Azure Private Link falls to your IT department, such as the cloud engineering, infrastructure, or security teams."}
@@ -54,12 +54,12 @@ These steps assume that you already have established connectivity between your o f. Recommended: When prompted, integrate with an Azure **Private DNS zone** to simplify private IP name resolution. g. Review the configuration and then click **Create** to deploy the private endpoint. -2. Contact ValidMind at [support@validmind.ai](mailto:support@validmind.ai?subject=VNet%20Endpoint%20Connection%20Request) to get your new private endpoint connection request accepted. Include the following information: +2. Contact {{< var vm.product >}} at [support@validmind.ai](mailto:support@validmind.ai?subject=VNet%20Endpoint%20Connection%20Request) to get your new private endpoint connection request accepted. Include the following information: - The owner or account ID - The private endpoint IP address -3. After ValidMind has accepted your endpoint connection request, verify the endpoint is available: +3. After {{< var vm.product >}} has accepted your endpoint connection request, verify the endpoint is available: a. In the Azure portal, go to the **Private Endpoints** section. b. Verify that the connection status is `Approved`. This indicates that the endpoint is properly connected to the target service. @@ -73,13 +73,13 @@ These steps assume that you already have established connectivity between your o 5. Test the connection: - a. From your company network, access ValidMind using the private DNS name from the [VNet service information](#vnet-service-information). - b. In a browser, confirm that you can successfully connect to ValidMind and log in. - c. From your developer environment, confirm that you can connect to ValidMind with the {{< var vm.developer >}}. + a. From your company network, access {{< var vm.product >}} using the private DNS name from the [VNet service information](#vnet-service-information). + b. In a browser, confirm that you can successfully connect to {{< var vm.product >}} and log in. + c. From your developer environment, confirm that you can connect to {{< var vm.product >}} with the {{< var vm.developer >}}. ## What's next -After completing these steps, users on your company network can connect to ValidMind via Azure Private Link using the private DNS name from the [VNet service information](#vnet-service-information). +After completing these steps, users on your company network can connect to {{< var vm.product >}} via Azure Private Link using the private DNS name from the [VNet service information](#vnet-service-information). diff --git a/site/guide/configuration/configure-google-private-service-connect.qmd b/site/guide/configuration/configure-google-private-service-connect.qmd index 1dada8ce3e..befa7c81d9 100644 --- a/site/guide/configuration/configure-google-private-service-connect.qmd +++ b/site/guide/configuration/configure-google-private-service-connect.qmd @@ -4,11 +4,11 @@ lightbox: true date: last-modified --- -To keep your network traffic private and minimize its attack surface, configure Private Service Connect to establish a private connection between ValidMind and your company network. +To keep your network traffic private and minimize its attack surface, configure Private Service Connect to establish a private connection between {{< var vm.product >}} and your company network. -![Google Private Service Connect establishing a private connection to ValidMind](google-cloud-private-service-connect.png){fig-alt="A graphic showing Google Private Service Connect establishing a private connection to ValidMind"} +![Google Private Service Connect establishing a private connection to {{< var vm.product >}}](google-cloud-private-service-connect.png){fig-alt="A graphic showing Google Private Service Connect establishing a private connection to ValidMind"} -Private Service Connect is a networking service that allows secure and private communication between Google Virtual Private Cloud (VPC) resources and services hosted in other VPCs or Google partner services, such as ValidMind. By creating private endpoints within your VPC, Private Service Connect allows you to connect to services over the Google network without needing to expose your network traffic to the public internet. +Private Service Connect is a networking service that allows secure and private communication between Google Virtual Private Cloud (VPC) resources and services hosted in other VPCs or Google partner services, such as {{< var vm.product >}}. By creating private endpoints within your VPC, Private Service Connect allows you to connect to services over the Google network without needing to expose your network traffic to the public internet. ::: {.callout-important title="The responsibility of setting up endpoints for Private Service Connect falls to your IT department, such as the cloud engineering, infrastructure, or security teams."}
@@ -53,20 +53,20 @@ Enable the APIs for cloud DNS and networking to get ready for the next steps: After these steps, both the Cloud DNS and the Google Compute Engine API should be enabled for your project, allowing you to manage DNS configurations and networking resources. -## Request access from ValidMind +## Request access from {{< var vm.product >}} -Contact ValidMind at [support@validmind.ai](mailto:support@validmind.ai?subject=VPC%20Endpoint%20Connection%20Request) to get your new VPC endpoint connection request accepted. Include the following information: +Contact {{< var vm.product >}} at [support@validmind.ai](mailto:support@validmind.ai?subject=VPC%20Endpoint%20Connection%20Request) to get your new VPC endpoint connection request accepted. Include the following information: - The project name - The project ID ::: {.callout} -Please provide this information to ValidMind **at least 24 hours** before attempting to connect, so that we can add your project to the allowlist. +Please provide this information to {{< var vm.product >}} **at least 24 hours** before attempting to connect, so that we can add your project to the allowlist. ::: ## Prepare your network for connection -Create a private subnet in a supported GCP region that can be used to expose ValidMind services: +Create a private subnet in a supported GCP region that can be used to expose {{< var vm.product >}} services: 1. In Google Cloud Console, create the subnet: @@ -83,9 +83,9 @@ Create a private subnet in a supported GCP region that can be used to expose Val c. Note the available IP address range. d. Reserve two IP addresses within this range for future use. -## Create an endpoint to connect to ValidMind +## Create an endpoint to connect to {{< var vm.product >}} -Create a Private Service Connect endpoint for accessing ValidMind services securely and privately, with service discovery managed via Google Cloud’s Service Directory. +Create a Private Service Connect endpoint for accessing {{< var vm.product >}} services securely and privately, with service discovery managed via Google Cloud’s Service Directory. ![Creating an endpoint in the Google Cloud Console](gcp-add-validmind-endpoint-panel.png){fig-alt="Screenshot of an endpoint being created with the options specified in the steps" .screenshot width=90%} @@ -122,9 +122,9 @@ After the endpoint is active, test that the service is reachable through the pri ![Active `private` endpoint in the Google Cloud Console](gcp-add-validmind-endpoint.png){fig-alt="Active endpoint being shown in the Google Cloud Console" .screenshot width=90%} -## Create an endpoint to connect to the ValidMind authentication service +## Create an endpoint to connect to the {{< var vm.product >}} authentication service -Repeat the steps to create an endpoint to connect to ValidMind[^3] to add another endpoint for the ValidMind authentication service. +Repeat the steps to create an endpoint to connect to {{< var vm.product >}}[^3] to add another endpoint for the {{< var vm.product >}} authentication service. ![Creating an endpoint in the Google Cloud Console](gcp-add-auth-endpoint-panel.png){fig-alt="Screenshot of an endpoint being created with the options specified in the steps" .screenshot width=90%} @@ -145,13 +145,13 @@ After the endpoint is active, test that the service is reachable through the pri ## Test connectivity -As a final step, test that everything everything is set up correctly and that you can reach the ValidMind services: +As a final step, test that everything everything is set up correctly and that you can reach the {{< var vm.product >}} services: 1. Under Network Services > Cloud DNS, verify that DNS and service discovery are functioning as expected. 2. Test your connection to the following hosts: - **{{< var validmind.platform >}}** — [{{< var gcp.connect >}}]({{< var gcp.connect >}}) - - **ValidMind authentication service** — [{{< var gcp.authentication >}}]({{< var gcp.authentication >}}) + - **{{< var vm.product >}} authentication service** — [{{< var gcp.authentication >}}]({{< var gcp.authentication >}}) @@ -159,4 +159,4 @@ As a final step, test that everything everything is set up correctly and that yo [^2]: **Google:** [Private Google Access](https://cloud.google.com/vpc/docs/private-google-access) -[^3]: [Create an endpoint to connect to ValidMind](#create-an-endpoint-to-connect-to-validmind) \ No newline at end of file +[^3]: [Create an endpoint to connect to {{< var vm.product >}}](#create-an-endpoint-to-connect-to-validmind) \ No newline at end of file diff --git a/site/guide/configuration/customize-your-dashboard.qmd b/site/guide/configuration/customize-your-dashboard.qmd index 804c836583..a15ac81678 100644 --- a/site/guide/configuration/customize-your-dashboard.qmd +++ b/site/guide/configuration/customize-your-dashboard.qmd @@ -3,7 +3,7 @@ title: "Customize your dashboard" date: last-modified --- -Customize what you see on your ValidMind dashboard when you first log in. Rearrange the position of widgets, and add your own widgets from reporting for quick access. +Customize what you see on your {{< var vm.product >}} dashboard when you first log in. Rearrange the position of widgets, and add your own widgets from reporting for quick access. :::{.callout} Changes are automatically saved to your account and do not affect other users. diff --git a/site/guide/configuration/log-in-to-validmind.qmd b/site/guide/configuration/log-in-to-validmind.qmd index 0d355da79e..47edb3a9e7 100644 --- a/site/guide/configuration/log-in-to-validmind.qmd +++ b/site/guide/configuration/log-in-to-validmind.qmd @@ -1,4 +1,5 @@ --- +# USING THE VARIABLE IN THE TITLE MESSES UP THE BREADCRUMB title: "Log in to ValidMind" date: last-modified listing: @@ -15,9 +16,9 @@ aliases: - log-into-validmind.html --- -Log in to our cloud-hosted {{< var validmind.platform >}} to work with your model documentation, prepare validation reports, or to configure ValidMind for your organization. +Log in to our cloud-hosted {{< var validmind.platform >}} to work with your model documentation, prepare validation reports, or to configure {{< var vm.product >}} for your organization. -ValidMind supports the following methods for logging in: +{{< var vm.product >}} supports the following methods for logging in: - [Public internet](#public-internet) — easiest, less secure - [Private network endpoints](#private-network-endpoints) — requires additional configuration, more secure @@ -31,7 +32,8 @@ ValidMind supports the following methods for logging in: -::: {.callout title="Need an account for ValidMind?"} +::: {.callout} +## Need an account for {{< var vm.product >}}? Signing up is FREE — {{< var link.register >}} ::: @@ -41,7 +43,7 @@ Signing up is FREE — {{< var link.register >}} {{< include _validmind-public-internet.qmd >}} -1. Click **Sign in to ValidMind**. +1. Click **Sign in to {{< var vm.product >}}**. 1. Choose one of the login options: @@ -61,6 +63,6 @@ To configure and log in through a private endpoint for your company VPC using a - [Managing your organization](managing-your-organization.qmd) - [Managing users](managing-users.qmd) -- [Personalize ValidMind](personalize-validmind.qmd) +- [Personalize {{< var vm.product >}}](personalize-validmind.qmd) diff --git a/site/guide/configuration/manage-permissions.qmd b/site/guide/configuration/manage-permissions.qmd index 27597c60f6..4a1b500fc5 100644 --- a/site/guide/configuration/manage-permissions.qmd +++ b/site/guide/configuration/manage-permissions.qmd @@ -29,7 +29,7 @@ Please note that the [{{< fa hand >}} Customer Admin]{.bubble} role has the high ### Default permissions -The following tables outline the default roles and stock permissions provided by ValidMind: +The following tables outline the default roles and stock permissions provided by {{< var vm.product >}}: #### Workflow diff --git a/site/guide/configuration/managing-users.qmd b/site/guide/configuration/managing-users.qmd index f29f1576c8..b3f2a23914 100644 --- a/site/guide/configuration/managing-users.qmd +++ b/site/guide/configuration/managing-users.qmd @@ -25,7 +25,7 @@ Control and organize who has access to the {{< var validmind.platform >}} and wh Effective user management is essential for maintaining security and operational robustness. -- ValidMind uses role-based access control (RBAC) to manage user permissions systematically for our platform. +- {{< var vm.product >}} uses role-based access control (RBAC) to manage user permissions systematically for our {{< var vm.platform >}}. - With RBAC, access permissions are associated with roles rather than individual users. Users are assigned to specific roles, and these roles are then granted the necessary permissions to perform their respective tasks. This approach simplifies user management by **centralizing permissions** and enhances **security and efficiency**. It ensures that your users have the appropriate level of access based on their roles, reducing the risk of unauthorized actions and fostering a structured and controlled environment within an organization's digital ecosystem. @@ -51,7 +51,7 @@ resource actions ### Default roles -User management utilizes role-based access control (RBAC), where roles determine permissions. ValidMind provides the following default roles with stock permissions: +User management utilizes role-based access control (RBAC), where roles determine permissions. {{< var vm.product >}} provides the following default roles with stock permissions: developer : Model developers are responsible for documenting and testing models. They may have access to development tools and resources that interact with the {{< var vm.platform >}} and they can upload model documentation and test results through the {{< var vm.developer >}}. @@ -60,7 +60,7 @@ validator : Model validators review, test and validate models and model documentation. They may have limited access to modify content or configurations. customer admin -: The Customer Admin role has extensive control over the entire platform. This role can manage users, groups, and permissions at a broader level. +: The Customer Admin role has extensive control over the entire {{< var vm.platform >}}. This role can manage users, groups, and permissions at a broader level. ## What's next diff --git a/site/guide/configuration/personalize-validmind.qmd b/site/guide/configuration/personalize-validmind.qmd index f105416c16..af25035cd1 100644 --- a/site/guide/configuration/personalize-validmind.qmd +++ b/site/guide/configuration/personalize-validmind.qmd @@ -1,4 +1,5 @@ --- +# USING THE VARIABLE IN THE TITLE MESSES UP THE BREADCRUMB title: "Personalize ValidMind" date: last-modified listing: diff --git a/site/guide/configuration/register-with-validmind.qmd b/site/guide/configuration/register-with-validmind.qmd index 47aa6c3e6e..68a9fe2ca9 100644 --- a/site/guide/configuration/register-with-validmind.qmd +++ b/site/guide/configuration/register-with-validmind.qmd @@ -1,4 +1,5 @@ --- +# USING THE VARIABLE IN THE TITLE MESSES UP THE BREADCRUMB title: "Register with ValidMind" lightbox: true date: last-modified @@ -6,9 +7,9 @@ filters: - tachyons --- -Register with our cloud-hosted {{< var validmind.platform >}}, so you can begin working with model documentation or configure ValidMind for your organization. +Register with our cloud-hosted {{< var validmind.platform >}}, so you can begin working with model documentation or configure {{< var vm.product >}} for your organization. -With an email address or a Google,[^1] GitHub,[^2] or Microsoft[^3] account, you can gain access to ValidMind in two ways: +With an email address or a Google,[^1] GitHub,[^2] or Microsoft[^3] account, you can gain access to {{< var vm.product >}} in two ways: 1. [Sign up independently](#sign-up-independently) 2. [Accept an invite](#accept-an-invite) @@ -17,9 +18,9 @@ With an email address or a Google,[^1] GitHub,[^2] or Microsoft[^3] account, you ## Prerequisites -- [x] Access to ValidMind via the public internet. -- [x] Alternatively, you have been invited by someone else in your organization to join ValidMind. -- [x] Additionally, an email address that is able to receive messages from ValidMind.[^4] +- [x] Access to {{< var vm.product >}} via the public internet. +- [x] Alternatively, you have been invited by someone else in your organization to join {{< var vm.product >}}. +- [x] Additionally, an email address that is able to receive messages from {{< var vm.product >}}.[^4] ::: {.callout} For most users, someone with the Customer Admin role[^5] will invite you to your organization. @@ -44,7 +45,7 @@ Choose this method if you intend to set up your organization for your institutio - **Continue with Microsoft Account** ::: {.column-margin} -![ValidMind signup welcome screen](signup-welcome-screen.png){width=90% fig-alt="Screenshot of the Validmind signup welcome screen" .screenshot} +![{{< var vm.product >}} signup welcome screen](signup-welcome-screen.png){width=90% fig-alt="Screenshot of the ValidMind signup welcome screen" .screenshot} ::: 4. Click **Continue**. @@ -53,24 +54,24 @@ Choose this method if you intend to set up your organization for your institutio - **[first name]{.smallcaps}** — Your given name. - **[last name]{.smallcaps}** — Your surname. - - **[organization]{.smallcaps}**[^6] — The name of your organization you are setting up ValidMind on behalf of. + - **[organization]{.smallcaps}**[^6] — The name of your organization you are setting up {{< var vm.product >}} on behalf of. - **[job title]{.smallcaps}** — Your role at your organization. -![ValidMind profile completion screen](signup-complete-profile.png){width=80% fig-alt="Screenshot of the ValidMind profile completion screen" .screenshot} +![{{< var vm.product >}} profile completion screen](signup-complete-profile.png){width=80% fig-alt="Screenshot of the ValidMind profile completion screen" .screenshot} 6. Review the terms and conditions, then select **Yes, I accept the terms & conditions**[^7] to indicate that you accept them. Optionally, select the following if desired: - a. **Yes, sign me up for updates from ValidMind**[^8] — Sign up for news from ValidMind + a. **Yes, sign me up for updates from {{< var vm.product >}}**[^8] — Sign up for news from {{< var vm.product >}} b. **Yes, I want to join your online community**[^9] — Request to join our online community -7. Check the email inbox for the address you used to sign up with ValidMind for the following email: +7. Check the email inbox for the address you used to sign up with {{< var vm.product >}} for the following email: - From: `no-reply@validmind.ai` - Subject: "Verify your email" -![Verification email sent by ValidMind](verify-email.png){width=80% fig-alt="Screenshot of the verification email sent by ValidMind" .screenshot} +![Verification email sent by {{< var vm.product >}}](verify-email.png){width=80% fig-alt="Screenshot of the verification email sent by ValidMind" .screenshot} ::: {.column-margin} If you cannot locate this email, you may need to review your spam or junk mail folders and filters, or request that your IT allow-list our owned domains or retrieve any messages sent by: @@ -83,31 +84,31 @@ b. `validmind.com` ![Confirmation of email verification](email-verified.png){fig-alt="Screenshot of the confirmation of email verification" .screenshot} ::: -8. Click **Confirm my account** to gain full access to ValidMind. +8. Click **Confirm my account** to gain full access to {{< var vm.product >}}. -9. Return to the main ValidMind dashboard[^10] by clicking on **Back to ValidMind**. +9. Return to the main {{< var vm.product >}} dashboard[^10] by clicking on **Back to {{< var vm.product >}}**. - Sample models[^11] are populated for you in this new organization to demonstrate the usage of ValidMind. + Sample models[^11] are populated for you in this new organization to demonstrate the usage of {{< var vm.product >}}. :::: {.flex .flex-wrap .justify-around} ::: {.w-40-ns} -![ValidMind's main dashboard](main-dashboard.png){fig-alt="Screenshot of the main ValidMind dashboard" .screenshot} +![{{< var vm.product >}}'s main dashboard](main-dashboard.png){fig-alt="Screenshot of the main ValidMind dashboard" .screenshot} ::: ::: {.w-40-ns} -![Sample models populated by ValidMind](sample-models.png){fig-alt="Screenshot of the sample models populated by ValidMind" .screenshot} +![Sample models populated by {{< var vm.product >}}](sample-models.png){fig-alt="Screenshot of the sample models populated by ValidMind" .screenshot} ::: :::: ## Accept an invite ::: {.callout title="This method will allow you to register as user linked to your institution's existing organization."} -These steps require that you have been invited[^12] by a Customer Admin user to join your organization on ValidMind. +These steps require that you have been invited[^12] by a Customer Admin user to join your organization on {{< var vm.product >}}. ::: -1. Check the email inbox for the address you provided your organization to be associated with ValidMind for the following email: +1. Check the email inbox for the address you provided your organization to be associated with {{< var vm.product >}} for the following email: - From: `no-reply@validmind.ai` - - Subject: "{User} invited you to join ValidDemo on ValidMind" + - Subject: "{User} invited you to join ValidDemo on {{< var vm.product >}}" `{User}` is replaced with the name of the Customer Admin or other user who invited you to join. @@ -120,14 +121,14 @@ b. `validmind.com` 2. Within the email, click **Accept Invitation**. -![ValidMind organization invite email](organization-invitation-email.png){width=80% fig-alt="Screenshot of the Validmind organization invite email" .screenshot} +![{{< var vm.product >}} organization invite email](organization-invitation-email.png){width=80% fig-alt="Screenshot of the ValidMind organization invite email" .screenshot} 3. On the page that opens up in your web browser, click **Accept Invitation**. -![ValidMind accept invitation to join an organization screen](organization-accept-invitation.png){width=80% fig-alt="Screenshot of the ValidMind accept invitation to join an organization screen" .screenshot} +![{{< var vm.product >}} accept invitation to join an organization screen](organization-accept-invitation.png){width=80% fig-alt="Screenshot of the ValidMind accept invitation to join an organization screen" .screenshot} ::: {.column-margin} -![ValidMind signup welcome screen](signup-welcome-screen.png){width=90% fig-alt="Screenshot of the Validmind signup welcome screen" .screenshot} +![{{< var vm.product >}} signup welcome screen](signup-welcome-screen.png){width=90% fig-alt="Screenshot of the ValidMind signup welcome screen" .screenshot} ::: 4. On the Welcome screen, enter your email address and input a secure, unique password, or choose one of the single sign-on options to link to your account: @@ -137,15 +138,15 @@ b. `validmind.com` - **Continue with Microsoft Account** ::: {.callout-important} -Make sure that the email or account you use to link to ValidMind is the one that was invited to join your organization. +Make sure that the email or account you use to link to {{< var vm.product >}} is the one that was invited to join your organization. ::: -5. Check the email inbox for the address you used to sign up with ValidMind for the following email: +5. Check the email inbox for the address you used to sign up with {{< var vm.product >}} for the following email: - From: `no-reply@validmind.ai` - Subject: "Verify your email" -![Verification email sent by ValidMind](verify-email.png){width=80% fig-alt="Screenshot of the verification email sent by ValidMind" .screenshot} +![Verification email sent by {{< var vm.product >}}](verify-email.png){width=80% fig-alt="Screenshot of the verification email sent by ValidMind" .screenshot} ::: {.column-margin} If you cannot locate this email, ou may need to review your spam or junk mail folders and filters, or request that your IT allow-list our owned domains or retrieve any messages sent by: @@ -158,15 +159,15 @@ b. `validmind.com` ![Confirmation of email verification](email-verified.png){fig-alt="Screenshot of the confirmation of email verification" .screenshot} ::: -6. Click **Confirm my account** to gain full access to ValidMind. +6. Click **Confirm my account** to gain full access to {{< var vm.product >}}. -7. Return to the main ValidMind dashboard[^13] by clicking on **Back to ValidMind**. +7. Return to the main {{< var vm.product >}} dashboard[^13] by clicking on **Back to {{< var vm.product >}}**. - Sample models[^14] are populated for you in this new organization to demonstrate the usage of ValidMind. + Sample models[^14] are populated for you in this new organization to demonstrate the usage of {{< var vm.product >}}. :::: {.flex .flex-wrap .justify-around} ::: {.w-40-ns} -![ValidMind's main dashboard](main-dashboard.png){fig-alt="Screenshot of the main ValidMind dashboard" .screenshot} +![{{< var vm.product >}}'s main dashboard](main-dashboard.png){fig-alt="Screenshot of the main ValidMind dashboard" .screenshot} ::: ::: {.w-40-ns} ![Sample models populated by ValidMind](sample-models.png){fig-alt="Screenshot of the sample models populated by ValidMind" .screenshot} @@ -177,7 +178,7 @@ b. `validmind.com` - [Managing your organization](managing-your-organization.qmd) - [Managing users](managing-users.qmd) -- [Personalize ValidMind](personalize-validmind.qmd) +- [Personalize {{< var vm.product >}}](personalize-validmind.qmd) @@ -190,7 +191,7 @@ b. `validmind.com` [^4]: - To receive invitation and verification emails from ValidMind, you may need to first request that your IT allow-list our owned domains or retrieve any messages sent by: + To receive invitation and verification emails from {{< var vm.product >}}, you may need to first request that your IT allow-list our owned domains or retrieve any messages sent by: a. `validmind.ai` b. `validmind.com` @@ -202,15 +203,15 @@ b. `validmind.com` [^7]: ::: {.callout} - ## ValidMind terms and conditions + ## {{< var vm.product >}} terms and conditions [View in full {{< fa hand-point-right >}}](https://validmind.com/about/legal/) ::: -[^8]: **ValidMind:** [Code, Contribution, and Community.](https://validmind.com/community/) +[^8]: **{{< var vm.product >}}:** [Code, Contribution, and Community.](https://validmind.com/community/) -[^9]: [ValidMind community](/about/contributing/validmind-community.qmd) +[^9]: [{{< var vm.product >}} community](/about/contributing/validmind-community.qmd) [^10]: [Customize your dashboard](customize-your-dashboard.qmd) diff --git a/site/guide/configuration/set-up-your-organization.qmd b/site/guide/configuration/set-up-your-organization.qmd index d1754481a0..cda0fbd07d 100644 --- a/site/guide/configuration/set-up-your-organization.qmd +++ b/site/guide/configuration/set-up-your-organization.qmd @@ -5,7 +5,7 @@ aliases: - ../set-up-your-organization.html --- -This task involves managing organizations within ValidMind, allowing for effective business unit control. +This task involves managing organizations within {{< var vm.product >}}, allowing for effective business unit control. ::: {.attn} @@ -51,7 +51,7 @@ This task involves managing organizations within ValidMind, allowing for effecti ## What's next - [Managing users](managing-users.qmd) -- [Personalize ValidMind](personalize-validmind.qmd) +- [Personalize {{< var vm.product >}}](personalize-validmind.qmd) - [Manage validation guidelines](/guide/model-validation/manage-validation-guidelines.qmd) diff --git a/site/guide/guides.qmd b/site/guide/guides.qmd index 7bce15e442..81532dfdb3 100644 --- a/site/guide/guides.qmd +++ b/site/guide/guides.qmd @@ -51,13 +51,13 @@ listing: - model-documentation/working-with-documentation-templates.qmd - model-documentation/working-with-model-documentation.qmd # - model-documentation/export-documentation.qmd - - id: guides-developer-framework + - id: guides-developer type: grid max-description-length: 250 sort: false fields: [title, description] contents: - - ../developer/get-started-developer-framework.qmd + - ../developer/get-started-validmind-library.qmd - ../developer/samples-jupyter-notebooks.qmd - id: guides-model-validation type: grid @@ -85,7 +85,7 @@ listing: fields: [title, description] --- -Our guides offer step-by-step instructions for frequent tasks you perform on the ValidMind platform, organized by category: +Our guides offer step-by-step instructions for frequent tasks you perform within the {{< var validmind.platform >}}, organized by category: - [Onboarding](#onboarding) - [Model workflows](#model-workflows) @@ -95,9 +95,7 @@ Our guides offer step-by-step instructions for frequent tasks you perform on the - [Monitoring](#monitoring) ::: {.callout-important collapse="true" appearance="minimal"} -## {{< fa building-columns >}} Key ValidMind concepts - - +## {{< fa building-columns >}} Key {{< var vm.product >}} concepts {{< include /about/glossary/key_concepts/_key-concepts.qmd >}} @@ -105,12 +103,12 @@ Our guides offer step-by-step instructions for frequent tasks you perform on the ## Onboarding -Before you begin, let's make sure you're able to access ValidMind: +Before you begin, let's make sure you're able to access {{< var vm.product >}}: :::{#guides-login} ::: -Onboard your organization, teams or business units, and users onto the ValidMind platform: +Onboard your organization, teams or business units, and users onto the {{< var validmind.platform >}}: :::{#guides-onboarding} @@ -137,12 +135,12 @@ Use the {{< var validmind.platform >}} model inventory to thoroughly track your ## Model documentation -Document and test your models in your own model development environment with the {{< var validmind.developer >}}: +First, document and test your models in your own model development environment with the {{< var validmind.developer >}}: -:::{#guides-developer-framework} +:::{#guides-developer} ::: -Work with documentation and customizable templates, and collaborate with model validators all within the {{< var validmind.platform >}}: +Then, work with documentation and customizable templates, and collaborate with model validators all within the {{< var validmind.platform >}}: :::{#guides-model-documentation} ::: diff --git a/site/guide/model-documentation/collaborate-with-others.qmd b/site/guide/model-documentation/collaborate-with-others.qmd index afc2baf59f..4259b4ce97 100644 --- a/site/guide/model-documentation/collaborate-with-others.qmd +++ b/site/guide/model-documentation/collaborate-with-others.qmd @@ -10,7 +10,7 @@ Use the real-time collaboration features to track changes, add comments, and acc ## Feature highlights -- **Real-time collaboration** — Simultaneously edit model documentation, leave and respond to comments suggestions, and access revision history. Changes to model documentation are also automatically added to ValidMind's activity feed. +- **Real-time collaboration** — Simultaneously edit model documentation, leave and respond to comments suggestions, and access revision history. Changes to model documentation are also automatically added to {{< var vm.product >}}'s activity feed. - **Spell and grammar checker** — Have your content checked automatically by the built-in spell and grammar checker. diff --git a/site/guide/model-documentation/customize-documentation-templates.qmd b/site/guide/model-documentation/customize-documentation-templates.qmd index 009ca5b1c2..dbbe7b3bba 100644 --- a/site/guide/model-documentation/customize-documentation-templates.qmd +++ b/site/guide/model-documentation/customize-documentation-templates.qmd @@ -6,7 +6,7 @@ aliases: - ../customize-documentation-templates.html --- -The {{< var validmind.product >}} offers robust and fully customizable templates for model documentation and validation reports. Configure these templates via multiple methods to suit your organization's unique needs. +{{< var vm.product >}} offers robust and fully customizable templates for model documentation and validation reports. Configure these templates via multiple methods to suit your organization's unique needs. - Templates are versioned and saving a documentation template after making changes or reverting to a previous version state always creates a new version, or you can duplicate templates to create new independent templates in your library. - Documentation templates are stored as YAML files edited directly using the advanced editor, allowing you full control over the minitua such as desired guidelines. diff --git a/site/guide/model-documentation/export-documentation.qmd b/site/guide/model-documentation/export-documentation.qmd index f4ef8cc7e7..5b7c93d086 100644 --- a/site/guide/model-documentation/export-documentation.qmd +++ b/site/guide/model-documentation/export-documentation.qmd @@ -17,7 +17,7 @@ Export your model documentation or validation reports as Microsoft Word files (` - [x] You are a [{{< fa code >}} Developer]{.bubble} or [{{< fa circle-check >}} Validator]{.bubble}, or assigned another role with sufficient permissions to perform the tasks in this guide.[^3] ::: {.callout} -ValidMind supports Word 365, Word 2019, Word 2016, and Word 2013. +{{< var vm.product >}} supports Word 365, Word 2019, Word 2016, and Word 2013. ::: ::: diff --git a/site/guide/model-documentation/view-documentation-guidelines.qmd b/site/guide/model-documentation/view-documentation-guidelines.qmd index 8965eac1a5..4d7575690b 100644 --- a/site/guide/model-documentation/view-documentation-guidelines.qmd +++ b/site/guide/model-documentation/view-documentation-guidelines.qmd @@ -32,13 +32,13 @@ By default, the [{{< fa hand >}} Customer Admin]{.bubble} role has these permiss 3. In the left sidebar that appears for your model, click **Documentation**. -4. In any section of the documentation for a model, click **ValidMind Insights™** in the top right corner to expand the **ValidMind Insights™** sidebar. +4. In any section of the documentation for a model, click **{{< var vm.product >}} Insights™** in the top right corner to expand the **{{< var vm.product >}} Insights™** sidebar. **Documentation Guidelines** are shown for each document section, associated with the template configured by your model validation team. ## What's next -- [Get started with the {{< var validmind.developer >}}](/developer/get-started-developer-framework.qmd) +- [Get started with the {{< var validmind.developer >}}](/developer/get-started-validmind-library.qmd) - [Working with model documentation](working-with-model-documentation.qmd) - [Collaborate on documentation](collaborate-with-others.qmd) @@ -49,7 +49,7 @@ By default, the [{{< fa hand >}} Customer Admin]{.bubble} role has these permiss [^2]: [Working with model documentation](working-with-model-documentation.qmd) -[^3]: [{{< var validmind.developer >}}](/developer/get-started-developer-framework.qmd) +[^3]: [{{< var validmind.developer >}}](/developer/get-started-validmind-library.qmd) [^4]: [Manage permissions](/guide/configuration/manage-permissions.qmd) diff --git a/site/guide/model-documentation/view-documentation-templates.qmd b/site/guide/model-documentation/view-documentation-templates.qmd index f24e0e2a8b..bc2d536363 100644 --- a/site/guide/model-documentation/view-documentation-templates.qmd +++ b/site/guide/model-documentation/view-documentation-templates.qmd @@ -5,7 +5,7 @@ aliases: - ../view-documentation-templates.html --- -View the structure and configuration of existing documentation templates within the {{< var vm.platform >}}. ValidMind provides default templates for documentation, validation reports, and ongoing monitoring plans. +View the structure and configuration of existing documentation templates within the {{< var vm.platform >}}. {{< var vm.product >}} provides default templates for documentation, validation reports, and ongoing monitoring plans. ::: {.attn} @@ -45,7 +45,7 @@ View the structure and configuration of existing documentation templates within ## What's next -- [Get started with the {{< var validmind.developer >}}](/developer/get-started-developer-framework.qmd) +- [Get started with the {{< var validmind.developer >}}](/developer/get-started-validmind-library.qmd) - [Collaborate on documentation](collaborate-with-others.qmd) diff --git a/site/guide/model-documentation/work-with-content-blocks.qmd b/site/guide/model-documentation/work-with-content-blocks.qmd index fd631bdc36..b0584f87fc 100644 --- a/site/guide/model-documentation/work-with-content-blocks.qmd +++ b/site/guide/model-documentation/work-with-content-blocks.qmd @@ -37,7 +37,7 @@ The content editing toolbar is a rich text editor that enables you to: You can also use the toolbar to suggest changes, save named versions of content, and leave comments.[^2] ::: {.callout title="Stuck on where to start?"} -Use ValidMind to assist you with generating content via AI!^[[Generate with AI (BETA)](#generate-text-with-ai-beta)] +Use {{< var vm.product >}} to assist you with generating content via AI!^[[Generate with AI (BETA)](#generate-text-with-ai-beta)] ::: ::: {.attn} @@ -76,13 +76,13 @@ While editing a simple text block, you can insert math equations using the edito ### Generate Text with AI [beta]{.smallcaps} -While editing a simple text block, you can have ValidMind assist you with generating content drafts: +While editing a simple text block, you can have {{< var vm.product >}} assist you with generating content drafts: 1. Click **{{< fa diamond >}} [beta]{.smallcaps} (Generate Text with AI)** in the toolbar while editing a content block. 2. Enter an optional prompt to guide the output, then click **{{< fa check >}} Generate** to compose a draft for review. -3. Review the draft composed by the ValidMind AI Content Builder for accuracy and relevance, then: +3. Review the draft composed by the {{< var vm.product >}} AI Content Builder for accuracy and relevance, then: - Click **{{< fa download >}} Accept Text** to insert the draft into your content block. - Click **{{< fa rotate >}} Try Again** to regenerate a different draft. diff --git a/site/guide/model-documentation/working-with-model-documentation.qmd b/site/guide/model-documentation/working-with-model-documentation.qmd index 858c6ea0be..e9c017491f 100644 --- a/site/guide/model-documentation/working-with-model-documentation.qmd +++ b/site/guide/model-documentation/working-with-model-documentation.qmd @@ -26,7 +26,7 @@ After you upload initial model documentation through the {{< var vm.developer >} This section describes how to work with model documentation in the {{< var validmind.platform >}}. Typically, you perform the tasks described here **after you have uploaded some initial model documentation** with the {{< var validmind.developer >}}. -[Get started with the {{< var validmind.developer >}} {{< fa hand-point-right>}}](/developer/get-started-developer-framework.qmd) +[Get started with the {{< var validmind.developer >}} {{< fa hand-point-right>}}](/developer/get-started-validmind-library.qmd) ::: ::: {.attn} @@ -35,7 +35,7 @@ This section describes how to work with model documentation in the {{< var valid - [x] {{< var link.login >}} - [x] The model is already registered in the model inventory.[^1] -- [x] You have provided some content for the documentation, either by uploading it through the {{< var validmind.developer >}}[^2] or via the online UI editor. +- [x] You have provided some content for the documentation, either by uploading it through the {{< var validmind.developer >}}[^2] or via the {{< var validmind.platform >}}. - [x] You are a [{{< fa code >}} Developer]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^3] ::: @@ -103,6 +103,6 @@ This section describes how to work with model documentation in the {{< var valid [^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) -[^2]: [{{< var validmind.developer >}}](/developer/get-started-developer-framework.qmd) +[^2]: [{{< var validmind.developer >}}](/developer/get-started-validmind-library.qmd) [^3]: [Manage permissions](/guide/configuration/manage-permissions.qmd) \ No newline at end of file diff --git a/site/guide/model-inventory/_view-model-activity-overview.qmd b/site/guide/model-inventory/_view-model-activity-overview.qmd index 8858807784..98b8c058b0 100644 --- a/site/guide/model-inventory/_view-model-activity-overview.qmd +++ b/site/guide/model-inventory/_view-model-activity-overview.qmd @@ -4,7 +4,7 @@ - Inventory fields updated on the model^[[Edit model inventory fields](/guide/model-inventory/edit-model-inventory-fields.qmd)] - Model status transitions^[[Working with model workflows](/guide/model-workflows/working-with-model-workflows.qmd)] - Updates to model documentation, validation reports,^[[Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd)] or ongoing monitoring plans^[[Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)] -- Test results added to your model^[[{{< var validmind.developer >}}](/developer/get-started-developer-framework.qmd)] +- Test results added to your model^[[{{< var validmind.developer >}}](/developer/get-started-validmind-library.qmd)] - Findings added, updated, or removed^[[Working with model findings](/guide/model-validation/working-with-model-findings.qmd)] - Comment creation and replies^[[Collaborate with others (Commenting)](/guide/model-documentation/collaborate-with-others.qmd#commenting)] diff --git a/site/guide/model-inventory/configure-model-interdependencies.qmd b/site/guide/model-inventory/configure-model-interdependencies.qmd index 039eebb949..5cdc95fd94 100644 --- a/site/guide/model-inventory/configure-model-interdependencies.qmd +++ b/site/guide/model-inventory/configure-model-interdependencies.qmd @@ -6,7 +6,7 @@ filters: - tachyons --- -Link two or more models in your ValidMind model inventory together. Dependencies are useful to understand how a model is +Link two or more models in your {{< var vm.product >}} model inventory together. Dependencies are useful to understand how a model is affected by or affects other models in your inventory. ::: {.attn} diff --git a/site/guide/model-inventory/manage-model-inventory-fields.qmd b/site/guide/model-inventory/manage-model-inventory-fields.qmd index c14ef3f2e8..fce677dd51 100644 --- a/site/guide/model-inventory/manage-model-inventory-fields.qmd +++ b/site/guide/model-inventory/manage-model-inventory-fields.qmd @@ -58,8 +58,8 @@ Checkbox Number : Text value in valid number format. Number display (comma, fullstop, etc.) is determined by your browser's locale. Select a **[number type]{.smallcaps}**: -- **Simple** — Define the [decimal places]{.smallcaps} the UI should display the number up to and any [large number abbreviation]{.smallcaps}s. -- **Currency** — Define the [currency]{.smallcaps} you would like the field to display in, as well as the [decimal places]{.smallcaps} the UI should display the number up to and any [large number abbreviation]{.smallcaps}s. +- **Simple** — Define the [decimal places]{.smallcaps} that the number should be displayed up to and any [large number abbreviation]{.smallcaps}s. +- **Currency** — Define the [currency]{.smallcaps} you would like the field to display in, as well as the [decimal places]{.smallcaps} that the number should be displayed up to and any [large number abbreviation]{.smallcaps}s. :::: {.flex .flex-wrap .justify-around} diff --git a/site/guide/model-inventory/register-models-in-inventory.qmd b/site/guide/model-inventory/register-models-in-inventory.qmd index d22541e8a4..5fa7efbd54 100644 --- a/site/guide/model-inventory/register-models-in-inventory.qmd +++ b/site/guide/model-inventory/register-models-in-inventory.qmd @@ -5,7 +5,7 @@ aliases: - ../register-models-in-model-inventory.html --- -Register models with ValidMind as the first step towards streamlining your model documentation and validation workflow. +Register models with {{< var vm.product >}} as the first step towards streamlining your model documentation and validation workflow. ::: {.attn} diff --git a/site/guide/model-inventory/view-model-activity.qmd b/site/guide/model-inventory/view-model-activity.qmd index 5cb119d4f6..064ad4a217 100644 --- a/site/guide/model-inventory/view-model-activity.qmd +++ b/site/guide/model-inventory/view-model-activity.qmd @@ -18,7 +18,7 @@ This topic matters for model developers, model validators, and auditors. - [x] {{< var link.login >}} - [x] The model you are documenting is registered in the model inventory.[^1] -- [x] A model developer has started generating documentation, either using the {{< var vm.developer >}}[^2] or via the online UI editor. +- [x] A model developer has started generating documentation, either using the {{< var vm.developer >}}[^2] or via the {{< var validmind.platform >}}. ::: @@ -71,7 +71,7 @@ Shows test results logged for your model via the {{< var validmind.developer >}} [^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) -[^2]: [{{< var validmind.developer >}}](/developer/get-started-developer-framework.qmd) +[^2]: [{{< var validmind.developer >}}](/developer/get-started-validmind-library.qmd) [^3]: [Collaborate with others (Commenting)](/guide/model-documentation/collaborate-with-others.qmd#commenting) diff --git a/site/guide/model-inventory/working-with-model-inventory.qmd b/site/guide/model-inventory/working-with-model-inventory.qmd index 3c5cbc06a0..89aaa6116e 100644 --- a/site/guide/model-inventory/working-with-model-inventory.qmd +++ b/site/guide/model-inventory/working-with-model-inventory.qmd @@ -15,7 +15,7 @@ aliases: - ../working-with-model-inventory.html --- -Get started with the ValidMind model inventory, which tracks comprehensive details for all your models throughout the model lifecycle. The model inventory is customizable and extensible, with a layout that can be configured to suit each user's needs. +Get started with the {{< var vm.product >}} model inventory, which tracks comprehensive details for all your models throughout the model lifecycle. The model inventory is customizable and extensible, with a layout that can be configured to suit each user's needs. ::: {.attn} diff --git a/site/guide/model-validation/add-manage-model-findings.qmd b/site/guide/model-validation/add-manage-model-findings.qmd index 256d177b97..b56971a253 100644 --- a/site/guide/model-validation/add-manage-model-findings.qmd +++ b/site/guide/model-validation/add-manage-model-findings.qmd @@ -47,7 +47,7 @@ To log a finding from the documentation overview: While working within a section of your documentation, you can easily log a finding associated with that section without leaving the page: -1. Click on **ValidMind Insights™** to expand the insight panel. +1. Click on **{{< var vm.product >}} Insights™** to expand the insight panel. 2. For the section you want to add a Finding for, click **{{< fa triangle-exclamation >}} Add Finding** beneath the Documentation Guidelines. @@ -63,7 +63,7 @@ While working within a section of your documentation, you can easily log a findi The documentation section will be auto-populated with the section you are working from — you are able to select another section if desired. - ![Adding a finding with the ValidMind Insights™ panel](add-section-finding.gif){fig-alt="An animated gif demonstrating how to add a finding with the ValidMind Insights™ panel" .screenshot} + ![Adding a finding with the {{< var vm.product >}} Insights™ panel](add-section-finding.gif){fig-alt="An animated gif demonstrating how to add a finding with the ValidMind Insights™ panel" .screenshot} 4. When you are done, click **Save** to submit the finding. diff --git a/site/guide/model-validation/view-reports.qmd b/site/guide/model-validation/view-reports.qmd index 5a099432d3..1f002abac3 100644 --- a/site/guide/model-validation/view-reports.qmd +++ b/site/guide/model-validation/view-reports.qmd @@ -56,7 +56,7 @@ Reports will not include data or findings from archived models.[^2] #### Reports on models Total Models -: Count of your total models registered with ValidMind. +: Count of your total models registered with {{< var vm.product >}}. Number of Models by Business Unit and Tier : Count of your model volume by business unit[^3] further broken down by risk tier. Assists you in pinpointing where in the organization resources should be concentrated on, along with the materiality of risk that unit may pose based on the models they are responsible for. diff --git a/site/guide/model-validation/working-with-model-findings.qmd b/site/guide/model-validation/working-with-model-findings.qmd index 1826c7b45c..33e2995b23 100644 --- a/site/guide/model-validation/working-with-model-findings.qmd +++ b/site/guide/model-validation/working-with-model-findings.qmd @@ -18,7 +18,7 @@ aliases: - ../work-with-model-findings.html --- -Use {{< var validmind.platform >}} to log thorough findings as you validate your models. From status and severity to proposed remediation plans and due dates, ValidMind allows you to oversee the minutiae to ensure organizational compliance. +Use {{< var validmind.platform >}} to log thorough findings as you validate your models. From status and severity to proposed remediation plans and due dates, {{< var vm.product >}} allows you to oversee the minutiae to ensure organizational compliance. ## Key concepts diff --git a/site/guide/model-workflows/set-up-model-workflows.qmd b/site/guide/model-workflows/set-up-model-workflows.qmd index 8e0896500e..9d8ac64d88 100644 --- a/site/guide/model-workflows/set-up-model-workflows.qmd +++ b/site/guide/model-workflows/set-up-model-workflows.qmd @@ -10,7 +10,7 @@ aliases: Workflows can be configured to match your organizational needs for overseeing model development, validation, or implementation activities. - + + diff --git a/site/index.qmd b/site/index.qmd index 8a521605e6..593eca1f9f 100644 --- a/site/index.qmd +++ b/site/index.qmd @@ -25,7 +25,7 @@ listing: sort: false fields: [title, description] contents: - - /developer/get-started-developer-framework.qmd + - /developer/get-started-validmind-library.qmd - /developer/model-documentation/supported-models.qmd - /developer/model-documentation/documenting-models.qmd - id: validator @@ -158,7 +158,7 @@ The **purpose-built platform** for model risk management teams to test, document - + [quickstart](get-started/developer/try-with-jupyterhub.qmd){.button-pink .cta} @@ -174,7 +174,6 @@ The **purpose-built platform** for model risk management teams to test, document ![](assets/img/platform-line-3.png) ![](assets/img/platform-line-4.png) ![](assets/img/platform-line-5.png) -![]() ::: ::: @@ -285,7 +284,7 @@ The **purpose-built platform** for model risk management teams to test, document :::: :::: {.f4} -Gain **hands-on experience** and explore what ValidMind has to offer with our interactive training environment. +Gain **hands-on experience** and explore what {{< var vm.product >}} has to offer with our interactive training environment. :::: ::: {.w-100-ns .content-center .mt2} @@ -334,7 +333,7 @@ Events :::: :::: {.f4} -Connect with the ValidMind team at events for the model and AI risk community. +Connect with the {{< var vm.product >}} team at events for the model and AI risk community. :::: [find events](https://validmind.com/events/){.button-pink .cta} diff --git a/site/releases/2023/2023-aug-15/highlights.qmd b/site/releases/2023/2023-aug-15/highlights.qmd index 0c80c1c3d8..21da3d4dbf 100644 --- a/site/releases/2023/2023-aug-15/highlights.qmd +++ b/site/releases/2023/2023-aug-15/highlights.qmd @@ -53,7 +53,7 @@ Added a new `task_type` argument to the `list_tests()` function to allow simple **Clearer naming** -Renamed `required_context` to `required_inputs` across the whole ValidMind SDK. +Renamed `required_context` to `required_inputs` across the whole {{< var vm.product >}} {{< var validmind.api >}}. #### Enhancements to test configuration discovery @@ -113,7 +113,7 @@ You can now obtain complete test details, including `required_context` and `defa :::: {.flex .flex-wrap .justify-around} ::: {.w-80-ns} -The new function `vm.get_test_suite()` allows you to access a specific test suite instance via the high-level ValidMind API. +The new function `vm.get_test_suite()` allows you to access a specific test suite instance via the high-level {{< var validmind.api >}}. ::: diff --git a/site/releases/2023/2023-nov-09/highlights.qmd b/site/releases/2023/2023-nov-09/highlights.qmd index f222114470..6a5caedf04 100644 --- a/site/releases/2023/2023-nov-09/highlights.qmd +++ b/site/releases/2023/2023-nov-09/highlights.qmd @@ -7,7 +7,7 @@ filters: ## Release highlights -This release introduces support for several new models, a new user onboarding guide and other UI enhancements, and improved test descriptions in our user-facing documentation. +This release introduces support for several new models, a new user onboarding guide and other {{< var validmind.platform >}} enhancements, and improved test descriptions in our user-facing documentation. ### {{< var validmind.developer >}} (v1.23.0) @@ -52,7 +52,7 @@ We added initial support for text embeddings models in the {{< var validmind.dev :::: {.flex .flex-wrap .justify-around} ::: {.w-70-ns} -To help you familiarize yourself with the features available in the ValidMind platform, a new onboarding guide is now available to all users. +To help you familiarize yourself with the features available in the {{< var validmind.platform >}}, a new onboarding guide is now available to all users. ::: @@ -65,7 +65,7 @@ To help you familiarize yourself with the features available in the ValidMind pl :::: -![New platform UI onboarding guide](onboarding-guide.png){width=80% fig-alt="A screenshot showing the new platform UI onboarding guide" .screenshot} +![New {{< var validmind.platform >}} onboarding guide](onboarding-guide.png){width=80% fig-alt="A screenshot showing the new ValidMind Platform onboarding guide" .screenshot} The onboarding guide tracks six common tasks that can be completed in almost any order: @@ -73,7 +73,7 @@ The onboarding guide tracks six common tasks that can be completed in almost any ::: {.w-50-ns} -- Get your ValidMind account +- Get your {{< var vm.product >}} account - Register your model - Start on your model documentation @@ -150,6 +150,6 @@ You can easily switch between views using the **Display Table** or **Display Car :::: -![Improved test descriptions for the developer framework](test-descriptions.gif){width=80% fig-alt="A screenshot showing improved test descriptions for the developer framework" .screenshot} +![Improved test descriptions for the {{< var validmind.developer >}}](test-descriptions.gif){width=80% fig-alt="A screenshot showing improved test descriptions for the ValidMind Library" .screenshot} {{< include /releases/_how-to-upgrade.qmd >}} \ No newline at end of file diff --git a/site/releases/2023/2023-oct-25/highlights.qmd b/site/releases/2023/2023-oct-25/highlights.qmd index e071f3e77d..64cde7ef21 100644 --- a/site/releases/2023/2023-oct-25/highlights.qmd +++ b/site/releases/2023/2023-oct-25/highlights.qmd @@ -7,9 +7,9 @@ filters: ## Release highlights -We've introduced a new guide for modifying configurations and parameters within the {{< var vm.developer >}}, and new features to the {{< var vm.platform >}} that enable you to remove blocks of content from documentation and work with your settings more effectively. +We've introduced new features to the {{< var vm.platform >}} that enable you to remove blocks of content from documentation and work with your settings more effectively. -### {{< var validmind.developer >}} (v1.22.0) + #### New Settings landing page -A new **{{< fa gear >}} Settings** landing page now organizes more of your settings for the ValidMind platform in one convenient place. +A new **{{< fa gear >}} Settings** landing page now organizes more of your settings for the {{< var validmind.platform >}} in one convenient place. :::: {.flex .flex-wrap .justify-around} ::: {.w-40-ns} From this page you can manage: -- Your organization, including the name and the API and secret key you use to connect to the ValidMind platform. +- Your organization, including the name and the API and secret key you use to connect to the {{< var validmind.platform >}}. - The documentation templates that standardize the documentation table of contents for your projects and configure the required validation tests for specific model use cases. - Workflows that determine the statuses of your model and how it transitions through your model risk management process according to your requirements. @@ -106,7 +106,7 @@ From this page you can manage: ::: {.w-50-ns} -![New Settings page](settings-page.png){fig-alt="A screenshot showing the new platform UI settings page" .screenshot} +![New Settings page](settings-page.png){fig-alt="A screenshot showing the new ValidMind Platform settings page" .screenshot} ::: @@ -176,16 +176,16 @@ To test these metrics, see notebook `foundation_models_summarization_bias.ipynb` ## Documentation updates -#### Platform overview rewrite +#### Product overview rewrite :::: {.flex .flex-wrap .justify-around} ::: {.w-70-ns} -We expanded our platform overview to provide more background information about what ValidMind offers and how we enable you to comply with policies and regulations such as SR 11-7 and SS1/23. +We expanded our platform overview to provide more background information about what {{< var vm.product >}} offers and how we enable you to comply with policies and regulations such as SR 11-7 and SS1/23. ::: ::: {.w-30-ns .tc} -[About ValidMind](/about/overview.qmd){.button} +[About {{< var vm.product >}}](/about/overview.qmd){.button} ::: @@ -197,7 +197,7 @@ We expanded our platform overview to provide more background information about w :::: {.flex .flex-wrap .justify-around} ::: {.w-80-ns} -We updated the QuickStart section of our documentation to reflect recent UI and sign-up flow changes. +We updated the QuickStart section of our documentation to reflect recent {{< var validmind.platform >}} and sign-up flow changes. ::: ::: {.w-20-ns .tc} diff --git a/site/releases/2023/2023-sep-27/developer-framework-dropdown.gif b/site/releases/2023/2023-sep-27/developer-framework-dropdown.gif deleted file mode 100644 index ba604ef18b..0000000000 Binary files a/site/releases/2023/2023-sep-27/developer-framework-dropdown.gif and /dev/null differ diff --git a/site/releases/2023/2023-sep-27/highlights.qmd b/site/releases/2023/2023-sep-27/highlights.qmd index 8cb0d6e788..058ac7d2c1 100644 --- a/site/releases/2023/2023-sep-27/highlights.qmd +++ b/site/releases/2023/2023-sep-27/highlights.qmd @@ -29,10 +29,10 @@ Other enhancements provide improvements for the developer experience and with ou :::: {.flex .flex-wrap .justify-around} ::: {.w-60-ns} -We added initial support for large language models (LLMs) in ValidMind via the new `FoundationModel` class. +We added initial support for large language models (LLMs) in {{< var vm.product >}} via the new `FoundationModel` class. - You can now create an instance of a `FoundationModel` and specify `predict_fn` and a `prompt`, and pass that into any test suite, for example. -- The `predict_fn` must be defined by the user and implements the logic for calling the Foundation LLM, usually via the API. +- The `predict_fn` must be defined by the user and implements the logic for calling the Foundation LLM, usually via the {{< var validmind.api >}}. ::: @@ -69,11 +69,10 @@ We added a new notebook in the {{< var vm.developer >}} that includes the financ :::: - ### Support for Hugging Face models -ValidMind can now validate pre-trained models from the HuggingFace Hub, including any language model compatible with the HF transformers API. +{{< var vm.product >}} can now validate pre-trained models from the HuggingFace Hub, including any language model compatible with the HF transformers API. To illustrate this new feature, we have included a **financial news sentiment analysis demo** that runs documentation tests for a Hugging Face model with text classification using the `financial_phrasebank`:[^2] @@ -132,10 +131,9 @@ We also updated the QuickStart notebook to have a consistent experience. This notebook: -- Now runs [`vm.preview_template()`](/validmind/validmind.html#preview_template) after initializing ValidMind +- Now runs [`vm.preview_template()`](/validmind/validmind.html#preview_template) after initializing {{< var vm.product >}} - Now runs [`vm.run_documentation_tests()`](/validmind/validmind.html#run_documentation_tests) instead of running a test suite that is not connected to the template - #### Example usage for `run_test` Discover existing tests by calling `list_tests()` or `describe_test()`: @@ -220,7 +218,7 @@ test_results = vm.tests.run_test( ::: {.w-30-ns} -Send the results of the test to ValidMind by calling **`.log()`:** +Send the results of the test to {{< var vm.product >}} by calling **`.log()`:** ```python test_results.log() @@ -300,7 +298,7 @@ We made a number of changes to tests to improve the developer experience: #### Track additional test metadata -- Added a `metadata` property to every ValidMind test class. +- Added a `metadata` property to every {{< var vm.product >}} test class. - The `metadata` property includes a `task_types` field and a `tags` field which both serve to categorize the tests based on what data and model types they work with, what category of test they fall into, and more. @@ -342,7 +340,7 @@ We enhanced the architecture and content of our external docs site to make the u ::: ::: {.w-50-ns} -[Get started with the {{< var validmind.developer >}}](/developer/get-started-developer-framework.qmd){.button} +[Get started with the {{< var validmind.developer >}}](/developer/get-started-validmind-library.qmd){.button} ::: @@ -355,13 +353,10 @@ We enhanced the architecture and content of our external docs site to make the u We made a number of incremental improvements to our user guide: - - **New dropdown for the {{< var vm.developer >}}** that gives faster access to the most important bits, such as our code samples and the reference documentation. - - ![New developer framework dropdown menu on the ValidMind documentation site](developer-framework-dropdown.gif){fig-alt="A gif showcasing the new developer framework dropdown menu on the ValidMind documentation site" .screenshot} - + - **New dropdown for the {{< var validmind.developer >}}** that gives faster access to the most important bits, such as our code samples and the reference documentation — Click on **{{< fa cube >}} Developer** in the top navigation bar to see it in action! - **Publication date** for each page that reflects the last time the source file was touched. - **Previous and next topic footers** for related topics that make it easier to keep reading. - - **Expanded overview** for key ValidMind concepts with some additional information. + - **Expanded overview** for key {{< var vm.product >}} concepts with some additional information. - **Lighter background for diagrams** that improves legibility. {{< include /releases/_how-to-upgrade.qmd >}} diff --git a/site/releases/2023/release-notes-2023-jul-24.qmd b/site/releases/2023/release-notes-2023-jul-24.qmd index 47ac83d81f..4436547b62 100644 --- a/site/releases/2023/release-notes-2023-jul-24.qmd +++ b/site/releases/2023/release-notes-2023-jul-24.qmd @@ -14,7 +14,7 @@ Moreover, we've upgraded our {{< var vm.platform >}} with several major new feat - **Renamed Client Integration page to Getting Started**. To better reflect when you use the credentials to generate model documentation with the {{< var validmind.developer >}}, we have renamed the **Client Integration** page to **Getting Started**. - **Improved activity widget.** We enhanced the user interface with new tabs, enabling you to filter events based on activity type. -- **Improved Findings section and Findings Details page.** We made UI enhancements for both model findings and the findings details sections for a better look and feel. +- **Improved Findings section and Findings Details page.** We made enhancements to the {{< var validmind.platform >}} for both model findings and the findings details sections for a better look and feel. - **Refined Models and Projects lists.** We refined the user interface, featuring more intuitive default sorting and more user-friendly filtering. ::: ::: {.w-40-ns .tc} -[Install and initialize the client library](/developer/model-documentation/install-and-initialize-client-library.qmd){.button} +[Install and initialize the {{< var validmind.developer >}}](/developer/model-documentation/install-and-initialize-validmind-library.qmd){.button} [View model activity](/guide/model-inventory/view-model-activity.qmd){.button} diff --git a/site/releases/2023/release-notes-2023-jun-22.qmd b/site/releases/2023/release-notes-2023-jun-22.qmd index bcd0bddda1..37d12f9177 100644 --- a/site/releases/2023/release-notes-2023-jun-22.qmd +++ b/site/releases/2023/release-notes-2023-jun-22.qmd @@ -17,7 +17,7 @@ In addition, this release also includes a new notebook to illustrate support for :::: {.flex .flex-wrap .justify-around} ::: {.w-70-ns} -With support for custom tests, you can now go beyond the default set of documentation and testing components provided by ValidMind, and use our {{< var vm.developer >}} to document any type of model or use case. +With support for custom tests, you can now go beyond the default set of documentation and testing components provided by {{< var vm.product >}}, and use our {{< var vm.developer >}} to document any type of model or use case. ::: @@ -46,7 +46,7 @@ With test providers, you can now integrate external test libraries to expand the :::: - This enables registering custom tests under a namespace to make them available globally. -- We provide a couple of demo scenarios with such test providers and show how you can register them with ValidMind so that they can run a template utilizing your tests. +- We provide a couple of demo scenarios with such test providers and show how you can register them with {{< var vm.product >}} so that they can run a template utilizing your tests. #### Simplified documentation and testing using templates @@ -55,13 +55,13 @@ Templates now function as dynamic test suites, allowing you to identify all the This makes it easier to fill a pre-configured template (including boilerplates and spaces designated for documentation and test results) with a single command, instead of running multiple test suites. ::: {.tc} -[Get started with the {{< var validmind.developer >}}](/developer/get-started-developer-framework.qmd){.button} +[Get started with the {{< var validmind.developer >}}](/developer/get-started-validmind-library.qmd){.button} ::: #### New notebook to illustrate natural language processing (NLP) data analysis and text classification use case -Learn how to use the ValidMind Framework to document and test an NLP data analysis and text classification model. The emphasis of this notebook is on documenting and testing the in-depth analysis and preprocessing of the text data, in this case, COVID-19 related tweets. +Learn how to use the {{< var validmind.developer >}} to document and test an NLP data analysis and text classification model. The emphasis of this notebook is on documenting and testing the in-depth analysis and preprocessing of the text data, in this case, COVID-19 related tweets. ### {{< var validmind.platform >}} @@ -81,7 +81,7 @@ You can now edit the documentation templates that get used for model documentati :::: -- This feature is relevant for administrators who need to configure templates for specific use cases, or where the existing templates supplied by ValidMind need to be customized. +- This feature is relevant for administrators who need to configure templates for specific use cases, or where the existing templates supplied by {{< var vm.product >}} need to be customized. - Editing allows to configure sections, sub-sections, and content blocks inside a template. #### Improved search diff --git a/site/releases/2024-aug-13/release-notes.qmd b/site/releases/2024-aug-13/release-notes.qmd index d592895954..495d5e5a11 100644 --- a/site/releases/2024-aug-13/release-notes.qmd +++ b/site/releases/2024-aug-13/release-notes.qmd @@ -7,7 +7,7 @@ filters: ## Release highlights -This release brings many user experience upgrades to ValidMind, including customization for your {{< var vm.platform >}} dashboard, support for more input types in comparison tests within the {{< var vm.developer >}}, and model dependency management. +This release brings many user experience upgrades to {{< var vm.product >}}, including customization for your {{< var vm.platform >}} dashboard, support for more input types in comparison tests within the {{< var vm.developer >}}, and model dependency management. -#### Developer framework documentation inputs tracking + +#### {{< var validmind.developer >}} documentation inputs tracking :::: {.flex .flex-wrap .justify-around} @@ -181,36 +181,16 @@ To enable model developers to know what task types and tags are available to fil ### {{< var validmind.platform >}} (v1.13.13) - + #### Updated events to show users - + -We now display the name of the user who ran the action instead of a generic "Developer Framework" name whenever you generate documentation: - -:::: {.flex .flex-wrap .justify-around} - -::: {.w-40-ns} - -##### Before +We now display the name of the user who ran the action instead of a generic "{{< var validmind.developer >}}" name whenever you generate documentation: -![Old indicator defaulting to the developer framework logging an event](actions-before.png){fig-alt="Screenshot of the old indicator defaulting to the developer framework logging an event" .screenshot} - -::: - -::: {.w-40-ns} - -##### After - - - -![New indicator specifying the user who made updates via the developer framework](actions-after.png){fig-alt="Screenshot of the new indicator specifying the user who made updates via the developer framework" .screenshot} - -::: - -:::: +![New indicator specifying the user who made updates via the {{< var validmind.developer >}}](actions-after.png){width=90% fig-alt="Screenshot of the new indicator specifying the user who made updates via the ValidMind Library" .screenshot} #### Simplified instructions for developers @@ -224,7 +204,7 @@ We simplified the instructions for getting started with the {{< var validmind.de ::: {.w-40-ns} -[Install and initalize the client library](/developer/model-documentation/install-and-initialize-client-library.qmd){.button} +[Install and initalize the {{< var validmind.developer >}}](/developer/model-documentation/install-and-initialize-validmind-library.qmd){.button} ::: @@ -405,7 +385,7 @@ We implemented a toggle feature in the **Model Activity** and Recent Activity se :::: {.flex .flex-wrap .justify-around} ::: {.w-70-ns} -- Our user guide now includes end-to-end instructions for managing users on the ValidMind platform. +- Our user guide now includes end-to-end instructions for managing users on the {{< var validmind.platform >}}. - This new content covers common tasks such as inviting new users, adding them to user groups, and managing roles and permissions. ::: diff --git a/site/releases/2024-jan-18/highlights.qmd b/site/releases/2024-jan-18/highlights.qmd index da0c91cba9..8b17d6d559 100644 --- a/site/releases/2024-jan-18/highlights.qmd +++ b/site/releases/2024-jan-18/highlights.qmd @@ -39,11 +39,11 @@ Here is how the available themes look side by side: ::: grid ::: g-col-5 -![Light mode](light-mode.png){fig-alt="The ValidMind Platform UI in light mode" .screenshot .screenshot} +![Light mode](light-mode.png){fig-alt="The ValidMind Platform in light mode" .screenshot .screenshot} ::: ::: g-col-5 -![Dark mode](dark-mode.png){fig-alt="The ValidMind Platform UI in dark mode" .screenshot .screenshot} +![Dark mode](dark-mode.png){fig-alt="The ValidMind Platform in dark mode" .screenshot .screenshot} ::: ::: @@ -59,7 +59,7 @@ The selected theme setting is saved to your user profile and applied across all -- We continue to make easier to set up and administer ValidMind for members in your organization. +- We continue to make easier to set up and administer {{< var vm.product >}} for members in your organization. - In this release, we are introducing new user and group management features that are available right in the {{< var vm.platform >}}. :::: {.flex .flex-wrap .justify-around} diff --git a/site/releases/2024-jan-26/highlights.qmd b/site/releases/2024-jan-26/highlights.qmd index 8c10d8885e..d687996664 100644 --- a/site/releases/2024-jan-26/highlights.qmd +++ b/site/releases/2024-jan-26/highlights.qmd @@ -327,9 +327,9 @@ The {{< var validmind.developer >}} now supports passing custom inputs[^3] as an :::: -#### Removed deprecated high-level API methods +#### Removed deprecated {{< var validmind.api >}} methods -The API methods `run_template` and `run_test_plan` had been deprecated previously. They have now been removed from the {{< var validmind.developer >}}. +The {{< var vm.api >}} methods `run_template` and `run_test_plan` had been deprecated previously. They have now been removed from the {{< var validmind.developer >}}. You'll need to update your code to use the recommended high-level API methods: diff --git a/site/releases/2024-jul-22/release-notes.qmd b/site/releases/2024-jul-22/release-notes.qmd index e90d56601b..cbb157262b 100644 --- a/site/releases/2024-jul-22/release-notes.qmd +++ b/site/releases/2024-jul-22/release-notes.qmd @@ -10,14 +10,14 @@ listing: # image-height: 100% contents: - path: ../../training/training.qmd - title: "Try out ValidMind Academy" + title: "Try out {{< var validmind.training >}}" description: "Our training modules are interactive. They combine instructional content with our live product and are easy to use." fields: [title, description] --- ## Release highlights -On top of our increased support for tests and arrays in the {{< var validmind.developer >}} and our first ValidMind Academy training modules, we've introduced customizable model workflows, new role functionality, and new report types. +On top of our increased support for tests and arrays in the {{< var validmind.developer >}} and our first {{< var validmind.training >}} training modules, we've introduced customizable model workflows, new role functionality, and new report types. ### Customizable model workflows -You can now manage lifecycle processes within your ValidMind Platform UI setup using customizable model workflows. +You can now manage lifecycle processes within your {{< var validmind.platform >}} setup using customizable model workflows. :::: {.flex .flex-wrap .justify-around} @@ -212,7 +212,7 @@ Labels: enhancement +We expanded support for figures and plots when using {{< var vm.product >}} AI interpretations and risk assessments. --> @@ -292,7 +292,7 @@ Labels: documentation ---> ### New training collateral -We're introducing the first training modules that are part of our ValidMind Academy training program for: +We're introducing the first training modules that are part of our {{< var validmind.training >}} training program for: :::: {.flex .flex-wrap .justify-around} diff --git a/site/releases/2024-mar-27/highlights.qmd b/site/releases/2024-mar-27/highlights.qmd index cc1096b54a..396874360a 100644 --- a/site/releases/2024-mar-27/highlights.qmd +++ b/site/releases/2024-mar-27/highlights.qmd @@ -7,7 +7,7 @@ filters: ## Release highlights -This extensive release brings many improvements ValidMind, from the display of new metadata for test results in the {{< var vm.developer >}}, to two new core features of {{< var vm.platform >}} — **Model Findings** and **Reports** pages, and many more! +This extensive release brings many improvements {{< var vm.product >}}, from the display of new metadata for test results in the {{< var vm.developer >}}, to two new core features of {{< var vm.platform >}} — **Model Findings** and **Reports** pages, and many more! ### {{< var validmind.developer >}} (v2.0.0) @@ -46,7 +46,7 @@ Test result metadata is available directly in your model documentation: #### New Model Findings & Reports pages -We're introducing two important new features to our platform: +We're introducing two important new features to the {{< var validmind.platform >}}: - **Model Findings** - **Reports** @@ -242,14 +242,14 @@ Combined, these changes make it easier to see both pending and accepted invitati :::: {.flex .flex-wrap .justify-around} -::: {.w-60-ns} -We introduced the option to log in to ValidMind using SSO. +::: {.w-70-ns} +We introduced the option to log in to {{< var vm.product >}} using SSO. ::: -::: {.w-40-ns} +::: {.w-30-ns .tl} -[Log in to ValidMind](/guide/configuration/log-in-to-validmind.qmd){.button} +[Log in to {{< var vm.product >}}](/guide/configuration/log-in-to-validmind.qmd){.button} ::: @@ -260,8 +260,8 @@ Single sign on (SSO) allows your enterprise organizations to have a centralized In order for this feature to be enabled for your organization, we can configure our Auth0 authentication provider to integrate with your organization's identity provider. The steps required to make SSO available include: 1. Creating an Auth0 Enterprise SAML connection to your organization's identity provider -2. Configuring your organizations identity provider and adding a new SSO application for ValidMind -3. Enabling SSO on the ValidMind backend by associating the domain and the Auth0 SAML connection with your organization +2. Configuring your organizations identity provider and adding a new SSO application for {{< var vm.product >}} +3. Enabling SSO on the {{< var vm.product >}} backend by associating the domain and the Auth0 SAML connection with your organization -#### UI showing incorrect message to edit text +#### {{< var validmind.platform >}} showing incorrect message to edit text - Fixed an issue where users would see a message reading "Start editing by typing here ..." even when they didn't have permissions to edit documentation for the given model. - This message is now no longer displayed. @@ -393,7 +393,7 @@ No Findings Report display :::: {.flex .flex-wrap .justify-around} ::: {.w-80-ns} -- The main user guides section of our documentation site now features a new landing page that organizes common tasks by product area to assist with setting up ValidMind in a production environment. +- The main user guides section of our documentation site now features a new landing page that organizes common tasks by product area to assist with setting up {{< var vm.product >}} in a production environment. - A redesigned left sidebar enhances navigation through content by product area or major feature, simplifying the search for relevant information based on your role or interest in specific product features. ::: @@ -429,7 +429,7 @@ The user guide sections for working with model documentation and preparing valid ::: {.w-60-ns} - A new QuickStart is available for first-time users that shows you how to run our introductory Jupyter Notebook locally in your own developer environment. -- We also removed the option to try out ValidMind in Docker. JupyterHub and Google Colab remain available as other QuickStart options to try. +- We also removed the option to try out {{< var vm.product >}} in Docker. JupyterHub and Google Colab remain available as other QuickStart options to try. ::: ::: {.w-40-ns} diff --git a/site/releases/2024-may-22/release-notes.qmd b/site/releases/2024-may-22/release-notes.qmd index 51cafe3b10..8dcd69e6ab 100644 --- a/site/releases/2024-may-22/release-notes.qmd +++ b/site/releases/2024-may-22/release-notes.qmd @@ -10,7 +10,7 @@ listing: # image-height: 100% contents: - path: ../../training/training.qmd - title: "Try out ValidMind Academy" + title: "Try out {{< var validmind.training >}}" description: "Our training modules are interactive. They combine instructional content with our live product and are easy to use." fields: [title, description] --- @@ -128,7 +128,7 @@ Labels: enhancement, highlight ::: {.w-70-ns} -We introduced a new `metric` decorator that turns any function into a ValidMind Test that you can use in your documentation. To learn what this decorator can do for you, try our code sample on JupyterHub! +We introduced a new `metric` decorator that turns any function into a {{< var vm.product >}} test that you can use in your documentation. To learn what this decorator can do for you, try our code sample on JupyterHub! ::: @@ -140,7 +140,7 @@ We introduced a new `metric` decorator that turns any function into a ValidMind :::: -- Custom tests offer added flexibility. They allow you to extend the library of default tests provided by ValidMind which enables you to document any type of model or use case. +- Custom tests offer added flexibility. They allow you to extend the library of default tests provided by {{< var vm.product >}} which enables you to document any type of model or use case. - This new decorator simplifies creating and using custom tests by almost completely eliminating the boilerplate code required to define and register a custom test. ### Create composite tests -ValidMind now supports the ability to compose multiple Unit Tests into complex outputs. +{{< var vm.product >}} now supports the ability to compose multiple Unit Tests into complex outputs. - Create composite tests by combining multiple individual unit tests. - These composite tests can be logged as a single result that can be used as a content block in your documentation. @@ -551,7 +551,7 @@ Labels: enhancement :::: {.flex .flex-wrap .justify-around} ::: {.w-60-ns} -- Continuing our efforts to simplify the process for getting your custom code working in ValidMind, we now support functional tests for internal tests and test providers. +- Continuing our efforts to simplify the process for getting your custom code working in {{< var vm.product >}}, we now support functional tests for internal tests and test providers. - Functional tests are tests that can be defined as pure functions without any boilerplate. ::: @@ -616,7 +616,7 @@ We added support for assigning `prediction_probabilities` to `assign_predictions :::: -- Assign prediction values and probabilities that have been computed outside ValidMind. +- Assign prediction values and probabilities that have been computed outside {{< var vm.product >}}. - Incorporate prediction values and probabilities from datasets that already have prediction columns. - Automate the assignment of prediction values and probabilities within VM. @@ -912,9 +912,9 @@ Labels: documentation ---> ### Improved site navigation with new "About" section -![ValidMind docs site showing the new About section](about-section.png){fig-alt="A screenshot of the ValidMind docs site showing the new About section" .screenshot} +![{{< var vm.product >}} docs site showing the new About section](about-section.png){fig-alt="A screenshot of the ValidMind docs site showing the new About section" .screenshot} -#### About ValidMind +#### About {{< var vm.product >}} :::: {.flex .flex-wrap .justify-around} @@ -925,7 +925,7 @@ We've revamped our documentation for a cleaner, more intuitive experience. The u ::: ::: {.w-30-ns} -[About ValidMind](/about/overview.qmd){.button} +[About {{< var vm.product >}}](/about/overview.qmd){.button} ::: @@ -941,38 +941,38 @@ We've revamped our documentation for a cleaner, more intuitive experience. The u :::: {.flex .flex-wrap .justify-around} ::: {.w-70-ns} -Find a brand new set of guides on **contributing** to our open source software. Learn how to engage with the ValidMind community, read about our brand voice and vision, and more: +Find a brand new set of guides on **contributing** to our open source software. Learn how to engage with the {{< var vm.product >}} community, read about our brand voice and vision, and more: ::: ::: {.w-30-ns} -[ValidMind community](/about/contributing/validmind-community.qmd){.button} +[{{< var vm.product >}} community](/about/contributing/validmind-community.qmd){.button} ::: :::: -- **ValidMind community:** You're part of the ValidMind community. Come learn and play with us. -- **ValidMind style guide:** Check out the first official version of the ValidMind style guide. +- **{{< var vm.product >}} community:** You're part of the {{< var vm.product >}} community. Come learn and play with us. +- **{{< var vm.product >}} style guide:** Check out the first official version of the {{< var vm.product >}} style guide. -#### ValidMind style guide +#### {{< var vm.product >}} style guide :::: {.flex .flex-wrap .justify-around} ::: {.w-70-ns} -Check out the first official version of the **ValidMind style guide**! +Check out the first official version of the **{{< var vm.product >}} style guide**! ::: ::: {.w-30-ns} -[ValidMind style guide](/about/contributing/style-guide/style-guide.qmd){.button} +[{{< var vm.product >}} style guide](/about/contributing/style-guide/style-guide.qmd){.button} ::: :::: -- Learn about the ValidMind voice +- Learn about the {{< var vm.product >}} voice - Understand our shared vision and goals - See our reference for formatting conventions @@ -991,7 +991,7 @@ Many of our Jupyter Notebooks have received improvements to make them easier to ::: ::: {.w-30-ns} -[Try ValidMind on JupyterHub](https://jupyterhub.validmind.ai/){.button} +[Try {{< var vm.product >}} on JupyterHub](https://jupyterhub.validmind.ai/){.button} ::: @@ -1033,7 +1033,7 @@ You can now access the QuickStart directly from the **homepage of our docs site* #### New QuickStart video -A new three-minute video walks you through documenting a model with ValidMind and is now included in the QuickStart for JupyterHub: +A new three-minute video walks you through documenting a model with {{< var vm.product >}} and is now included in the QuickStart for JupyterHub: {{< video https://www.youtube.com/embed/rIR8Mql7eGs?si=vnZA_zP4tAjFjI4r title='ValidMind QuickStart' >}} @@ -1047,7 +1047,7 @@ Labels: documentation :::: {.flex .flex-wrap .justify-around} ::: {.w-50-ns} -We added getting started information for the new ValidMind sandbox environment, which is currently available on request. You can use the sandbox to gain hands-on experience and explore what ValidMind has to offer. +We added getting started information for the new {{< var vm.product >}} sandbox environment, which is currently available on request. You can use the sandbox to gain hands-on experience and explore what {{< var vm.product >}} has to offer. ::: ::: {.w-50-ns} diff --git a/site/releases/2024-oct-22/release-notes.qmd b/site/releases/2024-oct-22/release-notes.qmd index 28f22f1653..076fd9e4c4 100644 --- a/site/releases/2024-oct-22/release-notes.qmd +++ b/site/releases/2024-oct-22/release-notes.qmd @@ -10,7 +10,7 @@ listing: # image-height: 100% contents: - path: ../../training/training.qmd - title: "Try out ValidMind Academy" + title: "Try out {{< var validmind.training >}}" description: "Our training modules are interactive. They combine instructional content with our live product and are easy to use." fields: [title, description] --- @@ -31,9 +31,9 @@ Labels: documentation ---> ### Support for ongoing monitoring -Monitoring is a critical component of model risk management, as emphasized in regulations such as SR 11-7, SS1/23, and E-24. With this release of ValidMind, we officially support ongoing monitoring. You can enable this feature for both existing and new models. +Monitoring is a critical component of model risk management, as emphasized in regulations such as SR 11-7, SS1/23, and E-24. With this release of {{< var vm.product >}}, we officially support ongoing monitoring. You can enable this feature for both existing and new models. -![Ongoing monitoring of a model](/releases/2024-oct-22/358433496-02a6d5b9-0521-4110-b45c-b91e06798a97.png){fig-alt="An image showing some ongoing monitoring data on the ValidMind platform" .screenshot} +![Ongoing monitoring of a model](/releases/2024-oct-22/358433496-02a6d5b9-0521-4110-b45c-b91e06798a97.png){fig-alt="An image showing some ongoing monitoring data on the ValidMind Platform" .screenshot} Scenarios where ongoing monitoring is warranted: @@ -46,7 +46,7 @@ The monitoring template for your model automatically populates with data as your :::: {.flex .flex-wrap .justify-around} ::: {.w-70-ns} -To start uploading ongoing monitoring results for a model to ValidMind, you enable monitoring in your code and then select a monitoring template. Our user guide can walk you through the process of setting up ongoing monitoring step-by-step. +To start uploading ongoing monitoring results for a model to {{< var vm.product >}}, you enable monitoring in your code and then select a monitoring template. Our user guide can walk you through the process of setting up ongoing monitoring step-by-step. ::: ::: {.w-30-ns .tc} @@ -171,13 +171,13 @@ You now can add `Metrics Over Time` blocks to model documentation or as part of :::: {.flex .flex-wrap .justify-around} ::: {.w-50-ns .pr2 .tc} -![Adding a `Metric Over Time` block to model documentation](/releases/2024-oct-22/366145578-ce832e92-b8f2-47f1-b2f8-5d4b299fbe4a.png){fig-alt="A screenshot of the ValidMind UI that shows the new Metric Over time option when adding a new block to model documentation" .screenshot} +![Adding a `Metric Over Time` block to model documentation](/releases/2024-oct-22/366145578-ce832e92-b8f2-47f1-b2f8-5d4b299fbe4a.png){fig-alt="A screenshot of the ValidMind Platform that shows the new Metric Over time option when adding a new block to model documentation" .screenshot} -![Selecting one of the available blocks](/releases/2024-oct-22/366145581-b2afc5aa-5a37-4639-8f11-63fea34191c7.png){fig-alt="A screenshot of the ValidMind UI that shows the available blocks you can choose from when adding a new block to model documentation" .screenshot} +![Selecting one of the available blocks](/releases/2024-oct-22/366145581-b2afc5aa-5a37-4639-8f11-63fea34191c7.png){fig-alt="A screenshot of the ValidMind Platform that shows the available blocks you can choose from when adding a new block to model documentation" .screenshot} ::: ::: {.w-50-ns .pl2 .tc} -![Metric over time graph in model documentation](/releases/2024-oct-22/366145585-937d5018-ee21-47df-b9d2-b2da5125046d.png){fig-alt="A screenshot of the ValidMind UI that shows a graph for Metric Over time output" .screenshot} +![Metric over time graph in model documentation](/releases/2024-oct-22/366145585-937d5018-ee21-47df-b9d2-b2da5125046d.png){fig-alt="A screenshot of the ValidMind Platform that shows a graph for Metric Over time output" .screenshot} ::: :::: @@ -243,14 +243,14 @@ This update enhances the user experience by introducing a new email verification ::: ::: {.w-30-ns .tc} -[Register with ValidMind](/guide/configuration/register-with-validmind.qmd){.button} +[Register with {{< var vm.product >}}](/guide/configuration/register-with-validmind.qmd){.button} ::: :::: -If you need to verify your email address but have been unable to do so, this page allows you to resend the verification email and navigate to the dashboard to access ValidMind once verification is complete. +If you need to verify your email address but have been unable to do so, this page allows you to resend the verification email and navigate to the dashboard to access {{< var vm.product >}} once verification is complete. ### Updated training content -Our training modules now feature ValidMind's new color scheme, making them more visually appealing and easier to use. +Our training modules now feature {{< var vm.product >}}'s new color scheme, making them more visually appealing and easier to use. :::: {.flex .flex-wrap .justify-around} @@ -540,7 +540,7 @@ Labels: documentation ---> ### Adding tests video -We added a short FAQ-style video to show you how to find the tests ValidMind provides and add them to your own model documentation. +We added a short FAQ-style video to show you how to find the tests {{< var vm.product >}} provides and add them to your own model documentation. {{< video https://www.youtube.com/embed/5J7wysDIXgI?si=KPkFhx3O6NknijRf title='How do I add tests?' >}} @@ -554,7 +554,7 @@ Labels: documentation :::: {.flex .flex-wrap .justify-around} ::: {.w-70-ns} -We expanded our documentation on deployment options for ValidMind. +We expanded our documentation on deployment options for {{< var vm.product >}}. ::: @@ -563,7 +563,7 @@ We expanded our documentation on deployment options for ValidMind. ::: :::: -You can now find detailed information on both multi-tenant cloud and single-tenant options, giving you more clarity on how to deploy ValidMind based on your needs. +You can now find detailed information on both multi-tenant cloud and single-tenant options, giving you more clarity on how to deploy {{< var vm.product >}} based on your needs. -### Generate with ValidMind AI +### Generate with {{< var vm.product >}} AI ![Content editing toolbar with the Generate with AI button on the right](generate-with-ai.png){width="80%" fig-alt="A screenshot showing the content editing toolbar with the Generate with AI button on the right" .screenshot} @@ -27,7 +27,7 @@ Our new **{{< fa diamond >}} [beta]{.smallcaps} (Generate Text with A - Provide an optional prompt to guide the output, then click **{{< fa check >}} Generate** to compose a draft for review. - You can choose to **{{< fa download >}} Accept Text** to insert the draft into your text block, or **{{< fa rotate >}} Try Again** to regenerate a different copy. -![ValidMind AI Content Builder modal with the optional prompt box](generate-ai-prompt.png){width=90% fig-alt="A screenshot showing the ValidMind AI Content Builder modal with the optional prompt box" .screenshot} +![{{< var vm.product >}} AI Content Builder modal with the optional prompt box](generate-ai-prompt.png){width=90% fig-alt="A screenshot showing the ValidMind AI Content Builder modal with the optional prompt box" .screenshot} ::: diff --git a/site/releases/_how-to-upgrade.qmd b/site/releases/_how-to-upgrade.qmd index 0c43ab3294..561c30ce0d 100644 --- a/site/releases/_how-to-upgrade.qmd +++ b/site/releases/_how-to-upgrade.qmd @@ -4,14 +4,14 @@ #### {{< var validmind.platform >}} -To access the latest version of the {{< var validmind.platform >}},^[[Log in to ValidMind](/guide/configuration/log-in-to-validmind.qmd)] hard refresh your browser tab: +To access the latest version of the {{< var validmind.platform >}},^[[Log in to {{< var vm.product >}}](/guide/configuration/log-in-to-validmind.qmd)] hard refresh your browser tab: - **Windows:** `Ctrl` + `Shift` + `R` OR `Ctrl` + `F5` - **MacOS:** `⌘ Cmd` + `Shift` + `R` OR hold down `⌘ Cmd` and click the `Reload` button #### {{< var validmind.developer >}} -To upgrade to the latest version of the {{< var validmind.developer >}}:^[[Get started with the {{< var validmind.developer >}}](/developer/get-started-developer-framework.qmd)] +To upgrade the {{< var validmind.developer >}}:^[[Get started with the {{< var validmind.developer >}}](/developer/get-started-validmind-library.qmd)] 1. In your Jupyter Notebook: diff --git a/site/styles.css b/site/styles.css index 2873a5c4bd..30d017bbde 100644 --- a/site/styles.css +++ b/site/styles.css @@ -18,6 +18,10 @@ html { scroll-behavior: smooth; } +body { + color: #1A202C; +} + a { color: #DE257E; text-decoration: none; @@ -33,17 +37,24 @@ a.footnote-ref:hover, a.anchorjs-link:hover { text-decoration: none; } -a.nav-link:hover, a.dropdown-item:hover, a.sidebar-link:hover { +a.nav-link:hover, a.sidebar-link:hover { text-decoration: none; color: #DE257E; } +a.dropdown-item:hover { + text-decoration: none; + color: #196972; + background-color: #EAF8FA; +} + /* NEW NAVBAR LINKS */ a.nav-link, a.dropdown-item { position: relative; } -a.nav-link:before, a.dropdown-item:before { +a.nav-link:not(nav#TOC a.nav-link):before, +a.dropdown-item:not(nav#TOC a.dropdown-item):before { content: ""; position: absolute; display: block; @@ -56,7 +67,8 @@ a.nav-link:before, a.dropdown-item:before { transition: transform 0.3s ease; } -a.nav-link:hover::before, a.dropdown-item:hover::before { +a.nav-link:not(nav#TOC a.nav-link):hover::before, +a.dropdown-item:not(nav#TOC a.dropdown-item):hover::before { transform: scaleX(1); } @@ -236,7 +248,6 @@ pre, pre.python, pre.bash, pre.yaml, pre.markdown { z-index: -1; } - .nav-item { padding-right: 15px; } @@ -330,7 +341,6 @@ input[type="checkbox"][checked] { animation: fadeUp 25s infinite; } - .image-container img:nth-child(1) { animation-delay: 0s; } @@ -526,6 +536,77 @@ figcaption { font-weight: bold; } +.sidebar-item .menu-text { + text-transform: uppercase; + color: #196972; +} + +.sidebar-item a .menu-text { + text-transform: none; + color: #585F60; +} + +.sidebar-item a:hover .menu-text { + text-transform: none; + color: #DE257E !important; +} + +.sidebar-item-container .sidebar-item-toggle { + cursor: pointer; + color: #083E44; +} + +hr.sidebar-divider.hi { + border-top: 1px solid #196972 !important; +} + +nav#TOC { + padding: 13px; + background-color: white; + border: 1px solid #bdc1c4; + /* border-bottom: 2px solid #196972; + border-right: 2px solid #196972; */ + border-radius: 3px; + background-color: #FAFBFB; +} + +nav#TOC h2#toc-title { + font-weight: bold; + color: #196972; +} + +nav#TOC ul > li > a.nav-link { + color: #585F60 !important; + text-decoration: none; +} + +nav#TOC ul > li > a.nav-link:hover, +nav#TOC ul > li > a.nav-link.active:hover { + color: #196972 !important; + background-color: #EAF8FA; + text-decoration: none; +} + +nav#TOC ul > li > a.nav-link.active, nav#TOC ul > li > a.nav-link.active:hover { + color: #DE257E !important; + text-decoration: none; +} + +nav#TOC .toc-actions ul li a.toc-action { + color: #196972; + text-decoration: none; + font-size: 0.9em; + margin-right: 1em; +} + +#quarto-sidebar.sidebar { + background-color: #FAFBFB; +} + +.sidebar-item .sidebar-item-container .sidebar-link.active .menu-text { + color: #DE257E !important; +} + .feature { color: #3E6C69; padding: 15px; @@ -536,8 +617,6 @@ figcaption { background-repeat: no-repeat; border-top: 2px solid #DE257E; text-align: justify; - /* width: 75%; */ - /* font-size: smaller; */ } .feature strong, .feature b, .feature dt { @@ -545,6 +624,52 @@ figcaption { font-weight: bolder; } +.gclose.gbtn { + background-color: #083E44; + border: 3px solid #de257e; +} + +.gclose.gbtn:hover { + background-color: #DE257E; +} + +.gclose.gbtn svg path { + fill: #de257e; +} + +.gclose.gbtn:hover svg path { + fill: white; +} + +.glightbox-clean .gdesc-inner { + background-color: #083E44; +} + +.gslide-description .gslide-title { + background-color: #083E44 !important; + color: white !important; +} + +.gnext.gbtn { + background-color: #DE257E; +} + +.gnext.gbtn, .gprev.gbtn { + background-color: #083E44; +} + +.gnext.gbtn:hover, .gprev.gbtn:hover { + background-color: #3E6C69; +} + +.gnext.gbtn svg path, .gprev.gbtn svg path { + fill: white; +} + +h2, .h2 { + border-bottom: 1px solid #196972; +} + /* section#footnotes { display: none !important; } diff --git a/site/support/support.qmd b/site/support/support.qmd index b062c99e86..39abdd4f95 100644 --- a/site/support/support.qmd +++ b/site/support/support.qmd @@ -19,7 +19,7 @@ listing: fields: [title, description] --- -Our support team can provide you with quick and easy access to the resources you need to troubleshoot technical issues and help you get the most out of the {{< var validmind.product >}}. +Our support team can provide you with quick and easy access to the resources you need to troubleshoot technical issues and help you get the most out of {{< var vm.product >}}. diff --git a/site/support/troubleshooting.qmd b/site/support/troubleshooting.qmd index 6946a9e158..150389b7bc 100644 --- a/site/support/troubleshooting.qmd +++ b/site/support/troubleshooting.qmd @@ -28,7 +28,7 @@ Learn how to resolve commonly encountered issues with the {{< var validmind.prod You cannot access functionality described in our user guides or recent releases. ### Fix -Make sure you are running most recent versions of ValidMind,[^1] and have the proper permissions assigned.[^2] +Make sure you are running most recent versions of {{< var vm.product >}},[^1] and have the proper permissions assigned.[^2] ## Cannot install the {{< var validmind.developer >}} @@ -43,7 +43,7 @@ Make sure you are installing the latest version of the {{< var vm.developer >}}[ ``` -## Cannot initialize ValidMind client library +## Cannot initialize the {{< var validmind.developer >}} ### Issue When you run `vm.init()`, you encounter an error message like this: @@ -61,7 +61,7 @@ or ### Fix Make sure that you are using the correct initialization credentials for the model you are trying to connect to. -Follow the steps in [Install and initialize the client library](/developer/model-documentation/install-and-initialize-client-library.qmd) for detailed instructions on how to integrate the {{< var vm.developer >}} and upload to the {{< var vm.platform >}}. +Follow the steps in [Install and initialize the {{< var validmind.developer >}}](/developer/model-documentation/install-and-initialize-validmind-library.qmd) for detailed instructions on how to integrate the {{< var vm.developer >}} and upload to the {{< var vm.platform >}}. {{< include /releases/_how-to-upgrade.qmd >}} @@ -78,4 +78,4 @@ Follow the steps in [Install and initialize the client library](/developer/model [^2]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^3]: [Upgrade ValidMind](/developer/model-documentation/install-and-initialize-client-library.qmd#upgrade-validmind) +[^3]: [Upgrade {{< var vm.product >}}](/developer/model-documentation/install-and-initialize-validmind-library.qmd#upgrade) diff --git a/site/training/_training-register.qmd b/site/training/_training-register.qmd index 1be00bef88..9c0ba675fd 100644 --- a/site/training/_training-register.qmd +++ b/site/training/_training-register.qmd @@ -6,8 +6,8 @@ 2. **When you receive your access credentials**, make sure you can log in: - - **ValidMind JupyterHub** — - - **{{< var validmind.platform >}}** — [{{< var url.us1 >}}]({{< var url.us1 >}})^[[Log in to ValidMind](/guide/configuration/log-in-to-validmind.qmd#public-internet)] + - **{{< var vm.product >}} JupyterHub** — + - **{{< var validmind.platform >}}** — [{{< var url.us1 >}}]({{< var url.us1 >}})^[[Log in to {{< var vm.product >}}](/guide/configuration/log-in-to-validmind.qmd#public-internet)] 3. **Join a free kick-off session**: Get an instructor-led hands-on demo. diff --git a/site/training/administrator-fundamentals/administrator-fundamentals-register.qmd b/site/training/administrator-fundamentals/administrator-fundamentals-register.qmd index df6a07dddf..029ae9b981 100644 --- a/site/training/administrator-fundamentals/administrator-fundamentals-register.qmd +++ b/site/training/administrator-fundamentals/administrator-fundamentals-register.qmd @@ -5,7 +5,7 @@ date: last-modified page-layout: full format: html: - css: [../assets/training.css, ../assets/training-nav.css] + css: ../assets/training.css filters: - tachyons - preview @@ -13,7 +13,7 @@ aliases: - training-for-administrators.html --- -As an administrator who is new to ValidMind, learn how to onboard your organization, manage users and roles, and manage permissions for specific roles. +As an administrator who is new to {{< var vm.product >}}, learn how to onboard your organization, manage users and roles, and manage permissions for specific roles. ::: {.attn} diff --git a/site/training/administrator-fundamentals/administrator-fundamentals.qmd b/site/training/administrator-fundamentals/administrator-fundamentals.qmd index e12f959fb1..4780314a15 100644 --- a/site/training/administrator-fundamentals/administrator-fundamentals.qmd +++ b/site/training/administrator-fundamentals/administrator-fundamentals.qmd @@ -13,7 +13,7 @@ format: preview-links: auto view-distance: 2 logo: /validmind.png - footer: "ValidMind Academy | [Home {{< fa person-walking-dashed-line-arrow-right >}}](/training/training.qmd)" + footer: "{{< var validmind.training >}} | [Home {{< fa person-walking-dashed-line-arrow-right >}}](/training/training.qmd)" title-slide-attributes: data-background-color: "#083E44" data-background-image: "../assets/home-hero.svg" @@ -23,7 +23,7 @@ filters: # Learning objectives -_"As an administrator who is new to ValidMind, I want to onboard my organization, manage users and roles, and manage permissions for specific roles."_ +_"As an administrator who is new to {{< var vm.product >}}, I want to onboard my organization, manage users and roles, and manage permissions for specific roles."_ ## In this course @@ -40,18 +40,18 @@ _"As an administrator who is new to ValidMind, I want to onboard my organization ::: :::: -First, let's make sure you can log in to ValidMind. +First, let's make sure you can log in to {{< var vm.product >}}. {{< include /training/assets/_revealjs-navigation.qmd >}} ## Can you log in? -To try out this course, you need to have been [onboarded](administrator-fundamentals-register.qmd#register) onto ValidMind Academy with the [**{{< fa hand >}} Customer Admin**]{.bubble} role. +To try out this course, you need to have been [onboarded](administrator-fundamentals-register.qmd#register) onto {{< var validmind.training >}} with the [**{{< fa hand >}} Customer Admin**]{.bubble} role.
Log in to check your access: ::: {.tc} -[Log in to ValidMind](https://app.prod.validmind.ai/){.button target="_blank"} +[Log in to {{< var vm.product >}}](https://app.prod.validmind.ai/){.button target="_blank"}
Be sure to return to this page afterwards. @@ -366,12 +366,12 @@ When you are done, click [{{< fa chevron-right >}}]() to continue. :::: ::: -# About administering ValidMind +# About administering {{< var vm.product >}} -There is much more that ValidMind can do to support you as an administrator of the platform, from customizing the model inventory, to setting up a private connection between ValidMind and your company network. +There is much more that {{< var vm.product >}} can do to support you as an administrator of the {{< var vm.platform >}}, from customizing the model inventory, to setting up a private connection between {{< var vm.product >}} and your company network. ::: {.tc} [All onboarding guides](/guide/guides.qmd#onboarding){.button target="_blank"} :::
-Or, find your next learning resource on [ValidMind Academy](/training/training.qmd). +Or, find your next learning resource on [{{< var validmind.training >}}](/training/training.qmd). diff --git a/site/training/assets/_revealjs-navigation.qmd b/site/training/assets/_revealjs-navigation.qmd index 2a37c012a0..3e09f5ced4 100644 --- a/site/training/assets/_revealjs-navigation.qmd +++ b/site/training/assets/_revealjs-navigation.qmd @@ -1,5 +1,5 @@ :::: {.tc .mt5 .f3 .embed} -Training is **interactive** —you explore ValidMind live. Try it! +Training is **interactive** — you explore {{< var vm.product >}} live. Try it! ::: {.f4} **→** , **↓** , **SPACE** , **N** — next slide     **←** , **↑** , **P** , **H** — previous slide     **?** — all keyboard shortcuts diff --git a/site/training/assets/training-nav.css b/site/training/assets/training-nav.css deleted file mode 100644 index 78c2314784..0000000000 --- a/site/training/assets/training-nav.css +++ /dev/null @@ -1,22 +0,0 @@ -.navbar { - background-color: #042426 !important; - background: url('../../assets/img/solutions-hero.png'); -} - -a.nav-link { - text-decoration: none; - color: #EAF8FA; -} - -a.nav-link:before, a.dropdown-item:before { - content: ""; - position: absolute; - display: block; - width: 100%; - height: 2px; - bottom: 0; - left: 0; - background-color: #EAF8FA; - transform: scaleX(0); - transition: transform 0.3s ease; -} \ No newline at end of file diff --git a/site/training/assets/training.css b/site/training/assets/training.css index 4d8953106c..86c34ec0db 100644 --- a/site/training/assets/training.css +++ b/site/training/assets/training.css @@ -20,6 +20,7 @@ a:hover { align-items: center; flex-direction: column; text-align: center; + background-size: cover; } #quarto-sidebar.sidebar { @@ -113,4 +114,26 @@ div.callout.callout { .quarto-listing-default { border: 1px solid #042426; +} + +.navbar { + background-color: #EAF8FA !important; +} + +nav#TOC ul > li > a.nav-link { + color: #3E6C69 !important; + text-decoration: none; +} + +nav#TOC ul > li > a.nav-link:hover, +nav#TOC ul > li > a.nav-link.active:hover { + color: #DE257E !important; + background-color: white; + text-decoration: none; +} + +a.dropdown-item:hover { + text-decoration: none; + color: #DE257E; + background-color: #B5B5B510; } \ No newline at end of file diff --git a/site/training/developer-fundamentals/developer-fundamentals-register.qmd b/site/training/developer-fundamentals/developer-fundamentals-register.qmd index 2d49038c51..55ce0122ab 100644 --- a/site/training/developer-fundamentals/developer-fundamentals-register.qmd +++ b/site/training/developer-fundamentals/developer-fundamentals-register.qmd @@ -5,7 +5,7 @@ date: last-modified page-layout: full format: html: - css: [../assets/training.css, ../assets/training-nav.css] + css: ../assets/training.css aliases: - training-for-model-developers.html filters: @@ -13,7 +13,7 @@ filters: - preview --- -As a developer who is new to ValidMind, learn how to generate model documentation, add your own tests, edit the content, and then submit your documentation for approval. +As a developer who is new to {{< var vm.product >}}, learn how to generate model documentation, add your own tests, edit the content, and then submit your documentation for approval. ::: {.attn} @@ -26,7 +26,7 @@ As a developer who is new to ValidMind, learn how to generate model documentatio #### Part 1 -- Initialize the developer framework +- Initialize the {{< var validmind.developer >}} - Start the model development process - Edit model documentation - Collaborate with others @@ -38,11 +38,6 @@ As a developer who is new to ValidMind, learn how to generate model documentatio - View documentation activity - Submit for approval -#### Duration - -90 minutes - -[register](#register){.button-green .cta} ::: ::: {.w-50-ns .pa3} @@ -50,6 +45,12 @@ As a developer who is new to ValidMind, learn how to generate model documentatio ::: {.preview source="developer-fundamentals.qmd"} ::: +#### Duration + +90 minutes + +[register](#register){.button-green .cta} + ::: :::: diff --git a/site/training/developer-fundamentals/developer-fundamentals.qmd b/site/training/developer-fundamentals/developer-fundamentals.qmd index 56065e1eb3..486827b928 100644 --- a/site/training/developer-fundamentals/developer-fundamentals.qmd +++ b/site/training/developer-fundamentals/developer-fundamentals.qmd @@ -15,7 +15,7 @@ format: preview-links: auto view-distance: 2 logo: /validmind.png - footer: "ValidMind Academy | [Home {{< fa person-walking-dashed-line-arrow-right >}}](/training/training.qmd)" + footer: "{{< var validmind.training >}} | [Home {{< fa person-walking-dashed-line-arrow-right >}}](/training/training.qmd)" title-slide-attributes: data-background-color: "#083E44" data-background-image: "../assets/home-hero.svg" @@ -25,7 +25,7 @@ filters: # Learning objectives -_"As a developer who is new to ValidMind, I want to learn how to generate model documentation, add my own tests, edit the content, and then submit my documentation for approval."_ +_"As a developer who is new to {{< var vm.product >}}, I want to learn how to generate model documentation, add my own tests, edit the content, and then submit my documentation for approval."_ ## In this course @@ -33,7 +33,7 @@ _"As a developer who is new to ValidMind, I want to learn how to generate model ::: {.column width="50%" .mt4} ### PART 1 -- [Initialize the developer framework](#initialize-the) +- [Initialize the {{< var validmind.developer >}}](#initialize-the) - [Start the model development process](#start-the-model-development-process) - [Edit model documentation](#edit-model-documentation) - [Collaborate with others](#collaborate-with-others) @@ -49,13 +49,13 @@ _"As a developer who is new to ValidMind, I want to learn how to generate model ::: :::: -First, let's make sure you can log in to ValidMind. +First, let's make sure you can log in to {{< var vm.product >}}. {{< include /training/assets/_revealjs-navigation.qmd >}} ## Can you log in? -To try out this course, you need to have been [onboarded](developer-fundamentals-register.qmd#register) onto ValidMind Academy with the [**{{< fa code >}} Developer**]{.bubble} role. +To try out this course, you need to have been [onboarded](developer-fundamentals-register.qmd#register) onto {{< var validmind.training >}} with the [**{{< fa code >}} Developer**]{.bubble} role.
Log in to check your access: @@ -68,7 +68,7 @@ To try out this course, you need to have been [onboarded](developer-fundamentals ::: ::: {.column width="50%"} ::: {.tc} -[Log in to ValidMind](https://app.prod.validmind.ai){.button target="_blank"} +[Log in to {{< var vm.product >}}](https://app.prod.validmind.ai){.button target="_blank"} ::: ::: @@ -90,7 +90,7 @@ Be sure to return to this page afterwards. **This introductory notebook includes sample code and how-to information, all in one place.** ::: {.f4} -When run on JupyterHub, this notebook will generate model documentation and upload it to ValidMind. After you finish this course, your own training notebook will look similar, complete with output. +When run on JupyterHub, this notebook will generate model documentation and upload it to {{< var vm.product >}}. After you finish this course, your own training notebook will look similar, complete with output. For now, **scroll through this notebook** to explore. When you are done, click [{{< fa chevron-right >}}]() to continue. ::: @@ -112,7 +112,7 @@ From here, you can: **To start the documentation process**, you register a
new model in the model inventory or select one that
has already been registered. ::: -**Explore ValidMind live** on the next page. {{< fa hand-point-right >}} +**Explore {{< var vm.product >}} live** on the next page. {{< fa hand-point-right >}} ::: ## {background-iframe="https://app.prod.validmind.ai/model-inventory" background-interactive="true" data-preload="yes"} @@ -173,7 +173,7 @@ When you reach **Add individual test results to model documentation**, return to :::: {.columns} ::: {.column width="30%" .pr4 .f2} -Now that you have generated documentation, edit it on ValidMind to add text or test-driven content blocks. +Now that you have generated documentation, edit it on {{< var vm.product >}} to add text or test-driven content blocks. ::: {.f5 .nt2 .pl2 .mb4} (Scroll down for the full instructions.) @@ -411,20 +411,20 @@ When you are done, click [{{< fa chevron-right >}}]() to continue. # About model documentation -There is more that ValidMind can do to help you create model documentation, from using your own template to code samples you can adapt for your own use case. +There is more that {{< var vm.product >}} can do to help you create model documentation, from using your own template to code samples you can adapt for your own use case. ::: {.tc} [All model documentation guides](/guide/guides.qmd#model-documentation){.button target="_blank"} :::
-Or, find your next learning resource on [ValidMind Academy](/training/training.qmd). +Or, find your next learning resource on [{{< var validmind.training >}}](/training/training.qmd). ::: {.attn} diff --git a/site/training/training-templates/course-slides.qmd b/site/training/training-templates/course-slides.qmd index 4871010c34..84fc88f4b6 100644 --- a/site/training/training-templates/course-slides.qmd +++ b/site/training/training-templates/course-slides.qmd @@ -17,7 +17,7 @@ format: preview-links: auto view-distance: 2 logo: /validmind.png - footer: "ValidMind Academy | [Home {{< fa person-walking-dashed-line-arrow-right >}}](/training/training.qmd)" + footer: "{{< var validmind.training >}} | [Home {{< fa person-walking-dashed-line-arrow-right >}}](/training/training.qmd)" title-slide-attributes: data-background-color: "#083E44" data-background-image: "../assets/home-hero.svg" @@ -27,7 +27,7 @@ filters: # Learning objectives -_"As a {{ role }} who is new to ValidMind, I want to learn how to {{ task A }}, {{ task B }}, {{ task C }}, and {{ task D}}."_ +_"As a {{ role }} who is new to {{< var vm.product >}}, I want to learn how to {{ task A }}, {{ task B }}, {{ task C }}, and {{ task D}}."_ ## In this course @@ -37,7 +37,7 @@ _"As a {{ role }} who is new to ValidMind, I want to learn how to {{ task A }}, 4. [Scrollable single user guide](#scrollable-single-user-guide) 5. [Scrollable tabset user guides](#scrollable-tabset-user-guide) -First, let's make sure you can log in to ValidMind. +First, let's make sure you can log in to {{< var vm.product >}}. {{< include /training/assets/_revealjs-navigation.qmd >}} @@ -45,12 +45,12 @@ First, let's make sure you can log in to ValidMind. -To try out this course, you need to have been [onboarded](course-registration.qmd#register) onto ValidMind Academy with the [**{{< fa check >}} Role Name**]{.bubble} role. +To try out this course, you need to have been [onboarded](course-registration.qmd#register) onto {{< var validmind.training >}} with the [**{{< fa check >}} Role Name**]{.bubble} role.
Log in to check your access: ::: {.tc} -[Log in to ValidMind](https://app.prod.validmind.ai/){.button target="_blank"} +[Log in to {{< var vm.product >}}](https://app.prod.validmind.ai/){.button target="_blank"}
Be sure to return to this page afterwards. @@ -63,7 +63,7 @@ Be sure to return to this page afterwards. ## {background-iframe="https://app.prod.validmind.ai/" data-preload="yes"} :::: {.fr .f3 .mv5 .nr4 .pa5 .overlay} -This is a right-aligned modal `.overlay`
on top of the live ValidMind Platform. +This is a right-aligned modal `.overlay`
on top of the live {{< var vm.product >}} Platform. - It mimics the style of the docs site callouts. - **Bold text shows up in a different colour.** @@ -191,7 +191,7 @@ Try it **live** on the next page. {{< fa hand-point-right >}} # Topic summary slide -Summarize the benefits of ValidMind for the role or topic you just covered here, then link to the relevant user guides below. +Summarize the benefits of {{< var vm.product >}} for the role or topic you just covered here, then link to the relevant user guides below. ::: {.tc} @@ -200,4 +200,4 @@ Summarize the benefits of ValidMind for the role or topic you just covered here, :::
-Or, find your next learning resource on [ValidMind Academy](/training/training.qmd). \ No newline at end of file +Or, find your next learning resource on [{{< var validmind.training >}}](/training/training.qmd). \ No newline at end of file diff --git a/site/training/training.qmd b/site/training/training.qmd index 2ce829565e..29c9bb389a 100644 --- a/site/training/training.qmd +++ b/site/training/training.qmd @@ -1,7 +1,8 @@ --- -pagetitle: "ValidMind Academy" +pagetitle: "{{< var validmind.training >}}" sidebar: false page-layout: full +repo-actions: false toc: false format: html: @@ -40,31 +41,31 @@ listing: - path: https://jupyterhub.validmind.ai/hub/user-redirect/lab/tree/quickstart_customer_churn_full_suite.ipynb title: "Quickstart for model documentation" subtitle: "Open notebook in JupyterHub {{< fa chevron-right >}}" - description: "Gets you started with the basic process of documenting models with ValidMind, from the {{< var vm.developer >}} to the {{< var vm.platform >}}." + description: "Gets you started with the basic process of documenting models with {{< var vm.product >}}, from the {{< var vm.developer >}} to the {{< var vm.platform >}}." categories: ["[Demo] Customer Churn Model"] reading-time: "10" - author: "ValidMind" + author: "{{< var vm.product >}}" - path: https://jupyterhub.validmind.ai/hub/user-redirect/lab/tree/tutorials/intro_for_model_developers.ipynb - title: "ValidMind introduction for model developers" + title: "{{< var vm.product >}} introduction for model developers" subtitle: "Open notebook in JupyterHub {{< fa chevron-right >}}" description: "Learn how the end-to-end documentation process works based on common scenarios you encounter in model development settings." categories: ["[Demo] Customer Churn Model"] reading-time: "27" - author: "ValidMind" + author: "{{< var vm.product >}}" - path: https://jupyterhub.validmind.ai/hub/user-redirect/lab/tree/code_samples/credit_risk/application_scorecard_demo.ipynb title: "Document an application scorecard model" subtitle: "Open notebook in JupyterHub {{< fa chevron-right >}}" description: "Guides you through building and documenting an application scorecard model using the Lending Club sample dataset from Kaggle." categories: ["[Demo] Credit Risk Model"] reading-time: "16" - author: "ValidMind" + author: "{{< var vm.product >}}" - path: https://jupyterhub.validmind.ai/hub/user-redirect/lab/tree/code_samples/nlp_and_llm/foundation_models_integration_demo.ipynb title: "Prompt validation for large language models (LLMs)" subtitle: "Open notebook in JupyterHub {{< fa chevron-right >}}" description: "Run and document prompt validation tests for a large language model (LLM) specialized in sentiment analysis for financial news." categories: ["[Demo] Foundation Model - Text Sentiment Analysis"] reading-time: "8" - author: "ValidMind" + author: "{{< var vm.product >}}" --- ::: {.column-screen} @@ -72,7 +73,7 @@ listing: ::: {.training-hero} :::: {.f1 .w-60} -**ValidMind Academy** +**{{< var validmind.training >}}** ::: :::: {.f4 .w-60} @@ -97,7 +98,7 @@ Our training environment mimics a production environment and includes comprehens Most of our model documentation features are available for you to test in the training environment, including automated model testing and documentation, preparing model validation reports, and large language model (LLM) support. -These features provide a rich context for testing and evaluation, using models and datasets provided by ValidMind and hosted in our own environment. +These features provide a rich context for testing and evaluation, using models and datasets provided by {{< var vm.product >}} and hosted in our own environment. ### Sample models diff --git a/site/training/validator-fundamentals/validator-fundamentals-register.qmd b/site/training/validator-fundamentals/validator-fundamentals-register.qmd index a5dd311910..96c9481b91 100644 --- a/site/training/validator-fundamentals/validator-fundamentals-register.qmd +++ b/site/training/validator-fundamentals/validator-fundamentals-register.qmd @@ -5,7 +5,7 @@ date: last-modified page-layout: full format: html: - css: [../assets/training.css, ../assets/training-nav.css] + css: ../assets/training.css aliases: - training-for-model-validators.html filters: @@ -13,7 +13,7 @@ filters: - preview --- -As a validator who is new to ValidMind, learn how to review model documentation, prepare your validation report, track issues, and submit your report for approval. +As a validator who is new to {{< var vm.product >}}, learn how to review model documentation, prepare your validation report, track issues, and submit your report for approval. ::: {.attn} diff --git a/site/training/validator-fundamentals/validator-fundamentals.qmd b/site/training/validator-fundamentals/validator-fundamentals.qmd index 16f4958f71..7dd885acc6 100644 --- a/site/training/validator-fundamentals/validator-fundamentals.qmd +++ b/site/training/validator-fundamentals/validator-fundamentals.qmd @@ -15,7 +15,7 @@ format: preview-links: auto view-distance: 2 logo: /validmind.png - footer: "ValidMind Academy | [Home {{< fa person-walking-dashed-line-arrow-right >}}](/training/training.qmd)" + footer: "{{< var validmind.training >}} | [Home {{< fa person-walking-dashed-line-arrow-right >}}](/training/training.qmd)" title-slide-attributes: data-background-color: "#083E44" data-background-image: "../assets/home-hero.svg" @@ -25,7 +25,7 @@ filters: # Learning objectives -_"As a validator who is new to ValidMind, I want to learn how to review model documentation, prepare my validation report, track issues, and submit my report for approval."_ +_"As a validator who is new to {{< var vm.product >}}, I want to learn how to review model documentation, prepare my validation report, track issues, and submit my report for approval."_ ## In this course @@ -35,18 +35,18 @@ _"As a validator who is new to ValidMind, I want to learn how to review model do - [Track issue resolution](#track-issue-resolution) - [Submit for review and approval](#submit-for-review-and-approval) -First, let's make sure you can log in to ValidMind. +First, let's make sure you can log in to {{< var vm.product >}}. {{< include /training/assets/_revealjs-navigation.qmd >}} ## Can you log in? -To try out this course, you need to have been [onboarded](validator-fundamentals-register.qmd#register) onto ValidMind Academy with the [**{{< fa circle-check >}} Validator**]{.bubble} role. +To try out this course, you need to have been [onboarded](validator-fundamentals-register.qmd#register) onto {{< var validmind.training >}} with the [**{{< fa circle-check >}} Validator**]{.bubble} role.
Log in to check your access: ::: {.tc} -[Log in to ValidMind](https://app.prod.validmind.ai/){.button target="_blank"} +[Log in to {{< var vm.product >}}](https://app.prod.validmind.ai/){.button target="_blank"}
Be sure to return to this page afterwards. @@ -55,7 +55,7 @@ Be sure to return to this page afterwards. -# You're in — let's show you around ValidMind. +# You're in — let's show you around {{< var vm.product >}}. ## {background-iframe="https://app.prod.validmind.ai" data-preload="yes"} @@ -433,19 +433,19 @@ When you are done, click [{{< fa chevron-right >}}]() to continue. # About validation reports -There is more that ValidMind can do to help you prepare validation reports, from using your own template to configuring the full approval workflow. +There is more that {{< var vm.product >}} can do to help you prepare validation reports, from using your own template to configuring the full approval workflow. ::: {.tc} [All model validation guides](/guide/guides.qmd#model-validation){.button target="_blank"} :::
-Or, find your next learning resource on [ValidMind Academy](/training/training.qmd). +Or, find your next learning resource on [{{< var validmind.training >}}](/training/training.qmd).