Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 2 additions & 2 deletions site-unused/before-you-begin.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Signing up is FREE — **[Create your account](https://app.prod.validmind.ai)**.

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

To connect the ValidMind Developer Framework to the ValidMind Platform and to access the web user interface, you must be able to access our domains:
To connect the {{< var vm_framework >}} to the ValidMind Platform and to access the web user interface, you must be able to access our domains:

- validmind.ai
- validmind.com
Expand All @@ -38,5 +38,5 @@ You need to be able to access our ValidMind Web UI from a modern browser such as

## What's next

Continue with Explore the developer framework. We recommend using [Jupyter Hub](quickstart-try-developer-framework-with-jupyterhub.qmd).
Continue with Explore the {{< var vm_dev >}}. We recommend using [Jupyter Hub](quickstart-try-developer-framework-with-jupyterhub.qmd).

6 changes: 3 additions & 3 deletions site-unused/create-documentation.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ ValidMind has now created an empty documentation project associated with the mod
- `api_secret`: The account secret key
- `project`: The project identifier

The code snippet can be copied and pasted directly into your developer source code to integrate the ValidMind Developer Framework and to be able to upload to the ValidMind Platform.
The code snippet can be copied and pasted directly into your developer source code to integrate the {{< var vm_framework >}} and to be able to upload to the ValidMind Platform.

<!---
## Troubleshooting
Expand All @@ -51,6 +51,6 @@ The code snippet can be copied and pasted directly into your developer source co

## What's next

- [Get started with the ValidMind Developer Framework](get-started-developer-framework.qmd)
- [Install and initialize the developer framework](install-and-initialize-developer-framework.qmd)
- [Get started with the {{< var vm_framework >}}](get-started-developer-framework.qmd)
- [Install and initialize the {{< var vm_dev >}}](install-and-initialize-developer-framework.qmd)
- [Working with model documentation](working-with-model-documentation.qmd)
4 changes: 2 additions & 2 deletions site-unused/editions-and-features.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ ValidMind offers its solution in multiple editions to choose from. Each edition

### Developer Edition

The Developer Edition is the ideal training ground for developers to play around with ValidMind's automated model documentation and to test the robustness of our developer framework, documentation, and testing features. The Developer Edition is free, allowing developers who are new to model documentation and model risk management to build, implement, test, and maintain higher quality models and model documentation.
The Developer Edition is the ideal training ground for developers to play around with ValidMind's automated model documentation and to test the robustness of our {{< var vm_dev >}}, documentation, and testing features. The Developer Edition is free, allowing developers who are new to model documentation and model risk management to build, implement, test, and maintain higher quality models and model documentation.

The Developer Edition is only for personal testing purposes and cannot be used as a commercial model documentation or model risk management solution.

Expand All @@ -28,7 +28,7 @@ Provides the highest level of security for organizations requiring a stricter tr
| **Model development & documentation** | Developer | Essential | Business Critical |
|---------------------------------------------------|:-------------------:|:-------------------:|:-------------------:|
| Automated model documentation | {{< fa check >}} | {{< fa check >}} | {{< fa check >}} |
| Platform-independent developer framework | {{< fa check >}} | {{< fa check >}} | {{< fa check >}} |
| Platform-independent {{< var vm_dev >}} | {{< fa check >}} | {{< fa check >}} | {{< fa check >}} |
| Online documentation editing | {{< fa check >}} | {{< fa check >}} | {{< fa check >}} |
| Advanced editing & readability assistance | | {{< fa check >}} | {{< fa check >}} |
| Documentation quality measurement | | {{< fa check >}} | {{< fa check >}} |
Expand Down
16 changes: 8 additions & 8 deletions site-unused/get-started-closed-beta.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ _Thank you for joining ValidMind's closed beta! We hope that you will find our b

Most of our large language model (LLM) testing and documentation generation features will be available for you to test during the closed beta. This includes both the ValidMind Model Documentation Automation and AI Risk Management platform.

Practically, this means you will interact with our developer framework through Jupyter notebooks to run sample code. You will also log into our cloud-based Platform UI to look at the output the developer framework generated as part of running the sample code. The Jupyter notebooks we provide are meant to be self-documenting, meaning they include most everything you need to know to run them.
Practically, this means you will interact with our {{< var vm_dev >}} through Jupyter notebooks to run sample code. You will also log into our cloud-based {{< var vm_ui >}} to look at the output the {{< var vm_dev >}} generated as part of running the sample code. The Jupyter notebooks we provide are meant to be self-documenting, meaning they include most everything you need to know to run them.

If you have never tried our products, you can also spend a few minutes reading [What do I use the ValidMind platform for?](get-started.qmd#what-do-i-use-the-validmind-platform-for). And for the beta specifically, these blog posts provide a bit more context:

Expand Down Expand Up @@ -50,11 +50,11 @@ A larger group of closed beta participants that will benefit from the improvemen
Step-by-step instructions for testing:

<!--- TO DO Do we need the OW folks to follow this step? --->
1. Get your credentials for the Platform UI by signing up with ValidMind: <https://app.prod.validmind.ai/>
1. Get your credentials for the {{< var vm_ui >}} by signing up with ValidMind: <https://app.prod.validmind.ai/>

This is the login URL for our Platform UI where you can look at the model inventory for the different models.
This is the login URL for our {{< var vm_ui >}} where you can look at the model inventory for the different models.

2. When you receive your access credentials, make sure you can log into the Platform UI.
2. When you receive your access credentials, make sure you can log into the {{< var vm_ui >}}.

3. Book a kick-off session with ValidMind by emailing <[email protected]>.

Expand All @@ -70,7 +70,7 @@ Step-by-step instructions for testing:

### What to test

We provide Jupyter notebooks that include sample code you can run directly with the ValidMind Developer Framework:
We provide Jupyter notebooks that include sample code you can run directly with the {{< var vm_framework >}}:

::: {.callout-important}
## What is "Yes"?
Expand All @@ -79,7 +79,7 @@ Throughout the early access for friends and family, we will update this table, s

| Ready | Notebook | Model Inventory |
|-----------|----------|-----------------|
| Yes | **[quickstart_customer_churn_full_suite.ipynb](https://jupyterhub.validmind.ai/hub/user-redirect/lab/tree/quickstart_customer_churn_full_suite.ipynb)**<br>Useful if you have never tried ValidMind before. Walks you through the basics of our developer framework and the Platform UI. | [Demo] Customer Churn Model Documentation — Full Suite
| Yes | **[quickstart_customer_churn_full_suite.ipynb](https://jupyterhub.validmind.ai/hub/user-redirect/lab/tree/quickstart_customer_churn_full_suite.ipynb)**<br>Useful if you have never tried ValidMind before. Walks you through the basics of our {{< var vm_dev >}} and the {{< var vm_ui >}}. | [Demo] Customer Churn Model Documentation — Full Suite
| Yes | **[nlp_and_llm/prompt_validation_demo.ipynb](https://jupyterhub.validmind.ai/hub/user-redirect/lab/tree/nlp_and_llm/prompt_validation_demo.ipynb)**<br>Guides you through running and documenting prompt validation tests for a large language model (LLM) specialized in sentiment analysis for financial news. | [Demo] Foundation Model - Text Sentiment Analysis
| Yes | **[nlp_and_llm/foundation_models_integration_demo](https://jupyterhub.validmind.ai/hub/user-redirect/lab/tree/nlp_and_llm/foundation_models_integration_demo.ipynb).ipynb**<br>Guides you through the process of documenting a large language model (LLM) specialized in sentiment analysis for financial news. | [Demo] Foundation Model - Text Sentiment Analysis
| Yes | **[nlp_and_llm/foundation_models_summarization_demo.ipynb](https://jupyterhub.validmind.ai/hub/user-redirect/lab/tree/nlp_and_llm/foundation_models_summarization_demo.ipynb)**<br>Guides you through the process of documenting a large language model (LLM) specialized in summarization of financial news. | [Demo] Foundation Model - Text Summarization
Expand All @@ -96,9 +96,9 @@ Jupyter notebooks (code samples) are available in: [Jupyter Hub](https://jupyter

Alternatively, you can download the notebooks locally and try them out in your own developer environment.

#### Platform UI
#### {{< var vm_platform >}}

Jupyter notebooks will often tell you where to look specifically after you run the sample code, but the login for the Platform UI is always the same: <https://app.prod.validmind.ai/>
Jupyter notebooks will often tell you where to look specifically after you run the sample code, but the login for the {{< var vm_ui >}} is always the same: <https://app.prod.validmind.ai/>

## Provide feedback

Expand Down
4 changes: 3 additions & 1 deletion site-unused/mermaid-diagrams-dev-framework.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ graph TD

### In your documentation environment

<!-- Using the variable in a Mermaid chart messes up the output -->

```{mermaid}
graph TD
A[Create notebook<br>to select and<br>build relevant tests] --> B[From your modeling<br>environment,<br>load trained datasets<br>and models.]
Expand All @@ -21,7 +23,7 @@ graph TD
H --> E
```

### In ValidMind Platform UI
### In {{< var vm_platform >}}

```{mermaid}
graph TB
Expand Down
2 changes: 1 addition & 1 deletion site-unused/review-documentation.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Learn how to use the ValidMind UI editor to review, and comment on model documen

* The model you are documenting is registered in the model inventory
* Model documentation has already been created for this
* A model developer has started generating documentation, either using the developer framework or via the online UI editor
* A model developer has started generating documentation, either using the {{< var vm_dev >}} or via the online UI editor
* You are logged into the ValidMind Platform

## View model documentation
Expand Down
4 changes: 2 additions & 2 deletions site/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ website:
file: https://jupyterhub.validmind.ai/
- text: "---"
- text: "{{< fa book >}} REFERENCE"
- text: "{{< fa external-link >}} ValidMind Developer Framework"
- text: "{{< fa external-link >}} {{< var vm_framework >}}"
file: validmind/validmind.html
target: _blank
- text: "FAQ"
Expand Down Expand Up @@ -208,7 +208,7 @@ website:
contents: "notebooks/code_samples/**"
- text: "---"
- text: "REFERENCE"
- text: "ValidMind Developer Framework {{< fa external-link >}}"
- text: "{{< var vm_framework >}} {{< fa external-link >}}"
file: validmind/validmind.html
target: _blank

Expand Down
Loading