Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
89a9f8d
Add initial ChatGPT support to release notes script
nrichers May 7, 2024
29ed761
Minor tweaks
nrichers May 7, 2024
fe82527
Script tweaks
nrichers May 7, 2024
34c3317
Add .env file to .gitignore
nrichers May 7, 2024
4ebf041
Update editing instructions with style guide
nrichers May 7, 2024
8d4c6a5
Fix how editing instructions are handled, add progress indicator, imp…
nrichers May 9, 2024
9c12701
Split system and user prompts again, improve editing instructions
nrichers May 9, 2024
460a3f5
Prompt tweaks
nrichers May 9, 2024
65f65b1
Fix maximum token length issue, prompt tweaks, comment out print stat…
nrichers May 9, 2024
6be5aec
Prompt tweaks after testing
nrichers May 9, 2024
ef0790a
Update .gitignore
nrichers May 9, 2024
bb96e72
Generate & edit release notes for frontend repo only
nrichers May 9, 2024
9f5bd3b
Update model to gpt-4o
nrichers May 17, 2024
4b9b489
Remove experimental release notes
nrichers May 17, 2024
54e03ec
Initial complete release notes
nrichers May 17, 2024
2a6cb9e
Merge branch 'main' of github.com:validmind/documentation into nriche…
nrichers May 18, 2024
5089508
Tweak editing prompt for gpt-4o model
nrichers May 18, 2024
3f0eca6
WIP Human edit of release notes
nrichers May 21, 2024
c668e06
WIP Human edit of release notes
nrichers May 22, 2024
836443e
WIP Human edit of release notes
nrichers May 22, 2024
d2d0fb7
Initial human edit complete
nrichers May 22, 2024
8ff091d
Minor edits & tweaks
nrichers May 22, 2024
ca32b43
Run make get-source
nrichers May 22, 2024
e7ff72d
Update rendered site
nrichers May 22, 2024
c6c0344
Merge branch 'main' of github.com:validmind/documentation into nriche…
nrichers May 22, 2024
3ca76f4
Run make get-source, update rendered site
nrichers May 22, 2024
fa88b67
Minor visual tweaks to copy
validbeck May 22, 2024
3280222
Change callouts to buttons, add some columns, edits
nrichers May 23, 2024
7727c3b
Merge branch 'main' of github.com:validmind/documentation into nriche…
nrichers May 23, 2024
9b267d9
Address review comments from Robin
nrichers May 23, 2024
616e0f3
Adjusted the column widths for 'Documentation outline page with conve…
validbeck May 23, 2024
fadad8b
Update site/releases/2024-may-22/release-notes.qmd
nrichers May 23, 2024
c62fc4d
Address review comments from Robin
nrichers May 23, 2024
4095723
Merge branch 'nrichers/sc-4370/release-notes-update' of github.com:va…
nrichers May 23, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ site/.DS_Store
# Environment
.env
site/.quarto/
site/.gitignore
site/.gitignore
8 changes: 8 additions & 0 deletions site/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
/.quarto/
.DS_Store

/_source
/.luarc.json

# Environment
site/.env
4 changes: 2 additions & 2 deletions site/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -88,12 +88,12 @@ website:

