Skip to content

Revisit the "Developer Framework" getting started section (with bonus tests section rework) #169

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nrichers merged 17 commits into from
Apr 20, 2024
Merged

Revisit the "Developer Framework" getting started section (with bonus tests section rework) #169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
a6989ad
WIP rework developer framework landing page
nrichers Apr 9, 2024
a6f7811
WIP rework developer framework getting started
nrichers Apr 9, 2024
33a2734
Rework tests landing page, edits
nrichers Apr 9, 2024
622ca30
Edits
nrichers Apr 9, 2024
4c04755
Edits
nrichers Apr 10, 2024
bd6dc91
Merge branch 'main' of github.com:validmind/documentation into nriche…
nrichers Apr 11, 2024
7b4c86e
Update site/guide/get-started-developer-framework.qmd
nrichers Apr 14, 2024
bb9c9c0
Update site/guide/testing-overview.qmd
nrichers Apr 14, 2024
615a98b
Update site/guide/get-started-developer-framework.qmd
nrichers Apr 14, 2024
392d365
Update site/guide/testing-overview.qmd
nrichers Apr 14, 2024
28e8b5a
Merge branch 'nrichers/sc-3163/revisit-developer-framework-getting-st…
nrichers Apr 14, 2024
b021561
Refresh source, edits
nrichers Apr 18, 2024
bc536fb
Refresh source files
nrichers Apr 20, 2024
bd2c3a8
Edits, anchor fixes
nrichers Apr 20, 2024
e8f88e6
Update rendered site
nrichers Apr 20, 2024
1a66dca
Edits
nrichers Apr 20, 2024
5c082ec
Revert Makefile changes
nrichers Apr 20, 2024
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
  •  
  •  
  •  
21 changes: 10 additions & 11 deletions site/_quarto.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,23 +36,21 @@ website:
- text: "{{< fa cubes >}} Supported Models"
file: guide/supported-models.qmd
- text: "---"
- text: "{{< fa code >}} CODE SAMPLES"
- text: "{{< fa book >}} QuickStart · `Customer Churn` · `Binary Classification`"
file: notebooks/quickstart_customer_churn_full_suite.ipynb
Comment thread
nrichers marked this conversation as resolved.
- text: "{{< fa book-open-reader >}} More Code Samples · `LLM` · `NLP` · `Time Series` · `Etc.`"
file: guide/samples-jupyter-notebooks.qmd
- text: "{{< fa download >}} Download Code Samples · `notebooks.zip`"
file: notebooks.zip
- text: "{{< fa hand-point-right >}} Try it on Jupyter Hub {{< fa hand-point-left >}}"
file: https://jupyterhub.validmind.ai/
- text: "---"
- text: "{{< fa vial >}} TESTING"
- text: "{{< fa flask-vial >}} Run Tests & Test Suites"
file: guide/testing-overview.qmd
- text: "{{< fa microscope >}} Test Descriptions"
file: guide/test-descriptions.qmd
- guide/test-sandbox.qmd
- text: "---"
- text: "{{< fa code >}} CODE SAMPLES"
- text: "{{< fa book-open-reader >}} All Code Samples · `LLM` · `NLP` · `Time Series` · `Etc.`"
file: guide/samples-jupyter-notebooks.qmd
- text: "{{< fa download >}} Download Code Samples · `notebooks.zip`"
file: notebooks.zip
- text: "{{< fa hand-point-right >}} Try it on Jupyter Hub {{< fa hand-point-left >}}"
file: https://jupyterhub.validmind.ai/
- text: "---"
- text: "{{< fa book >}} REFERENCE"
- text: "{{< fa external-link >}} ValidMind Developer Framework"
file: validmind/validmind.html
Expand All @@ -65,7 +63,6 @@ website:
file: https://validmind.com/
target: _blank


sidebar:
- title: "Home"
style: docked
Expand Down Expand Up @@ -177,7 +174,9 @@ website:
file: guide/get-started-developer-framework.qmd
- text: "---"
- text: "MODEL DOCUMENTATION"
- notebooks/quickstart_customer_churn_full_suite.ipynb
- guide/supported-models.qmd
- guide/generate-model-documentation.qmd
- guide/install-and-initialize-developer-framework.qmd
- guide/store-credentials-in-env-file.qmd
- text: "---"
Expand Down
36 changes: 16 additions & 20 deletions site/_site/guide/assess-compliance.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

<meta name="dcterms.date" content="2024-03-14">
<meta name="dcterms.date" content="2024-04-08">

<title>ValidMind - Assess compliance</title>
<style>
Expand Down Expand Up @@ -132,24 +132,6 @@
<li>
<a class="dropdown-item" href="../guide/supported-models.html" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-cubes" aria-label="cubes"></i> Supported Models</span></a>
</li>
<li><hr class="dropdown-divider"></li>
<li class="dropdown-header"><i class="fa-solid fa-code" aria-label="code"></i> CODE SAMPLES</li>
<li>
<a class="dropdown-item" href="../notebooks/quickstart_customer_churn_full_suite.html" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-book" aria-label="book"></i> QuickStart · <code>Customer Churn</code> · <code>Binary Classification</code></span></a>
</li>
<li>
<a class="dropdown-item" href="../guide/samples-jupyter-notebooks.html" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-book-open-reader" aria-label="book-open-reader"></i> More Code Samples · <code>LLM</code> · <code>NLP</code> · <code>Time Series</code> · <code>Etc.</code></span></a>
</li>
<li>
<a class="dropdown-item" href="../notebooks.zip" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-download" aria-label="download"></i> Download Code Samples · <code>notebooks.zip</code></span></a>
</li>
<li>
<a class="dropdown-item" href="https://jupyterhub.validmind.ai/" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-hand-point-right" aria-label="hand-point-right"></i> Try it on Jupyter Hub <i class="fa-solid fa-hand-point-left" aria-label="hand-point-left"></i></span></a>
</li>
<li><hr class="dropdown-divider"></li>
<li class="dropdown-header"><i class="fa-solid fa-vial" aria-label="vial"></i> TESTING</li>
Expand All @@ -164,6 +146,20 @@
<li>
<a class="dropdown-item" href="../guide/test-sandbox.html" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-toolbox" aria-label="toolbox"></i> Test sandbox (BETA)</span></a>
</li>
<li><hr class="dropdown-divider"></li>
<li class="dropdown-header"><i class="fa-solid fa-code" aria-label="code"></i> CODE SAMPLES</li>
<li>
<a class="dropdown-item" href="../guide/samples-jupyter-notebooks.html" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-book-open-reader" aria-label="book-open-reader"></i> All Code Samples · <code>LLM</code> · <code>NLP</code> · <code>Time Series</code> · <code>Etc.</code></span></a>
</li>
<li>
<a class="dropdown-item" href="../notebooks.zip" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-download" aria-label="download"></i> Download Code Samples · <code>notebooks.zip</code></span></a>
</li>
<li>
<a class="dropdown-item" href="https://jupyterhub.validmind.ai/" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-hand-point-right" aria-label="hand-point-right"></i> Try it on Jupyter Hub <i class="fa-solid fa-hand-point-left" aria-label="hand-point-left"></i></span></a>
</li>
<li><hr class="dropdown-divider"></li>
<li class="dropdown-header"><i class="fa-solid fa-book" aria-label="book"></i> REFERENCE</li>
Expand Down Expand Up @@ -453,7 +449,7 @@ <h1 class="title">Assess compliance</h1>
<div>
<div class="quarto-title-meta-heading">Published</div>
<div class="quarto-title-meta-contents">
<p class="date">March 14, 2024</p>
<p class="date">April 8, 2024</p>
</div>
</div>

Expand Down
36 changes: 16 additions & 20 deletions site/_site/guide/collaborate-with-others.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

<meta name="dcterms.date" content="2024-03-14">
<meta name="dcterms.date" content="2024-04-08">

<title>ValidMind - Collaborate with others</title>
<style>
Expand Down Expand Up @@ -132,24 +132,6 @@
<li>
<a class="dropdown-item" href="../guide/supported-models.html" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-cubes" aria-label="cubes"></i> Supported Models</span></a>
</li>
<li><hr class="dropdown-divider"></li>
<li class="dropdown-header"><i class="fa-solid fa-code" aria-label="code"></i> CODE SAMPLES</li>
<li>
<a class="dropdown-item" href="../notebooks/quickstart_customer_churn_full_suite.html" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-book" aria-label="book"></i> QuickStart · <code>Customer Churn</code> · <code>Binary Classification</code></span></a>
</li>
<li>
<a class="dropdown-item" href="../guide/samples-jupyter-notebooks.html" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-book-open-reader" aria-label="book-open-reader"></i> More Code Samples · <code>LLM</code> · <code>NLP</code> · <code>Time Series</code> · <code>Etc.</code></span></a>
</li>
<li>
<a class="dropdown-item" href="../notebooks.zip" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-download" aria-label="download"></i> Download Code Samples · <code>notebooks.zip</code></span></a>
</li>
<li>
<a class="dropdown-item" href="https://jupyterhub.validmind.ai/" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-hand-point-right" aria-label="hand-point-right"></i> Try it on Jupyter Hub <i class="fa-solid fa-hand-point-left" aria-label="hand-point-left"></i></span></a>
</li>
<li><hr class="dropdown-divider"></li>
<li class="dropdown-header"><i class="fa-solid fa-vial" aria-label="vial"></i> TESTING</li>
Expand All @@ -164,6 +146,20 @@
<li>
<a class="dropdown-item" href="../guide/test-sandbox.html" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-toolbox" aria-label="toolbox"></i> Test sandbox (BETA)</span></a>
</li>
<li><hr class="dropdown-divider"></li>
<li class="dropdown-header"><i class="fa-solid fa-code" aria-label="code"></i> CODE SAMPLES</li>
<li>
<a class="dropdown-item" href="../guide/samples-jupyter-notebooks.html" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-book-open-reader" aria-label="book-open-reader"></i> All Code Samples · <code>LLM</code> · <code>NLP</code> · <code>Time Series</code> · <code>Etc.</code></span></a>
</li>
<li>
<a class="dropdown-item" href="../notebooks.zip" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-download" aria-label="download"></i> Download Code Samples · <code>notebooks.zip</code></span></a>
</li>
<li>
<a class="dropdown-item" href="https://jupyterhub.validmind.ai/" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-hand-point-right" aria-label="hand-point-right"></i> Try it on Jupyter Hub <i class="fa-solid fa-hand-point-left" aria-label="hand-point-left"></i></span></a>
</li>
<li><hr class="dropdown-divider"></li>
<li class="dropdown-header"><i class="fa-solid fa-book" aria-label="book"></i> REFERENCE</li>
Expand Down Expand Up @@ -470,7 +466,7 @@ <h1 class="title">Collaborate with others</h1>
<div>
<div class="quarto-title-meta-heading">Published</div>
<div class="quarto-title-meta-contents">
<p class="date">March 14, 2024</p>
<p class="date">April 8, 2024</p>
</div>
</div>

Expand Down
36 changes: 16 additions & 20 deletions site/_site/guide/comment-on-validation-reports.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

<meta name="dcterms.date" content="2024-03-14">
<meta name="dcterms.date" content="2024-04-08">

<title>ValidMind - Comment on validation reports</title>
<style>
Expand Down Expand Up @@ -130,24 +130,6 @@
<li>
<a class="dropdown-item" href="../guide/supported-models.html" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-cubes" aria-label="cubes"></i> Supported Models</span></a>
</li>
<li><hr class="dropdown-divider"></li>
<li class="dropdown-header"><i class="fa-solid fa-code" aria-label="code"></i> CODE SAMPLES</li>
<li>
<a class="dropdown-item" href="../notebooks/quickstart_customer_churn_full_suite.html" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-book" aria-label="book"></i> QuickStart · <code>Customer Churn</code> · <code>Binary Classification</code></span></a>
</li>
<li>
<a class="dropdown-item" href="../guide/samples-jupyter-notebooks.html" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-book-open-reader" aria-label="book-open-reader"></i> More Code Samples · <code>LLM</code> · <code>NLP</code> · <code>Time Series</code> · <code>Etc.</code></span></a>
</li>
<li>
<a class="dropdown-item" href="../notebooks.zip" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-download" aria-label="download"></i> Download Code Samples · <code>notebooks.zip</code></span></a>
</li>
<li>
<a class="dropdown-item" href="https://jupyterhub.validmind.ai/" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-hand-point-right" aria-label="hand-point-right"></i> Try it on Jupyter Hub <i class="fa-solid fa-hand-point-left" aria-label="hand-point-left"></i></span></a>
</li>
<li><hr class="dropdown-divider"></li>
<li class="dropdown-header"><i class="fa-solid fa-vial" aria-label="vial"></i> TESTING</li>
Expand All @@ -162,6 +144,20 @@
<li>
<a class="dropdown-item" href="../guide/test-sandbox.html" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-toolbox" aria-label="toolbox"></i> Test sandbox (BETA)</span></a>
</li>
<li><hr class="dropdown-divider"></li>
<li class="dropdown-header"><i class="fa-solid fa-code" aria-label="code"></i> CODE SAMPLES</li>
<li>
<a class="dropdown-item" href="../guide/samples-jupyter-notebooks.html" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-book-open-reader" aria-label="book-open-reader"></i> All Code Samples · <code>LLM</code> · <code>NLP</code> · <code>Time Series</code> · <code>Etc.</code></span></a>
</li>
<li>
<a class="dropdown-item" href="../notebooks.zip" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-download" aria-label="download"></i> Download Code Samples · <code>notebooks.zip</code></span></a>
</li>
<li>
<a class="dropdown-item" href="https://jupyterhub.validmind.ai/" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-hand-point-right" aria-label="hand-point-right"></i> Try it on Jupyter Hub <i class="fa-solid fa-hand-point-left" aria-label="hand-point-left"></i></span></a>
</li>
<li><hr class="dropdown-divider"></li>
<li class="dropdown-header"><i class="fa-solid fa-book" aria-label="book"></i> REFERENCE</li>
Expand Down Expand Up @@ -222,7 +218,7 @@ <h1 class="title">Comment on validation reports</h1>
<div>
<div class="quarto-title-meta-heading">Published</div>
<div class="quarto-title-meta-contents">
<p class="date">March 14, 2024</p>
<p class="date">April 8, 2024</p>
</div>
</div>

Expand Down
36 changes: 16 additions & 20 deletions site/_site/guide/configure-aws-privatelink.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

<meta name="dcterms.date" content="2024-03-06">
<meta name="dcterms.date" content="2024-04-08">

<title>ValidMind - Configure AWS PrivateLink</title>
<style>
Expand Down Expand Up @@ -131,24 +131,6 @@
<li>
<a class="dropdown-item" href="../guide/supported-models.html" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-cubes" aria-label="cubes"></i> Supported Models</span></a>
</li>
<li><hr class="dropdown-divider"></li>
<li class="dropdown-header"><i class="fa-solid fa-code" aria-label="code"></i> CODE SAMPLES</li>
<li>
<a class="dropdown-item" href="../notebooks/quickstart_customer_churn_full_suite.html" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-book" aria-label="book"></i> QuickStart · <code>Customer Churn</code> · <code>Binary Classification</code></span></a>
</li>
<li>
<a class="dropdown-item" href="../guide/samples-jupyter-notebooks.html" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-book-open-reader" aria-label="book-open-reader"></i> More Code Samples · <code>LLM</code> · <code>NLP</code> · <code>Time Series</code> · <code>Etc.</code></span></a>
</li>
<li>
<a class="dropdown-item" href="../notebooks.zip" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-download" aria-label="download"></i> Download Code Samples · <code>notebooks.zip</code></span></a>
</li>
<li>
<a class="dropdown-item" href="https://jupyterhub.validmind.ai/" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-hand-point-right" aria-label="hand-point-right"></i> Try it on Jupyter Hub <i class="fa-solid fa-hand-point-left" aria-label="hand-point-left"></i></span></a>
</li>
<li><hr class="dropdown-divider"></li>
<li class="dropdown-header"><i class="fa-solid fa-vial" aria-label="vial"></i> TESTING</li>
Expand All @@ -163,6 +145,20 @@
<li>
<a class="dropdown-item" href="../guide/test-sandbox.html" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-toolbox" aria-label="toolbox"></i> Test sandbox (BETA)</span></a>
</li>
<li><hr class="dropdown-divider"></li>
<li class="dropdown-header"><i class="fa-solid fa-code" aria-label="code"></i> CODE SAMPLES</li>
<li>
<a class="dropdown-item" href="../guide/samples-jupyter-notebooks.html" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-book-open-reader" aria-label="book-open-reader"></i> All Code Samples · <code>LLM</code> · <code>NLP</code> · <code>Time Series</code> · <code>Etc.</code></span></a>
</li>
<li>
<a class="dropdown-item" href="../notebooks.zip" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-download" aria-label="download"></i> Download Code Samples · <code>notebooks.zip</code></span></a>
</li>
<li>
<a class="dropdown-item" href="https://jupyterhub.validmind.ai/" rel="" target="">
<span class="dropdown-text"><i class="fa-solid fa-hand-point-right" aria-label="hand-point-right"></i> Try it on Jupyter Hub <i class="fa-solid fa-hand-point-left" aria-label="hand-point-left"></i></span></a>
</li>
<li><hr class="dropdown-divider"></li>
<li class="dropdown-header"><i class="fa-solid fa-book" aria-label="book"></i> REFERENCE</li>
Expand Down Expand Up @@ -454,7 +450,7 @@ <h1 class="title">Configure AWS PrivateLink</h1>
<div>
<div class="quarto-title-meta-heading">Published</div>
<div class="quarto-title-meta-contents">
<p class="date">March 6, 2024</p>
<p class="date">April 8, 2024</p>
</div>
</div>

Expand Down
Loading