Skip to content

Add make execute PROFILE=exe-prod to docs-site action #598

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.

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

Conversation

nrichers
Copy link
Collaborator

@nrichers nrichers commented Dec 18, 2024

Internal Notes for Reviewers

This PR executes the notebook we use for our developer fundamentals training course as part of building the Docker image of our rendering our docs site.

EDIT: I moved the execute action into the docs-site action rather than calling it when building the Docker image. This means that rendering the docs site locally always executes the notebook rather than only when building the Docker image. I think that approach makes more sense logically since rendering the docs site should, well, render the (complete) docs site.

Fixes: sc-7834

Proof it works

JavaScript widgets show up, e.g.:

image

Notable stuff:

  • Uses the correct profile for production — quarto render --profile exe-prod notebooks/tutorials/intro_for_model_developers_EXECUTED.ipynb

  • There's some ominous stuff in the console output, plus some warnings:

    FATAL (/Applications/quarto/share/filters/main.lua:3949) An error occurred:
    Error resolving include-after- unable to open file https://unpkg.com/@jupyter-widgets/html-manager@*/dist/embed-amd.js
    
❯ make docker-build

Deleting copies of files sourced from other repos ...
rm -rf _source/validmind-library

Cloning source repos ...
git clone -b main git@github.com:validmind/validmind-library.git _source/validmind-library
Cloning into '_source/validmind-library'...
remote: Enumerating objects: 35986, done.
remote: Counting objects: 100% (997/997), done.
remote: Compressing objects: 100% (331/331), done.
Receiving objects: 100% (35986/35986), 478.94 MiB | 24.67 MiB/s, done.
remote: Total 35986 (delta 815), reused 708 (delta 664), pack-reused 34989 (from 3)
Resolving deltas: 100% (27452/27452), done.

Updating notebook source ...
Duplicating notebooks/tutorials/intro_for_model_developers.ipynb for execution
Copying LICENSE into notebooks ...
Moving Quickstart notebook into the root of notebooks/ ...
Copying _metadata.yml into notebooks/ ...
Zip up notebooks.zip ...

Updating Python documentation ...
Copying Python documentation into docs site ...

Updating test descriptions source ...
poetry install --all-extras
Installing dependencies from lock file

No dependencies to install or update

Installing the current project: validmind (2.7.2)
poetry run pre-commit install --hook-type pre-commit --hook-type pre-push
pre-commit installed at .git/hooks/pre-commit
pre-commit installed at .git/hooks/pre-push
Writing 165 descriptions to files at build/_test_descriptions/
Copying _metadata.yml into tests/ ...

Rendering the static HTML site ...
quarto render --profile production
[  1/335] guide/reporting/working-with-analytics.qmd
[  2/335] guide/reporting/view-report-data.qmd
[  3/335] guide/reporting/manage-custom-reports.qmd
[  4/335] guide/configuration/set-up-your-organization.qmd
[  5/335] guide/configuration/configure-google-private-service-connect.qmd
[  6/335] guide/configuration/manage-roles.qmd
[  7/335] guide/configuration/managing-your-organization.qmd
[  8/335] guide/configuration/register-with-validmind.qmd
[  9/335] guide/configuration/configure-aws-privatelink.qmd
[ 10/335] guide/configuration/accessing-validmind.qmd
[ 11/335] guide/configuration/managing-users.qmd
[ 12/335] guide/configuration/manage-users.qmd
[ 13/335] guide/configuration/personalize-validmind.qmd
[ 14/335] guide/configuration/log-in-to-validmind.qmd
[ 15/335] guide/configuration/customize-your-dashboard.qmd
[ 16/335] guide/configuration/manage-groups.qmd
[ 17/335] guide/configuration/manage-permissions.qmd
[ 18/335] guide/configuration/configure-azure-private-link.qmd
[ 19/335] guide/configuration/manage-your-profile.qmd
[ 20/335] guide/model-workflows/working-with-model-workflows.qmd
[ 21/335] guide/model-workflows/set-up-model-workflows.qmd
[ 22/335] guide/model-workflows/customize-model-lifecycle-statuses.qmd
[ 23/335] guide/model-validation/assess-compliance.qmd
[ 24/335] guide/model-validation/manage-validation-guidelines.qmd
[ 25/335] guide/model-validation/review-model-documentation.qmd
[ 26/335] guide/model-validation/working-with-model-findings.qmd
[ 27/335] guide/model-validation/add-manage-model-findings.qmd
[ 28/335] guide/model-validation/preparing-validation-reports.qmd
[ 29/335] guide/model-validation/view-filter-model-findings.qmd
[ 30/335] guide/model-documentation/submit-for-approval.qmd
[ 31/335] guide/model-documentation/collaborate-with-others.qmd
[ 32/335] guide/model-documentation/working-with-model-documentation.qmd
[ 33/335] guide/model-documentation/view-documentation-templates.qmd
[ 34/335] guide/model-documentation/export-documentation.qmd
[ 35/335] guide/model-documentation/customize-documentation-templates.qmd
[ 36/335] guide/model-documentation/working-with-documentation-templates.qmd
[ 37/335] guide/model-documentation/view-documentation-guidelines.qmd
[ 38/335] guide/model-documentation/assign-documentation-section-statuses.qmd
[ 39/335] guide/model-documentation/swap-documentation-templates.qmd
[ 40/335] guide/model-documentation/work-with-content-blocks.qmd
[ 41/335] guide/guides.qmd
[ 42/335] guide/model-inventory/register-models-in-inventory.qmd
[ 43/335] guide/model-inventory/manage-model-inventory-fields.qmd
[ 44/335] guide/model-inventory/customize-model-inventory-layout.qmd
[ 45/335] guide/model-inventory/working-with-model-inventory.qmd
[ 46/335] guide/model-inventory/archive-delete-models.qmd
[ 47/335] guide/model-inventory/view-model-activity.qmd
[ 48/335] guide/model-inventory/managing-model-inventory.qmd
[ 49/335] guide/model-inventory/configure-model-interdependencies.qmd
[ 50/335] guide/model-inventory/edit-model-inventory-fields.qmd
[ 51/335] guide/monitoring/ongoing-monitoring.qmd
[ 52/335] guide/monitoring/enable-monitoring.qmd
[ 53/335] guide/monitoring/work-with-metrics-over-time.qmd
[ 54/335] guide/monitoring/review-monitoring-results.qmd
[ 55/335] developer/model-documentation/documenting-models.qmd
[ 56/335] developer/model-documentation/document-models.qmd
[ 57/335] developer/model-documentation/work-with-test-results.qmd
[ 58/335] developer/model-documentation/supported-models.qmd
[ 59/335] developer/model-documentation/install-and-initialize-validmind-library.qmd
[ 60/335] developer/model-documentation/store-credentials-in-env-file.qmd
[ 61/335] developer/model-testing/test-sandbox.qmd
[ 62/335] developer/model-testing/testing-overview.qmd
[ 63/335] developer/model-testing/test-descriptions.qmd
[ 64/335] developer/samples-jupyter-notebooks.qmd
[ 65/335] developer/get-started-validmind-library.qmd
[ 66/335] releases/2024-oct-22/release-notes.qmd
[ 67/335] releases/2023/2023-releases.qmd
[ 68/335] releases/2023/release-notes-2023-may-30.qmd
[ 69/335] releases/2023/2023-aug-15/highlights.qmd
[ 70/335] releases/2023/release-notes-2023-jul-24.qmd
[ 71/335] releases/2023/release-notes-2023-jun-22.qmd
[ 72/335] releases/2023/2023-nov-09/highlights.qmd
[ 73/335] releases/2023/2023-oct-25/highlights.qmd
[ 74/335] releases/2023/2023-sep-27/highlights.qmd
[ 75/335] releases/2023/2023-dec-13/highlights.qmd
[ 76/335] releases/2024-releases.qmd
[ 77/335] releases/2024-dec-06/release-notes.qmd
[ 78/335] releases/2024-may-22/release-notes.qmd
[ 79/335] releases/2024-mar-27/highlights.qmd
[ 80/335] releases/2024-sep-25/release-notes.qmd
[ 81/335] releases/2024-jul-22/release-notes.qmd
[ 82/335] releases/2024-aug-13/release-notes.qmd
[ 83/335] releases/2024-feb-14/highlights.qmd
[ 84/335] releases/2024-jan-26/highlights.qmd
[ 85/335] releases/2024-sep-09/release-notes.qmd
[ 86/335] releases/2024-jun-10/release-notes.qmd
[ 87/335] releases/2024-jan-18/highlights.qmd
[ 88/335] 404.qmd
[ 89/335] faq/faq-testing.qmd
[ 90/335] faq/faq-documentation.qmd
[ 91/335] faq/faq.qmd
[ 92/335] faq/faq-integrations.qmd
[ 93/335] faq/faq-validation.qmd
[ 94/335] faq/faq-collaboration.qmd
[ 95/335] faq/faq-privacy.qmd
[ 96/335] faq/faq-reporting.qmd
[ 97/335] faq/faq-organizations.qmd
[ 98/335] faq/faq-workflows.qmd
[ 99/335] faq/faq-inventory.qmd
[100/335] training/risk-governance-fundamentals.qmd/risk-governance-fundamentals.qmd
[101/335] training/validator-fundamentals/validator-fundamentals.qmd
[102/335] training/validator-fundamentals/validator-fundamentals-register.qmd
[103/335] training/training-templates/course-registration.qmd
[104/335] training/training-templates/course-slides.qmd
[105/335] training/administrator-fundamentals/administrator-fundamentals.qmd
[106/335] training/administrator-fundamentals/administrator-fundamentals-register.qmd
[107/335] training/developer-fundamentals/developer-fundamentals-register.qmd
[108/335] training/developer-fundamentals/developer-fundamentals.qmd
[109/335] training/training.qmd
[110/335] tests/prompt_validation/NegativeInstruction.md
[111/335] tests/prompt_validation/Robustness.md
[112/335] tests/prompt_validation/Delimitation.md
[113/335] tests/prompt_validation/Conciseness.md
[114/335] tests/prompt_validation/Bias.md
[115/335] tests/prompt_validation/Clarity.md
[116/335] tests/prompt_validation/Specificity.md
[117/335] tests/model_validation/ModelMetadata.md
[118/335] tests/model_validation/embeddings/EuclideanDistanceComparison.md
[119/335] tests/model_validation/embeddings/CosineSimilarityHeatmap.md
[120/335] tests/model_validation/embeddings/StabilityAnalysisTranslation.md
[121/335] tests/model_validation/embeddings/PCAComponentsPairwisePlots.md
[122/335] tests/model_validation/embeddings/StabilityAnalysisKeyword.md
[123/335] tests/model_validation/embeddings/DescriptiveAnalytics.md
[124/335] tests/model_validation/embeddings/StabilityAnalysisSynonyms.md
[125/335] tests/model_validation/embeddings/ClusterDistribution.md
[126/335] tests/model_validation/embeddings/EuclideanDistanceHeatmap.md
[127/335] tests/model_validation/embeddings/TSNEComponentsPairwisePlots.md
[128/335] tests/model_validation/embeddings/EmbeddingsVisualization2D.md
[129/335] tests/model_validation/embeddings/CosineSimilarityComparison.md
[130/335] tests/model_validation/embeddings/StabilityAnalysisRandomNoise.md
[131/335] tests/model_validation/embeddings/CosineSimilarityDistribution.md
[132/335] tests/model_validation/TimeSeriesR2SquareBySegments.md
[133/335] tests/model_validation/ClusterSizeDistribution.md
[134/335] tests/model_validation/ToxicityScore.md
[135/335] tests/model_validation/TokenDisparity.md
[136/335] tests/model_validation/ragas/AspectCritic.md
[137/335] tests/model_validation/ragas/ResponseRelevancy.md
[138/335] tests/model_validation/ragas/ContextRecall.md
[139/335] tests/model_validation/ragas/SemanticSimilarity.md
[140/335] tests/model_validation/ragas/ContextPrecision.md
[141/335] tests/model_validation/ragas/NoiseSensitivity.md
[142/335] tests/model_validation/ragas/ContextPrecisionWithoutReference.md
[143/335] tests/model_validation/ragas/Faithfulness.md
[144/335] tests/model_validation/ragas/ContextEntityRecall.md
[145/335] tests/model_validation/ragas/AnswerCorrectness.md
[146/335] tests/model_validation/sklearn/RegressionErrors.md
[147/335] tests/model_validation/sklearn/RegressionR2Square.md
[148/335] tests/model_validation/sklearn/ROCCurve.md
[149/335] tests/model_validation/sklearn/ModelsPerformanceComparison.md
[150/335] tests/model_validation/sklearn/KMeansClustersOptimization.md
[151/335] tests/model_validation/sklearn/HyperParametersTuning.md
[152/335] tests/model_validation/sklearn/MinimumAccuracy.md
[153/335] tests/model_validation/sklearn/PopulationStabilityIndex.md
[154/335] tests/model_validation/sklearn/RegressionR2SquareComparison.md
[155/335] tests/model_validation/sklearn/WeakspotsDiagnosis.md
[156/335] tests/model_validation/sklearn/RegressionErrorsComparison.md
[157/335] tests/model_validation/sklearn/TrainingTestDegradation.md
[158/335] tests/model_validation/sklearn/FeatureImportance.md
[159/335] tests/model_validation/sklearn/CompletenessScore.md
[160/335] tests/model_validation/sklearn/HomogeneityScore.md
[161/335] tests/model_validation/sklearn/ConfusionMatrix.md
[162/335] tests/model_validation/sklearn/SHAPGlobalImportance.md
[163/335] tests/model_validation/sklearn/AdjustedRandIndex.md
[164/335] tests/model_validation/sklearn/RobustnessDiagnosis.md
[165/335] tests/model_validation/sklearn/SilhouettePlot.md
[166/335] tests/model_validation/sklearn/AdjustedMutualInformation.md
[167/335] tests/model_validation/sklearn/VMeasure.md
[168/335] tests/model_validation/sklearn/RegressionPerformance.md
[169/335] tests/model_validation/sklearn/MinimumF1Score.md
[170/335] tests/model_validation/sklearn/PermutationFeatureImportance.md
[171/335] tests/model_validation/sklearn/ClusterPerformanceMetrics.md
[172/335] tests/model_validation/sklearn/OverfitDiagnosis.md
[173/335] tests/model_validation/sklearn/ClusterCosineSimilarity.md
[174/335] tests/model_validation/sklearn/MinimumROCAUCScore.md
[175/335] tests/model_validation/sklearn/ClassifierPerformance.md
[176/335] tests/model_validation/sklearn/PrecisionRecallCurve.md
[177/335] tests/model_validation/sklearn/FowlkesMallowsScore.md
[178/335] tests/model_validation/FeaturesAUC.md
[179/335] tests/model_validation/BertScore.md
[180/335] tests/model_validation/ModelPredictionResiduals.md
[181/335] tests/model_validation/TimeSeriesPredictionWithCI.md
[182/335] tests/model_validation/RegressionResidualsPlot.md
[183/335] tests/model_validation/TimeSeriesPredictionsPlot.md
[184/335] tests/model_validation/BleuScore.md
[185/335] tests/model_validation/RegardScore.md
[186/335] tests/model_validation/MeteorScore.md
[187/335] tests/model_validation/ContextualRecall.md
[188/335] tests/model_validation/RougeScore.md
[189/335] tests/model_validation/statsmodels/RegressionCoeffs.md
[190/335] tests/model_validation/statsmodels/Lilliefors.md
[191/335] tests/model_validation/statsmodels/CumulativePredictionProbabilities.md
[192/335] tests/model_validation/statsmodels/RegressionModelSummary.md
[193/335] tests/model_validation/statsmodels/RegressionFeatureSignificance.md
[194/335] tests/model_validation/statsmodels/AutoARIMA.md
[195/335] tests/model_validation/statsmodels/PredictionProbabilitiesHistogram.md
[196/335] tests/model_validation/statsmodels/DurbinWatsonTest.md
[197/335] tests/model_validation/statsmodels/RegressionModelForecastPlot.md
[198/335] tests/model_validation/statsmodels/GINITable.md
[199/335] tests/model_validation/statsmodels/RegressionPermutationFeatureImportance.md
[200/335] tests/model_validation/statsmodels/RegressionModelForecastPlotLevels.md
[201/335] tests/model_validation/statsmodels/ScorecardHistogram.md
[202/335] tests/model_validation/statsmodels/RegressionModelSensitivityPlot.md
[203/335] tests/model_validation/statsmodels/KolmogorovSmirnov.md
[204/335] tests/ongoing_monitoring/PredictionAcrossEachFeature.md
[205/335] tests/ongoing_monitoring/FeatureDrift.md
[206/335] tests/ongoing_monitoring/TargetPredictionDistributionPlot.md
[207/335] tests/ongoing_monitoring/PredictionCorrelation.md
[208/335] tests/data_validation/TimeSeriesLinePlot.md
[209/335] tests/data_validation/BivariateScatterPlots.md
[210/335] tests/data_validation/EngleGrangerCoint.md
[211/335] tests/data_validation/ProtectedClassesDescription.md
[212/335] tests/data_validation/KPSS.md
[213/335] tests/data_validation/DatasetSplit.md
[214/335] tests/data_validation/TimeSeriesFrequency.md
[215/335] tests/data_validation/WOEBinTable.md
[216/335] tests/data_validation/ACFandPACFPlot.md
[217/335] tests/data_validation/HighPearsonCorrelation.md
[218/335] tests/data_validation/SpreadPlot.md
[219/335] tests/data_validation/TimeSeriesDescriptiveStatistics.md
[220/335] tests/data_validation/AutoAR.md
[221/335] tests/data_validation/IQROutliersBarPlot.md
[222/335] tests/data_validation/ClassImbalance.md
[223/335] tests/data_validation/ADF.md
[224/335] tests/data_validation/ProtectedClassesThresholdOptimizer.md
[225/335] tests/data_validation/TabularDateTimeHistograms.md
[226/335] tests/data_validation/SeasonalDecompose.md
[227/335] tests/data_validation/LaggedCorrelationHeatmap.md
[228/335] tests/data_validation/RunsTest.md
[229/335] tests/data_validation/TimeSeriesHistogram.md
[230/335] tests/data_validation/TimeSeriesMissingValues.md
[231/335] tests/data_validation/WOEBinPlots.md
[232/335] tests/data_validation/TimeSeriesOutliers.md
[233/335] tests/data_validation/ScatterPlot.md
[234/335] tests/data_validation/TimeSeriesDescription.md
[235/335] tests/data_validation/DescriptiveStatistics.md
[236/335] tests/data_validation/AutoStationarity.md
[237/335] tests/data_validation/TabularCategoricalBarPlots.md
[238/335] tests/data_validation/Skewness.md
[239/335] tests/data_validation/IQROutliersTable.md
[240/335] tests/data_validation/nlp/LanguageDetection.md
[241/335] tests/data_validation/nlp/Hashtags.md
[242/335] tests/data_validation/nlp/StopWords.md
[243/335] tests/data_validation/nlp/Mentions.md
[244/335] tests/data_validation/nlp/TextDescription.md
[245/335] tests/data_validation/nlp/Punctuations.md
[246/335] tests/data_validation/nlp/Sentiment.md
[247/335] tests/data_validation/nlp/PolarityAndSubjectivity.md
[248/335] tests/data_validation/nlp/Toxicity.md
[249/335] tests/data_validation/nlp/CommonWords.md
[250/335] tests/data_validation/ZivotAndrewsArch.md
[251/335] tests/data_validation/DatasetDescription.md
[252/335] tests/data_validation/ProtectedClassesCombination.md
[253/335] tests/data_validation/DickeyFullerGLS.md
[254/335] tests/data_validation/MissingValuesBarPlot.md
[255/335] tests/data_validation/Duplicates.md
[256/335] tests/data_validation/BoxPierce.md
[257/335] tests/data_validation/AutoMA.md
[258/335] tests/data_validation/TabularDescriptionTables.md
[259/335] tests/data_validation/ProtectedClassesDisparity.md
[260/335] tests/data_validation/RollingStatsPlot.md
[261/335] tests/data_validation/PhillipsPerronArch.md
[262/335] tests/data_validation/TooManyZeroValues.md
[263/335] tests/data_validation/ShapiroWilk.md
[264/335] tests/data_validation/UniqueRows.md
[265/335] tests/data_validation/PearsonCorrelationMatrix.md
[266/335] tests/data_validation/FeatureTargetCorrelationPlot.md
[267/335] tests/data_validation/JarqueBera.md
[268/335] tests/data_validation/TargetRateBarPlots.md
[269/335] tests/data_validation/LJungBox.md
[270/335] tests/data_validation/MissingValues.md
[271/335] tests/data_validation/HighCardinality.md
[272/335] tests/data_validation/ChiSquaredFeaturesTable.md
[273/335] tests/data_validation/IsolationForestOutliers.md
[274/335] tests/data_validation/TabularNumericalHistograms.md
[275/335] internal/testing.qmd
[276/335] about/overview.qmd
[277/335] about/overview-llm-features.qmd
[278/335] about/contributing/validmind-community.qmd
[279/335] about/contributing/join-community.qmd
[280/335] about/contributing/style-guide/voice-and-tone.qmd
[281/335] about/contributing/style-guide/style-guide.qmd
[282/335] about/contributing/style-guide/conventions.qmd
[283/335] about/overview-model-documentation.qmd
[284/335] about/fine-print/data-privacy-policy.qmd
[285/335] about/fine-print/license-agreement.qmd
[286/335] about/deployment/virtual-private-validmind.qmd
[287/335] about/deployment/multi-tenant-cloud.qmd
[288/335] about/deployment/deployment-options.qmd
[289/335] about/glossary/glossary.qmd
[290/335] about/overview-model-risk-management.qmd
[291/335] index.qmd
[292/335] support/support.qmd
[293/335] support/troubleshooting.qmd
[294/335] notebooks/quickstart_customer_churn_full_suite.ipynb
[295/335] notebooks/code_samples/custom_tests/implement_custom_tests.ipynb
[296/335] notebooks/code_samples/custom_tests/integrate_external_test_providers.ipynb
[297/335] notebooks/code_samples/ongoing_monitoring/quickstart_customer_churn_ongoing_monitoring.ipynb
[298/335] notebooks/code_samples/capital_markets/quickstart_option_pricing_models.ipynb
[299/335] notebooks/code_samples/capital_markets/quickstart_option_pricing_models_quantlib.ipynb
[300/335] notebooks/code_samples/nlp_and_llm/hugging_face_summarization_demo.ipynb
[301/335] notebooks/code_samples/nlp_and_llm/llm_summarization_demo.ipynb
[302/335] notebooks/code_samples/nlp_and_llm/hugging_face_integration_demo.ipynb
[303/335] notebooks/code_samples/nlp_and_llm/foundation_models_integration_demo.ipynb
[304/335] notebooks/code_samples/nlp_and_llm/prompt_validation_demo.ipynb
[305/335] notebooks/code_samples/nlp_and_llm/rag_documentation_demo.ipynb
[306/335] notebooks/code_samples/nlp_and_llm/foundation_models_summarization_demo.ipynb
[307/335] notebooks/code_samples/time_series/quickstart_time_series_high_code.ipynb
[308/335] notebooks/code_samples/time_series/quickstart_time_series_full_suite.ipynb
[309/335] notebooks/code_samples/regression/quickstart_regression_full_suite.ipynb
[310/335] notebooks/code_samples/credit_risk/application_scorecard_with_bias.ipynb
[311/335] notebooks/code_samples/credit_risk/application_scorecard_demo.ipynb
[312/335] notebooks/how_to/run_unit_metrics.ipynb
[313/335] notebooks/how_to/explore_tests.ipynb
[314/335] notebooks/how_to/load_datasets_predictions.ipynb
[315/335] notebooks/how_to/use_dataset_model_objects.ipynb
[316/335] notebooks/how_to/run_documentation_tests_with_config.ipynb
[317/335] notebooks/how_to/configure_dataset_features.ipynb
[318/335] notebooks/how_to/filter_input_columns.ipynb
[319/335] notebooks/how_to/run_tests/1_run_dataset_based_tests.ipynb
[320/335] notebooks/how_to/run_tests/2_run_comparison_tests.ipynb
[321/335] notebooks/how_to/explore_test_suites.ipynb
[322/335] notebooks/how_to/run_documentation_sections.ipynb
[323/335] notebooks/how_to/document_multiple_results_for_the_same_test.ipynb
[324/335] notebooks/how_to/run_tests_that_require_multiple_datasets.ipynb
[325/335] notebooks/tutorials/intro_for_model_developers.ipynb
[326/335] notebooks/tutorials/intro_for_model_developers_EXECUTED.ipynb
[327/335] get-started/developer/try-with-colab.qmd
[328/335] get-started/developer/try-with-jupyterhub.qmd
[329/335] get-started/developer/try-in-your-own-environment.qmd
[330/335] get-started/get-started.qmd
[331/335] get-started/platform/generate-documentation-for-your-model.qmd
[332/335] get-started/platform/register-your-first-model.qmd
[333/335] get-started/platform/explore-sample-model-documentation.qmd
[334/335] get-started/platform/next-steps.qmd
[335/335] get-started/quickstart.qmd

make

Updating Python documentation ...
Copying Python documentation into docs site ...

Output created: _site/index.html

quarto render --profile exe-prod notebooks/tutorials/intro_for_model_developers_EXECUTED.ipynb 

Starting python3 kernel...Done

Executing 'intro_for_model_developers_EXECUTED.ipynb'
  Cell 1/49: ''...Done
  Cell 2/49: ''...Done
  Cell 3/49: ''...Done
  Cell 4/49: ''...Done
  Cell 5/49: ''...Done
  Cell 6/49: ''...Done
  Cell 7/49: ''...Done
  Cell 8/49: ''...Done
  Cell 9/49: ''...Done
  Cell 10/49: ''...Done
  Cell 11/49: ''...Done
  Cell 12/49: ''...Done
  Cell 13/49: ''...Done
  Cell 14/49: ''...Done
  Cell 15/49: ''...Done
  Cell 16/49: ''...Done
  Cell 17/49: ''...Done
  Cell 18/49: ''...Done
  Cell 19/49: ''...Done
  Cell 20/49: ''...Done
  Cell 21/49: ''...Done
  Cell 22/49: ''...Done
  Cell 23/49: ''...Done
  Cell 24/49: ''...Done
  Cell 25/49: ''...Done
  Cell 26/49: ''...Done
  Cell 27/49: ''...Done
  Cell 28/49: ''...Done
  Cell 29/49: ''...Done
  Cell 30/49: ''...Done
  Cell 31/49: ''...Done
  Cell 32/49: ''...Done
  Cell 33/49: ''...Done
  Cell 34/49: ''...Done
  Cell 35/49: ''...Done
  Cell 36/49: ''...Done
  Cell 37/49: ''...Done
  Cell 38/49: ''...Done
  Cell 39/49: ''...Done
  Cell 40/49: ''...Done
  Cell 41/49: ''...Done
  Cell 42/49: ''...Done
  Cell 43/49: ''...Done
  Cell 44/49: ''...Done
  Cell 45/49: ''...Done
  Cell 46/49: ''...Done
  Cell 47/49: ''...Done
  Cell 48/49: ''...Done
  Cell 49/49: ''...Done

pandoc 
  to: html
  output-file: intro_for_model_developers_EXECUTED.html
  standalone: true
  title-prefix: ValidMind
  section-divs: true
  html-math-method: mathjax
  wrap: none
  default-image-extension: png
  reference-location: margin
  css:
    - ../../styles.css
    - /developer/developer.css
  toc: true
  
metadata
  document-css: false
  link-citations: true
  date-format: long
  lang: en
  grid:
    body-width: 1000px
  footnotes-hover: true
  code-annotations: below
  theme:
    light:
      - cosmo
      - ../../theme.scss
  mainfont: Inter
  callout-appearance: simple
  lightbox: true
  page-layout: full
  navbar: false
  title: ValidMind Introduction for Model Developers
  
FATAL (/Applications/quarto/share/filters/main.lua:3949) An error occurred:
Error resolving include-after- unable to open file https://unpkg.com/@jupyter-widgets/html-manager@*/dist/embed-amd.js
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.
WARNING (/Applications/quarto/share/filters/main.lua:9317) Unable to parse table from raw html block: skipping.

Updating Python documentation ...
Copying Python documentation into docs site ...

Output created: ../../_site/notebooks/tutorials/intro_for_model_developers_EXECUTED.html


Building the Docker image ...
[+] Building 3.1s (7/7) FINISHED                                                                                                                                           
 => [internal] load build definition from Dockerfile                                                                                                                  0.0s
 => => transferring dockerfile: 320B                                                                                                                                  0.0s
 => [internal] load .dockerignore                                                                                                                                     0.0s
 => => transferring context: 2B                                                                                                                                       0.0s
 => [internal] load metadata for docker.io/library/nginx:alpine                                                                                                       1.1s
 => [internal] load build context                                                                                                                                     0.6s
 => => transferring context: 72.78MB                                                                                                                                  0.6s
 => CACHED [1/2] FROM docker.io/library/nginx:alpine@sha256:41523187cf7d7a2f2677a80609d9caa14388bf5c1fbca9c410ba3de602aaaab4                                          0.0s
 => [2/2] COPY site/_site /usr/share/nginx/html                                                                                                                       0.9s
 => exporting to image                                                                                                                                                0.4s
 => => exporting layers                                                                                                                                               0.4s
 => => writing image sha256:c33ecfd02ab5e8a13063076ee5a722535a08ff15f8f0067e547a87f19f7fa0db                                                                          0.0s
 => => naming to docker.io/library/validmind-docs                                                                                                                     0.0s

Use 'docker scan' to run Snyk tests against images to find vulnerabilities and learn how to fix them

External Release Notes

@nrichers nrichers added infrastructure Docs infra changes internal Not to be externalized in the release notes labels Dec 18, 2024
@nrichers nrichers requested a review from validbeck December 18, 2024 21:22
Copy link
Contributor

PR Summary

This pull request introduces an enhancement to the Makefile used in the project. A new step has been added to the docker-build target, which now executes the quarto render command with a production profile (PROFILE=exe-prod) before building the Docker image. This change ensures that the site is rendered with the appropriate settings for production before the Docker image is created.

Test Suggestions

  • Verify that the docker-build target in the Makefile successfully executes the quarto render command with the exe-prod profile.
  • Ensure that the Docker image builds correctly after the quarto render step is executed.
  • Test the resulting Docker image to confirm that it contains the expected production-ready site content.

@nrichers nrichers requested a review from nibalizer December 18, 2024 21:31
Copy link
Contributor

PR Summary

This pull request introduces an enhancement to the Docker build process in the Makefile. Specifically, it adds a step to execute a Quarto render command with a production profile (exe-prod) before building the Docker image. This ensures that the necessary rendering is completed as part of the build process, potentially improving the consistency and reliability of the Docker image by ensuring that the latest content is rendered and included.