- text: "---"
- text: "CONTRIBUTING"
- text: "ValidMind Community"
file: about/validmind-community.qmd
- about/validmind-community.qmd
- about/style-guide.qmd
- text: "---"
- text: "RELEASES"
# MAKE-RELEASE-NOTES-EMBED-MARKER
- releases/2024-may-22/release-notes.qmd
- releases/2024-mar-27/highlights.qmd
- releases/2024-feb-14/highlights.qmd
- releases/2024-jan-26/highlights.qmd
Expand Down
8 changes: 7 additions & 1 deletion site/_site/about/data-privacy-policy.html
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../about/validmind-community.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">ValidMind Community</span></a>
<span class="menu-text">ValidMind community</span></a>
</div>
</li>
<li class="sidebar-item">
Expand All @@ -274,6 +274,12 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../releases/2024-may-22/release-notes.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">May 22, 2024</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../releases/2024-mar-27/highlights.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">March 27, 2024</span></a>
</div>
Expand Down
8 changes: 7 additions & 1 deletion site/_site/about/glossary/glossary.html
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../about/validmind-community.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">ValidMind Community</span></a>
<span class="menu-text">ValidMind community</span></a>
</div>
</li>
<li class="sidebar-item">
Expand All @@ -273,6 +273,12 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../releases/2024-may-22/release-notes.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">May 22, 2024</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../releases/2024-mar-27/highlights.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">March 27, 2024</span></a>
</div>
Expand Down
8 changes: 7 additions & 1 deletion site/_site/about/license-agreement.html
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../about/validmind-community.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">ValidMind Community</span></a>
<span class="menu-text">ValidMind community</span></a>
</div>
</li>
<li class="sidebar-item">
Expand All @@ -273,6 +273,12 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../releases/2024-may-22/release-notes.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">May 22, 2024</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../releases/2024-mar-27/highlights.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">March 27, 2024</span></a>
</div>
Expand Down
8 changes: 7 additions & 1 deletion site/_site/about/overview-model-documentation.html
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../about/validmind-community.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">ValidMind Community</span></a>
<span class="menu-text">ValidMind community</span></a>
</div>
</li>
<li class="sidebar-item">
Expand All @@ -307,6 +307,12 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../releases/2024-may-22/release-notes.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">May 22, 2024</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../releases/2024-mar-27/highlights.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">March 27, 2024</span></a>
</div>
Expand Down
8 changes: 7 additions & 1 deletion site/_site/about/overview-model-risk-management.html
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../about/validmind-community.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">ValidMind Community</span></a>
<span class="menu-text">ValidMind community</span></a>
</div>
</li>
<li class="sidebar-item">
Expand All @@ -274,6 +274,12 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../releases/2024-may-22/release-notes.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">May 22, 2024</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../releases/2024-mar-27/highlights.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">March 27, 2024</span></a>
</div>
Expand Down
8 changes: 7 additions & 1 deletion site/_site/about/overview.html
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../about/validmind-community.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">ValidMind Community</span></a>
<span class="menu-text">ValidMind community</span></a>
</div>
</li>
<li class="sidebar-item">
Expand All @@ -272,6 +272,12 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../releases/2024-may-22/release-notes.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">May 22, 2024</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../releases/2024-mar-27/highlights.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">March 27, 2024</span></a>
</div>
Expand Down
12 changes: 9 additions & 3 deletions site/_site/about/style-guide.html
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../about/validmind-community.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">ValidMind Community</span></a>
<span class="menu-text">ValidMind community</span></a>
</div>
</li>
<li class="sidebar-item">
Expand All @@ -336,6 +336,12 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../releases/2024-may-22/release-notes.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">May 22, 2024</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../releases/2024-mar-27/highlights.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">March 27, 2024</span></a>
</div>
Expand Down Expand Up @@ -1481,8 +1487,8 @@ <h2 class="anchored" data-anchor-id="additional-style-guides">Additional style g
</script>
<nav class="page-navigation">
<div class="nav-page nav-page-previous">
<a href="../about/validmind-community.html" class="pagination-link" aria-label="ValidMind Community">
<i class="bi bi-arrow-left-short"></i> <span class="nav-page-text">ValidMind Community</span>
<a href="../about/validmind-community.html" class="pagination-link" aria-label="ValidMind community">
<i class="bi bi-arrow-left-short"></i> <span class="nav-page-text">ValidMind community</span>
</a>
</div>
<div class="nav-page nav-page-next">
Expand Down
18 changes: 12 additions & 6 deletions site/_site/about/validmind-community.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@

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

<meta name="dcterms.date" content="2024-05-22">
<meta name="dcterms.date" content="2024-05-23">

<title>ValidMind – The ValidMind community</title>
<title>ValidMind – ValidMind community</title>
<style>
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
Expand Down Expand Up @@ -203,7 +203,7 @@
<button type="button" class="quarto-btn-toggle btn" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
<i class="bi bi-layout-text-sidebar-reverse"></i>
</button>
<nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="../about/validmind-community.html">ValidMind Community</a></li></ol></nav>
<nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="../about/validmind-community.html">ValidMind community</a></li></ol></nav>
<a class="flex-grow-1" role="button" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
</a>
<button type="button" class="btn quarto-search-button" aria-label="" onclick="window.quartoOpenSearch();">
Expand Down Expand Up @@ -258,7 +258,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../about/validmind-community.html" class="sidebar-item-text sidebar-link active">
<span class="menu-text">ValidMind Community</span></a>
<span class="menu-text">ValidMind community</span></a>
</div>
</li>
<li class="sidebar-item">
Expand All @@ -273,6 +273,12 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../releases/2024-may-22/release-notes.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">May 22, 2024</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../releases/2024-mar-27/highlights.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">March 27, 2024</span></a>
</div>
Expand Down Expand Up @@ -382,7 +388,7 @@ <h2 id="toc-title">On this page</h2>

<header id="title-block-header" class="quarto-title-block default">
<div class="quarto-title">
<h1 class="title">The ValidMind community</h1>
<h1 class="title">ValidMind community</h1>
</div>


Expand All @@ -393,7 +399,7 @@ <h1 class="title">The ValidMind community</h1>
<div>
<div class="quarto-title-meta-heading">Published</div>
<div class="quarto-title-meta-contents">
<p class="date">May 22, 2024</p>
<p class="date">May 23, 2024</p>
</div>
</div>

Expand Down
4 changes: 2 additions & 2 deletions site/_site/guide/assign-documentation-section-statuses.html
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-05-22">
<meta name="dcterms.date" content="2024-05-23">

<title>ValidMind – Assign documentation section statuses</title>
<style>
Expand Down Expand Up @@ -466,7 +466,7 @@ <h1 class="title">Assign documentation section statuses</h1>
<div>
<div class="quarto-title-meta-heading">Published</div>
<div class="quarto-title-meta-contents">
<p class="date">May 22, 2024</p>
<p class="date">May 23, 2024</p>
</div>
</div>

Expand Down
14 changes: 7 additions & 7 deletions site/_site/guide/get-started-developer-framework.html
Original file line number Diff line number Diff line change
Expand Up @@ -1894,7 +1894,7 @@ <h2 class="anchored" data-anchor-id="getting-started">Getting started</h2>
<p>After you <a href="https://app.prod.validmind.ai"><strong>sign up</strong></a> for ValidMind to get access, try one our getting started guide:</p>
<div id="listing-developer-getting-started" class="quarto-listing quarto-listing-container-grid">
<div class="list grid quarto-listing-cols-3">
<div class="g-col-1" data-index="0" data-listing-file-modified-sort="1716419748014" data-listing-reading-time-sort="10" data-listing-word-count-sort="1953">
<div class="g-col-1" data-index="0" data-listing-file-modified-sort="1716420774805" data-listing-reading-time-sort="10" data-listing-word-count-sort="1953">
<a href="../notebooks/quickstart_customer_churn_full_suite.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<div class="card-body post-contents">
Expand All @@ -1908,7 +1908,7 @@ <h5 class="no-anchor card-title listing-title">
</div>
</a>
</div>
<div class="g-col-1" data-index="1" data-listing-file-modified-sort="1716419748102" data-listing-reading-time-sort="27" data-listing-word-count-sort="5369">
<div class="g-col-1" data-index="1" data-listing-file-modified-sort="1716479414817" data-listing-reading-time-sort="27" data-listing-word-count-sort="5380">
<a href="../notebooks/tutorials/intro_for_model_developers.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<div class="card-body post-contents">
Expand All @@ -1933,7 +1933,7 @@ <h2 class="anchored" data-anchor-id="learn-how-to-run-tests">Learn how to run te
<p>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:</p>
<div id="listing-developer-how-to-beginner" class="quarto-listing quarto-listing-container-grid">
<div class="list grid quarto-listing-cols-3">
<div class="g-col-1" data-index="0" data-listing-file-modified-sort="1716419748032" data-listing-reading-time-sort="10" data-listing-word-count-sort="1813">
<div class="g-col-1" data-index="0" data-listing-file-modified-sort="1716479414816" data-listing-reading-time-sort="10" data-listing-word-count-sort="1824">
<a href="../notebooks/how_to/run_tests/1_run_dataset_based_tests.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<div class="card-body post-contents">
Expand All @@ -1947,7 +1947,7 @@ <h5 class="no-anchor card-title listing-title">
</div>
</a>
</div>
<div class="g-col-1" data-index="1" data-listing-file-modified-sort="1716419748016" data-listing-reading-time-sort="14" data-listing-word-count-sort="2800">
<div class="g-col-1" data-index="1" data-listing-file-modified-sort="1716479414812" data-listing-reading-time-sort="15" data-listing-word-count-sort="2811">
<a href="../notebooks/code_samples/custom_tests/implement_custom_tests.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<div class="card-body post-contents">
Expand All @@ -1973,7 +1973,7 @@ <h2 class="anchored" data-anchor-id="try-the-code-samples">Try the code samples<
<p>Our code samples showcase the capabilities of the ValidMind Developer Framework. Examples that you can build on and adapt for your own use cases include:</p>
<div id="listing-developer-code-samples" class="quarto-listing quarto-listing-container-grid">
<div class="list grid quarto-listing-cols-3">
<div class="g-col-1" data-index="0" data-listing-file-modified-sort="1716419748016" data-listing-reading-time-sort="16" data-listing-word-count-sort="3016">
<div class="g-col-1" data-index="0" data-listing-file-modified-sort="1716479414812" data-listing-reading-time-sort="16" data-listing-word-count-sort="3027">
<a href="../notebooks/code_samples/customization/customizing_metrics_with_output_templates.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<div class="card-body post-contents">
Expand All @@ -1987,7 +1987,7 @@ <h5 class="no-anchor card-title listing-title">
</div>
</a>
</div>
<div class="g-col-1" data-index="1" data-listing-file-modified-sort="1716419748021" data-listing-reading-time-sort="8" data-listing-word-count-sort="1432">
<div class="g-col-1" data-index="1" data-listing-file-modified-sort="1716479414812" data-listing-reading-time-sort="8" data-listing-word-count-sort="1443">
<a href="../notebooks/code_samples/NLP_and_LLM/prompt_validation_demo.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<div class="card-body post-contents">
Expand All @@ -2001,7 +2001,7 @@ <h5 class="no-anchor card-title listing-title">
</div>
</a>
</div>
<div class="g-col-1" data-index="2" data-listing-file-modified-sort="1716419748023" data-listing-reading-time-sort="9" data-listing-word-count-sort="1636">
<div class="g-col-1" data-index="2" data-listing-file-modified-sort="1716479414813" data-listing-reading-time-sort="9" data-listing-word-count-sort="1658">
<a href="../notebooks/code_samples/time_series/tutorial_time_series_forecasting.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<div class="card-body post-contents">
Expand Down
4 changes: 2 additions & 2 deletions site/_site/guide/guides.html
Original file line number Diff line number Diff line change
Expand Up @@ -876,7 +876,7 @@ <h5 class="no-anchor card-title listing-title">
</div>
</a>
</div>
<div class="g-col-1" data-index="1" data-listing-date-sort="1716420238000" data-listing-file-modified-sort="1716420238071" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="3" data-listing-word-count-sort="516">
<div class="g-col-1" data-index="1" data-listing-date-sort="1716479414000" data-listing-file-modified-sort="1716479414807" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="3" data-listing-word-count-sort="516">
<a href="../guide/working-with-model-documentation.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<div class="card-body post-contents">
Expand Down Expand Up @@ -929,7 +929,7 @@ <h5 class="no-anchor card-title listing-title">
</div>
</a>
</div>
<div class="g-col-1" data-index="1" data-listing-date-sort="1716420142000" data-listing-file-modified-sort="1716420142206" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="5" data-listing-word-count-sort="937">
<div class="g-col-1" data-index="1" data-listing-date-sort="1716479414000" data-listing-file-modified-sort="1716479414806" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="5" data-listing-word-count-sort="937">
<a href="../guide/work-with-model-findings.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<div class="card-body post-contents">
Expand Down
8 changes: 7 additions & 1 deletion site/_site/guide/release-notes-2023-jul-24.html
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../about/validmind-community.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">ValidMind Community</span></a>
<span class="menu-text">ValidMind community</span></a>
</div>
</li>
<li class="sidebar-item">
Expand All @@ -307,6 +307,12 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../releases/2024-may-22/release-notes.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">May 22, 2024</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../releases/2024-mar-27/highlights.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">March 27, 2024</span></a>
</div>
Expand Down
Loading