Skip to content

Databricks docs updates#1320

Merged
nrichers merged 4 commits into
mainfrom
make-get-source-may-7-2026
May 8, 2026
Merged

Databricks docs updates#1320
nrichers merged 4 commits into
mainfrom
make-get-source-may-7-2026

Conversation

@nrichers
Copy link
Copy Markdown
Collaborator

@nrichers nrichers commented May 8, 2026

Pull Request Description

What and why?

This PR runs make get-source to refresh our notebooks, notably for Databricks, and makes some minor fixes to the docs.

How to test

What needs special review?

Dependencies, breaking changes, and deployment notes

Release notes

Checklist

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut
  • Unit tests added (Backend)
  • Tested locally
  • Documentation updated (if required)
  • Environment variable additions/changes documented (if required)

@nrichers nrichers added the internal Not to be externalized in the release notes label May 8, 2026
@nateshim nateshim self-requested a review May 8, 2026 01:05
@nrichers nrichers changed the title Refresh notebooks Databricks docs updates May 8, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 8, 2026

Lighthouse check results

⚠️ WARN: Average accessibility score is 0.87 (required: >0.9) — Check the workflow run

Show Lighthouse scores

Folder depth level checked: 0

Commit SHA: 9697491

Modify the workflow to check a different depth:

  • 0: Top-level navigation only — /index.html, /guide/guides.html, ...
  • 1: All first-level subdirectories — /guide/.html, /developer/.html, ...
  • 2: All second-level subdirectories — /guide/attestation/*.html, ...
Page Accessibility Performance Best Practices SEO
/developer/validmind-library.html 0.85 0.67 1.00 0.82
/get-started/get-started.html 0.85 0.71 1.00 0.73
/guide/guides.html 0.85 0.69 1.00 0.82
/index.html 0.93 0.63 1.00 0.82
/releases/all-releases.html 0.86 0.69 1.00 0.73
/support/support.html 0.91 0.68 1.00 0.82
/training/training.html 0.85 0.62 0.96 0.73

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 8, 2026

PR Summary

This pull request updates the Databricks integration documentation and quickstart notebook. The main changes include:

  1. Updating the URL in the integrations example (synchronize-with-databricks.qmd) to point to the new location of the Databricks quickstart notebook on GitHub instead of the old HTML documentation link.

  2. Minor formatting and content adjustment in the guide page to separate text blocks for better readability.

  3. Changing the grid layout in the managing integrations guide from three columns to two columns to likely improve the visual presentation on the site.

  4. Addition of a comprehensive Jupyter Notebook (validmind_databricks_quickstart.ipynb) that provides an end-to-end quickstart for users. This notebook includes steps to install and initialize the ValidMind Library, verify installation, load data from a Databricks Unity Catalog table (with a synthetic fallback), perform a train/test split, train a simple gradient boosting classifier, register datasets and models with ValidMind, assign predictions, and then run both individual tests and a full test suite. The notebook also provides troubleshooting tips for common issues encountered during integration and testing.

Test Suggestions

  • Verify that the new URL in the integrations example correctly points to the updated GitHub notebook location and the link renders as expected.
  • Run the notebook in a Databricks environment to ensure that installation (using %pip), Python restart, and subsequent code cells execute without errors.
  • Test the synthetic fallback functionality by setting USE_SYNTHETIC_FALLBACK to True to ensure the notebook runs even without a proper Databricks table binding.
  • Validate that the integration tests (e.g., dataset description, class imbalance, ROC Curve) execute and log results correctly to the ValidMind Platform.
  • Check the grid layout change on the managing integrations page to confirm that reducing grid columns improves visual display.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 8, 2026

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview

@nrichers nrichers merged commit a45951f into main May 8, 2026
6 of 7 checks passed
@nrichers nrichers deleted the make-get-source-may-7-2026 branch May 8, 2026 19:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants