Switch Python API reference to Quarto

internal/testing/buttons.qmd

@@ -8,7 +8,7 @@ search: false
 
 [external link](https://validmind.com/){.button}
 
-[internal html link](/validmind/validmind.html){.button}
+[internal html link](/validmind/validmind.qmd){.button}
 
-[internal html link](/validmind/validmind.html){.button target="_blank"}
+[internal html link](/validmind/validmind.qmd){.button target="_blank"}
 

site/Makefile

@@ -1,7 +1,8 @@
 # Define source and destination directories
+BRANCH ?= main
 SRC_DIR := _source/validmind-library
 DEST_DIR_NB := notebooks
-DEST_DIR_PYTHON := _site/validmind
+DEST_DIR_PYTHON := validmind
 DEST_DIR_TESTS := tests
 GIT_BRANCH := $(shell git rev-parse --abbrev-ref HEAD)
 PROFILE := exe-demo
@@ -15,6 +16,7 @@ help:
 	@echo "Available targets:"
 	@echo "  clean                Remove the _source/ directory"
 	@echo "  clone                Clone the validmind-library repository into _source/"
+	@echo "                       Optional, for PR testing: BRANCH=<branch-name>"
 	@echo "  notebooks            Copy Jupyter notebooks into notebooks/"
 	@echo "  python-docs          Copy the Python library docs into _site/validmind"
 	@echo "  get-source           Get all source files (clean, clone, notebooks, python-docs)"
@@ -39,7 +41,7 @@ clean:
 # Clone the source repository we need
 clone:
 	@echo "\nCloning source repos ..."
-	git clone -b main git@github.com:validmind/validmind-library.git $(SRC_DIR)
+	git clone -b $(BRANCH) git@github.com:validmind/validmind-library.git $(SRC_DIR)
 
 # Copy over Jupyter notebooks and supporting files
 notebooks:
@@ -61,15 +63,12 @@ notebooks:
 
 # Make Python library docs & copy them over
 python-docs:
-	@if [ -d "$(SRC_DIR)/docs/_build/" ]; then \
-		echo "\nUpdating Python documentation ..."; \
-		rm -f python-docs.zip; \
-		( cd $(SRC_DIR)/docs/_build/ && zip -r ../../../../python-docs.zip ./* > /dev/null ); \
-	fi; \
-	echo "Copying Python documentation into docs site ..."; \
-	rm -rf $(DEST_DIR_PYTHON); \
-	mkdir -p $(DEST_DIR_PYTHON); \
-	unzip python-docs.zip -d $(DEST_DIR_PYTHON) > /dev/null;
+	@if [ -d "$(SRC_DIR)/docs" ]; then \
+		echo "\nUpdating Python source ..."; \
+		rm -rf $(DEST_DIR_PYTHON); \
+		mkdir -p $(DEST_DIR_PYTHON); \
+		rsync -av --exclude '_build' --exclude 'templates' $(SRC_DIR)/docs/ $(DEST_DIR_PYTHON)/; \
+	fi
 
 test-descriptions:
 	@echo "\nUpdating test descriptions source ..."

site/_quarto.yml

@@ -1,9 +1,9 @@
 project:
   type: website
-  post-render: make python-docs
 
 metadata-files:
   - training/_sidebar.yaml
+  - validmind/_sidebar.yml
 
 website:
   announcement: 
@@ -63,9 +63,8 @@ website:
           file: https://jupyterhub.validmind.ai/
         - text: "---"
         - text: "{{< fa book >}} REFERENCE"
-        - text: "{{< fa external-link >}} {{< var validmind.developer >}} API"
-          file: validmind/validmind.html
-          target: _blank
+        - text: "{{< var validmind.developer >}} API"
+          file: validmind/validmind.qmd
       - text: "Support"
         file: support/support.qmd
       - text: "Training"
@@ -363,9 +362,8 @@ website:
           contents: "notebooks/code_samples/**"
         - text: "---"
         - text: "Reference"
-        - text: "{{< var validmind.developer >}} API"
-          file: validmind/validmind.html
-          target: _blank
+        - text: "ValidMind Library API"
+          file: validmind/validmind.qmd
 
     - title: "Support"
       contents:

site/_variables.yml

@@ -27,7 +27,7 @@ validmind:
 vm:
   platform: "platform"
   developer: "library"
-  product: "ValidMind"
+  product: "​ValidMind" # DO NOT REMOVE ​ — WORKAROUND FOR QUARTO VARIABLE RESOLUTION ISSUE
   api: "Python API"
 
 # PRODUCT URLS

site/about/glossary/key_concepts/_inputs.qmd

@@ -1,7 +1,7 @@
 inputs
 : Objects to be evaluated and documented in the {{< var validmind.developer >}}. They can be any of the following:
 
-  - **model**: A single model that has been initialized in {{< var vm.product >}} with `vm.init_model()`. See the [Model Documentation](/validmind/validmind.html#init_model){target="_blank"} or the for more information.
-  - **dataset**: Single dataset that has been initialized in {{< var vm.product >}} with `vm.init_dataset()`. See the [Dataset Documentation](/validmind/validmind.html#init_dataset){target="_blank"} for more information.
+  - **model**: A single model that has been initialized in {{< var vm.product >}} with `vm.init_model()`. See the [Model Documentation](/validmind/validmind.qmd#init_model){target="_blank"} or the for more information.
+  - **dataset**: Single dataset that has been initialized in {{< var vm.product >}} with `vm.init_dataset()`. See the [Dataset Documentation](/validmind/validmind.qmd#init_dataset){target="_blank"} for more information.
   - **models**: A list of {{< var vm.product >}} models - usually this is used when you want to compare multiple models in your custom tests.
   - **datasets**: A list of {{< var vm.product >}} datasets - usually this is used when you want to compare multiple datasets in your custom tests. (Learn more: [Run tests with multiple datasets(/notebooks/how_to/run_tests_that_require_multiple_datasets.ipynb)])

site/about/glossary/key_concepts/_test-suite.qmd

@@ -1,4 +1,4 @@
 test suite
 : A collection of tests which are run together to generate model documentation end-to-end for specific use cases. 
 
-For example, the [`classifier_full_suite`](/validmind/validmind/test_suites/classifier.html#ClassifierFullSuite){target="_blank"} test suite runs tests from the [`tabular_dataset`](/validmind/validmind/test_suites/tabular_datasets.html){target="_blank"} and [`classifier`](/validmind/validmind/test_suites/classifier.html){target="_blank"} test suites to fully document the data and model sections for binary classification model use cases.
+For example, the [`classifier_full_suite`](/validmind/validmind/test_suites/classifier.qmd#classifierfullsuite){target="_blank"} test suite runs tests from the [`tabular_dataset`](/validmind/validmind/test_suites/tabular_datasets.qmd){target="_blank"} and [`classifier`](/validmind/validmind/test_suites/classifier.qmd){target="_blank"} test suites to fully document the data and model sections for binary classification model use cases.

site/developer/model-testing/testing-overview.qmd

@@ -115,8 +115,8 @@ While you have the flexibility to decide when to use which {{< var vm.product >}
 
 To document and validate your dataset:
 
-- For generic tabular datasets: use the [`tabular_dataset`](/validmind/validmind/test_suites/tabular_datasets.html){target="_blank"} test suite.
-- For time-series datasets: use the [`time_series_dataset`](/validmind/validmind/test_suites/time_series.html#TimeSeriesDataset){target="_blank"} test suite.
+- For generic tabular datasets: use the [`tabular_dataset`](/validmind/validmind/test_suites/tabular_datasets.qmd){target="_blank"} test suite.
+- For time-series datasets: use the [`time_series_dataset`](/validmind/validmind/test_suites/time_series.qmd#timeseriesdataset){target="_blank"} test suite. 
 
 :::
 
@@ -126,8 +126,8 @@ To document and validate your dataset:
 
 To document and validate your model:
 
-- For binary classification models: use the [`classifier`](/validmind/validmind/test_suites/classifier.html){target="_blank"} test suite.
-- For time series models: use the [`timeseries`](/validmind/validmind/test_suites/time_series.html){target="_blank"} test suite.
+- For binary classification models: use the [`classifier`](/validmind/validmind/test_suites/classifier.qmd){target="_blank"} test suite.
+- For time series models: use the [`timeseries`](/validmind/validmind/test_suites/time_series.qmd){target="_blank"} test suite.
 
 :::
 
@@ -137,7 +137,7 @@ To document and validate your model:
 
 To document a binary classification model and the relevant dataset end-to-end: 
 
-Use the [`classifier_full_suite`](/validmind/validmind/test_suites/classifier.html#ClassifierFullSuite){target="_blank"} test suite.
+Use the [`classifier_full_suite`](/validmind/validmind/test_suites/classifier.qmd#classifierfullsuite){target="_blank"} test suite.
 
 :::
 
@@ -152,4 +152,4 @@ Absolutely! {{< var vm.product >}} supports custom tests that you develop yourse
 
 ## {{< var validmind.api >}} reference
 
-[{{< var validmind.developer >}} Reference](https://docs.validmind.ai/validmind/validmind.html){target="_blank" .button .button-green}
+[{{< var validmind.developer >}} API Reference](/validmind/validmind.qmd){target="_blank" .button .button-green}

site/faq/faq-documentation.qmd

@@ -105,8 +105,8 @@ These features are currently on the roadmap and under research, no release sched
 
 [^8]: [Work with test results](/guide/model-documentation/work-with-test-results.qmd)
 
-[^9]: [`assign_predictions()`](/validmind/validmind/vm_models.html#VMDataset.assign_predictions)
+[^9]: [`assign_predictions()`](/validmind/validmind/vm_models.qmd#assign_predictions)
 
-[^10]: [`init_model()`](/validmind/validmind.html#init_model)
+[^10]: [`init_model()`](/validmind/validmind.qmd#init_model)
 
-[^11]: [`ModelMetadata()`](/validmind/validmind/tests/model_validation/ModelMetadata.html#ModelMetadata)
+[^11]: [`ModelMetadata()`](/validmind/validmind/tests/model_validation/ModelMetadata.qmd#modelmetadata)

site/faq/faq-privacy.qmd

@@ -86,7 +86,7 @@ Additionally, {{< var vm.product >}} is developing a feature that enables develo
 
 <!-- FOOTNOTES -->
 
-[^1]: [{{< var validmind.developer >}}](/validmind/validmind.html)
+[^1]: [{{< var validmind.developer >}}](/validmind/validmind.qmd)
 
 [^2]: [Configure AWS PrivateLink](/guide/configuration/configure-aws-privatelink.qmd)
 

site/faq/faq-testing.qmd

@@ -63,9 +63,9 @@ In addition to custom tests, you can also add use case and test-specific context
 
 [^3]: [When do I use tests and test suites?](/developer/model-testing/testing-overview.qmd#when-do-i-use-tests-and-test-suites)
 
-[^4]: [`run_documentation_tests()`](/validmind/validmind.html#run_documentation_tests)
+[^4]: [`run_documentation_tests()`](/validmind/validmind.qmd#run_documentation_tests)
 
-[^5]: [`ClassImbalance()`](/validmind/validmind/tests/data_validation/ClassImbalance.html#ClassImbalance)
+[^5]: [`ClassImbalance()`](/validmind/validmind/tests/data_validation/ClassImbalance.qmd)
 
 [^6]: [Can I use my own tests?](/developer/model-testing/testing-overview.qmd#can-i-use-my-own-tests)
 

site/index.qmd

@@ -232,7 +232,7 @@ a:hover {
 :::{#developer}
 :::
 
-[developer reference](/validmind/validmind.html){.button-green .cta}
+[developer reference](/validmind/validmind.qmd){.button-green .cta}
 
 ::::
 

site/releases/2023/2023-aug-15/highlights.qmd

@@ -24,11 +24,11 @@ We made a number of enhancements to the {{< var validmind.developer >}} to impro
 :::: {.flex .flex-wrap .justify-around}
 
 ::: {.w-80-ns}
-Added a `metadata` and `tags` attribute to the `Test` base class for better categorization and filtering of tests.
+Added a `metadata` and `tags` attribute to the `test` base class for better categorization and filtering of tests.
 :::
 
 ::: {.w-20-ns .tc}
-[Test()](/validmind/validmind/vm_models.html#Test){.button target="_blank" .button-green}
+[test()](/validmind/validmind/tests.qmd#test){.button target="_blank" .button-green}
 
 :::
 
@@ -44,7 +44,7 @@ Added a new `task_type` argument to the `list_tests()` function to allow simple
 :::
 
 ::: {.w-20-ns}
-[list_tests()](/validmind/validmind/tests.html#list_tests){.button target="_blank" .button-green}
+[list_tests()](/validmind/validmind/tests.qmd#list_tests){.button target="_blank" .button-green}
 
 :::
 
@@ -70,7 +70,7 @@ With `vm.preview_template()`, you can now view detailed, expandable information
 :::
 
 ::: {.w-30-ns .tc}
-[preview_template()](/validmind/validmind.html#preview_template){.button target="_blank" .button-green}
+[preview_template()](/validmind/validmind.qmd#preview_template){.button target="_blank" .button-green}
 
 :::
 
@@ -86,7 +86,7 @@ The `vm.tests.list_tests()` function has been refined to show only the `ID`, `Na
 :::
 
 ::: {.w-30-ns .tc}
-[list_tests()](/validmind/validmind/tests.html#list_tests){.button target="_blank" .button-green}
+[list_tests()](/validmind/validmind/tests.qmd#list_tests){.button target="_blank" .button-green}
 
 :::
 
@@ -102,7 +102,7 @@ You can now obtain complete test details, including `required_context` and `defa
 :::
 
 ::: {.w-20-ns}
-[describe_test()](/validmind/validmind/tests.html#describe_test){.button target="_blank" .button-green}
+[describe_test()](/validmind/validmind/tests.qmd#describe_test){.button target="_blank" .button-green}
 
 :::
 
@@ -118,7 +118,7 @@ The new function `vm.get_test_suite()` allows you to access a specific test suit
 :::
 
 ::: {.w-20-ns}
-[get_test_suite()](/validmind/validmind.html#get_test_suite){.button target="_blank" .button-green}
+[get_test_suite()](/validmind/validmind.qmd#get_test_suite){.button target="_blank" .button-green}
 
 :::
 
@@ -134,13 +134,14 @@ A new method, `get_default_config()`, is now part of both the TestPlan and TestS
 :::
 
 ::: {.w-30-ns .tc}
-[get_default_config()](/validmind/validmind/vm_models.html#TestSuite.get_default_config){.button target="_blank" .button-green}
+[get_default_config()](/validmind/validmind/vm_models.qmd#TestSuite.get_default_config){.button target="_blank" .button-green}
 
 :::
 
 ::::
 
-##### Easier required context
+<!-- NR Mar 5 2025 This no longer appears to be in our codebase — closest I can find is a get_context def in a notebook but it exists only in that context -->
+<!-- ##### Easier required context
 
 :::: {.flex .flex-wrap .justify-around}
 
@@ -149,11 +150,11 @@ A complementary new method, `get_context_data()`, now returns a list of all the
 :::
 
 ::: {.w-20-ns}
-[TestContext](/validmind/validmind/vm_models.html#TestContext){.button target="_blank" .button-green}
+[TestContext](/validmind/validmind/vm_models.qmd#TestContext){.button target="_blank" .button-green}
 
 :::
 
-::::
+:::: -->
 
 ### {{< var validmind.platform >}} (v1.4.10)
 

site/releases/2023/2023-sep-27/highlights.qmd

@@ -101,7 +101,7 @@ We added a new `run_test()` helper function that streamlines running tests for y
 :::
 
 ::: {.w-20-ns}
-[run_test()](/validmind/validmind/tests.html#run_test){.button target="_blank" .button-green}
+[run_test()](/validmind/validmind/tests.qmd#run_test){.button target="_blank" .button-green}
 
 :::
 
@@ -132,8 +132,8 @@ 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 {{< 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
+- Now runs [`vm.preview_template()`](/validmind/validmind.qmd#preview_template) after initializing {{< var vm.product >}}
+- Now runs [`vm.run_documentation_tests()`](/validmind/validmind.qmd#run_documentation_tests) instead of running a test suite that is not connected to the template
 
 ##### Example usage for `run_test`
 
@@ -149,7 +149,7 @@ Discover existing tests by calling `list_tests()` or `describe_test()`:
 :::
 
 ::: {.w-20-ns .tc}
-[list_tests()](/validmind/validmind/tests.html#list_tests){.button target="_blank" .button-green}
+[list_tests()](/validmind/validmind/tests.qmd#list_tests){.button target="_blank" .button-green}
 
 :::
 
@@ -165,7 +165,7 @@ Discover existing tests by calling `list_tests()` or `describe_test()`:
 :::
 
 ::: {.w-20-ns .tc}
-[describe_test()](/validmind/validmind/tests.html#describe_test){.button target="_blank" .button-green}
+[describe_test()](/validmind/validmind/tests.qmd#describe_test){.button target="_blank" .button-green}
 
 :::
 
@@ -180,7 +180,7 @@ View the tests associated with a documentation template by running **`preview_te
 ![Examples for `preview_template()`](preview-template.png){fig-alt="A screenshot showing examples for `preview_template()`" .screenshot}
 
 ::: {.tc}
-[preview_template()](/validmind/validmind.html#preview_template){.button target="_blank" .button-green}
+[preview_template()](/validmind/validmind.qmd#preview_template){.button target="_blank" .button-green}
 :::
 
 :::
@@ -226,7 +226,7 @@ test_results.log()
 ```
 
 ::: {.tc}
-[log()](/validmind/validmind/vm_models.html#Test.log){.button target="_blank" .button-green}
+[log()](/validmind/validmind/vm_models.qmd#log){.button target="_blank" .button-green} 
 :::
 
 :::
@@ -260,9 +260,9 @@ We made a number of changes to tests to improve the developer experience:
 :::
 
 ::: {.w-30-ns}
-[run_test_suite()](/validmind/validmind.html#run_test_suite){.button target="_blank"}
+[run_test_suite()](/validmind/validmind.qmd#run_test_suite){.button target="_blank"}
 
-[run_documentation_tests()](/validmind/validmind.html#run_documentation_tests){.button target="_blank"}
+[run_documentation_tests()](/validmind/validmind.qmd#run_documentation_tests){.button target="_blank"}
 
 [ClassifierPerformance](/tests/model_validation/sklearn/ClassifierPerformance.md){.button}
 
@@ -297,7 +297,7 @@ We made a number of changes to tests to improve the developer experience:
 - The test includes metrics such as `accuracy`, `F1`, `precision`, `recall`, and `roc_auc` score.
 
 ::: {.column-margin}
-[Developer reference](/validmind/validmind.html){.button target="_blank"}
+[Developer reference](/validmind/validmind.qmd){.button target="_blank"}
 
 :::
 
@@ -316,7 +316,7 @@ We added a new search feature to the `validmind.tests.list_tests` function to al
 :::
 
 ::: {.w-20-ns}
-[list_tests()](/validmind/validmind/tests.html#list_tests){.button target="_blank"}
+[list_tests()](/validmind/validmind/tests.qmd#list_tests){.button target="_blank"}
 
 :::
 

site/releases/2024/2024-dec-06/release-notes.qmd

@@ -78,7 +78,7 @@ To reduce ambiguity and highlight the capabilities of our developer tools, as of
 :::
 
 ::: {.w-40-ns .tc}
-[{{< var validmind.developer >}} API reference](/validmind/validmind.html){.button .button-green target="_blank"}
+[{{< var validmind.developer >}} API reference](/validmind/validmind.qmd){.button .button-green target="_blank"}
 
 :::
 
@@ -390,7 +390,7 @@ In addition to comparison tests using the `input_grid` parameter in `run_test()`
 :::
 
 ::: {.w-10-ns .tc}
-[run_test()](/validmind/validmind/tests.html#run_test){.button}
+[run_test()](/validmind/validmind/tests.qmd#run_test){.button}
 
 :::