Test Suggestions

  • Verify that the Docker build process completes successfully with the new execution step.
  • Check that the Quarto render command runs without errors when the docker-build target is invoked.
  • Ensure that the rendered content is correctly included in the Docker image.
  • Test the Docker image to confirm that it functions as expected with the newly rendered content.

@nrichers nrichers changed the title Add execute PROFILE=exe-prod to Docker image build Add make execute PROFILE=exe-prod to docs-site action Jan 6, 2025
Copy link
Contributor

github-actions bot commented Jan 6, 2025

A PR preview is available: Preview URL

@nrichers
Copy link
Collaborator Author

nrichers commented Jan 6, 2025

@nibalizer @validbeck can we make a decision on this PR? My inclination is to merge this and then figure out how to help Spencer with rendering the docs site.

(I also made an additional change in 1d05411 to move the execution of the notebook into our make docs-site action but it doesn't affect how Docker images get built.)

@nibalizer
Copy link
Contributor

Yep lets get this in! Thank you!

@nrichers nrichers merged commit ac3837b into main Jan 7, 2025
5 checks passed
@nrichers nrichers deleted the nrichers/sc-7834/do-docker-images-need-to-run-make-execute branch January 7, 2025 23:11
validbeck added a commit that referenced this pull request Jan 22, 2025
* Add make execute PROFILE=exe-prod to docs-site action  (#598)

* Add execute PROFILE=exe-prod to Docker image build

* Move notebook execution into docs-site action

* Docs — Customize model overview page (#622)

* Draft customize-model-overview-page.qmd

* Quick instructions

* Edits based on feedback from Rod

* Updated docs — Workflows (#620)

* Tweak to release generation notebook

* Wait, gotta make the file first

* Wording in notebook

* Just being picky about spaces now

* Adding open file to yearly_cleanup.py too

* Success

* Edits to customize-model-lifecycle-statuses.qmd

* New img - working-with-model-workflows.qmd > See workflow statuses

* +reset-workflow.gif to working-with-model-workflows.qmd

* Updated set-up-model-workflows.qmd > Configure workflow steps

* Updated configure-user-action.png

* Updated approval-group-setup.png

* Redid the Approval Step example/images

* Redid the Condition Branch example/images

* Changed linked-workflow image to a gif

* Updated set-up-model-workflows.qmd > Link approval steps

* Changed my mind about the model-workflows.png screencap

* Tweak

* Simplifying based on Rod's suggestion

* QoL improvements to release notes script/notebooks (#626)

* Testing adding the year to generated release notes

* oops, forgot to parse the date format

* Now the folder is swapped ugh

* Adding the year to the _quarto.yml entry

* Oops, forgot to add the input

* Casing

* Adding new year folder to index function

* Grabbing yearly folders in established year

* Fake 2025 releases for testing & modifying Makefile command

* Fake 2026 release for yearly cleanup test

* Trying the yearly lookup again

* Yearly lookup works

* Retrieve year folder

* Commenting out move releases for now

* Removed move releases

* Modifying update_quarto_yaml

* Cleaning up the Makefile command

* Notebook wording cleanup

* Removing test files & reverting _quarto.yml & index.qmd to main

* Added aliases for moved 2024 releases

* Added aliases for moved 2023 releases

* Whoops, wrong alias for some of the super old releases

* Nitpicky edit

* Meh

* Nitpicking the output

* Added instructions for Wait steps in workflows (#628)

* Edits to date & date-time custom fields

* Wait step draft

* Edits & footnotes

---------

Co-authored-by: Nik Richers <nik@validmind.ai>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infrastructure Docs infra changes internal Not to be externalized in the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants