diff --git a/.github/workflows/quarto-docs.yaml b/.github/workflows/quarto-docs.yaml index 4cfdabaac..bcfba283f 100644 --- a/.github/workflows/quarto-docs.yaml +++ b/.github/workflows/quarto-docs.yaml @@ -49,11 +49,27 @@ jobs: - name: Generate Quarto Docs run: make quarto-docs - - name: Commit changes - uses: EndBug/add-and-commit@v9 + - name: Create Pull Request + id: cpr + uses: peter-evans/create-pull-request@v5 with: - default_author: github_actions - message: "Generate quarto docs" - add: "docs/" - pathspec_error_handling: ignore - push: true + token: ${{ secrets.GH_TOKEN }} + commit-message: "Generate quarto docs" + title: "Generate quarto docs" + body: | + Auto-generated PR to update Quarto documentation. + + ${{ github.event.inputs.note || 'Triggered by push to main' }} + branch: quarto-docs-update + delete-branch: true + add-paths: | + docs/ + + # Requires auto-merge to be enabled + # - name: Enable Pull Request Automerge + # if: steps.cpr.outputs.pull-request-operation == 'created' + # uses: peter-evans/enable-pull-request-automerge@v3 + # with: + # token: ${{ secrets.GH_TOKEN }} + # pull-request-number: ${{ steps.cpr.outputs.pull-request-number }} + # merge-method: squash diff --git a/.gitignore b/.gitignore index bc3a104d3..9581320a9 100644 --- a/.gitignore +++ b/.gitignore @@ -225,3 +225,5 @@ my_tests/ # Quarto docs docs/validmind.json +*.html +*.qmd diff --git a/README.md b/README.md index ebf0946af..db7336aa9 100644 --- a/README.md +++ b/README.md @@ -143,18 +143,6 @@ make version tag=patch The value of `tag` corresponds to one of the options provided by Poetry: -## Generating API Reference Docs - -The [API reference documentation](https://docs.validmind.ai/validmind/validmind.html) you see in our docs site is generated in HTML format with `pdoc` with the following -command: - -```bash -# Generate HTML -make docs -``` - -The resulting docs are written to `docs/pdoc/_build`. - ## Generating summaries for test descriptions Use `add_test_description.py` to generate a draft descriptions for a test using ChatGPT. This will automatically insert the description into the `class` docstring. diff --git a/notebooks/code_sharing/r/r_customer_churn_demo.Rmd b/notebooks/code_sharing/r/r_customer_churn_demo.Rmd index 069bc2ba2..ab4c44eb9 100644 --- a/notebooks/code_sharing/r/r_customer_churn_demo.Rmd +++ b/notebooks/code_sharing/r/r_customer_churn_demo.Rmd @@ -68,7 +68,7 @@ vm_r <- vm( api_secret="", model="", python_version=python_version, - api_host="https://api.dev.vm.validmind.ai/api/v1/tracking" + api_host="https://app.prod.validmind.ai/api/v1/tracking" ) ``` diff --git a/notebooks/code_sharing/r/r_customer_churn_demo_xgboost.Rmd b/notebooks/code_sharing/r/r_customer_churn_demo_xgboost.Rmd index 08b86fead..44e9e9318 100644 --- a/notebooks/code_sharing/r/r_customer_churn_demo_xgboost.Rmd +++ b/notebooks/code_sharing/r/r_customer_churn_demo_xgboost.Rmd @@ -69,7 +69,7 @@ vm_r <- vm( api_secret="", model="", python_version=python_version, - api_host="https://api.dev.vm.validmind.ai/api/v1/tracking" + api_host="https://app.prod.validmind.ai/api/v1/tracking" ) ``` diff --git a/notebooks/code_sharing/r/r_mortality_demo.Rmd b/notebooks/code_sharing/r/r_mortality_demo.Rmd index 4f58bfe63..b81eed50e 100644 --- a/notebooks/code_sharing/r/r_mortality_demo.Rmd +++ b/notebooks/code_sharing/r/r_mortality_demo.Rmd @@ -160,7 +160,7 @@ vm_r <- vm( api_secret="", model="", python_version=python_version, - api_host="https://api.dev.vm.validmind.ai/api/v1/tracking" + api_host="https://app.prod.validmind.ai/api/v1/tracking" ) ``` diff --git a/notebooks/code_sharing/r/r_time_series_data_validation.Rmd b/notebooks/code_sharing/r/r_time_series_data_validation.Rmd index 7ab0dc86c..2965eb390 100644 --- a/notebooks/code_sharing/r/r_time_series_data_validation.Rmd +++ b/notebooks/code_sharing/r/r_time_series_data_validation.Rmd @@ -62,7 +62,7 @@ vm_r <- vm( api_secret="", model="", python_version=python_version, - api_host="https://api.dev.vm.validmind.ai/api/v1/tracking" + api_host="https://app.prod.validmind.ai/api/v1/tracking" ) ``` diff --git a/notebooks/code_sharing/r/r_time_series_model_validation.Rmd b/notebooks/code_sharing/r/r_time_series_model_validation.Rmd index e39e72877..0a1c08b56 100644 --- a/notebooks/code_sharing/r/r_time_series_model_validation.Rmd +++ b/notebooks/code_sharing/r/r_time_series_model_validation.Rmd @@ -79,7 +79,7 @@ vm_r <- vm( api_secret="40f8d2d583baa9e730a7f8872dd57e2f4657c7918c13fa259ba7ccda8a60e858", model="clmp6k8e800ds19mot0zu8o34", python_version=python_version, - api_host="https://api.dev.vm.validmind.ai/api/v1/tracking" + api_host="https://app.prod.validmind.ai/api/v1/tracking" ) ``` diff --git a/r/validmind/R/platform.R b/r/validmind/R/platform.R index 5f05cfe1b..426b10d40 100644 --- a/r/validmind/R/platform.R +++ b/r/validmind/R/platform.R @@ -18,7 +18,7 @@ #' api_secret="", #' model="", #' python_version=python_version, -#' api_host="https://api.dev.vm.validmind.ai/api/v1/tracking" +#' api_host="https://app.prod.validmind.ai/api/v1/tracking" #' ) #'} #' diff --git a/r/validmind/man/vm.Rd b/r/validmind/man/vm.Rd index 724d0e143..816f0448f 100644 --- a/r/validmind/man/vm.Rd +++ b/r/validmind/man/vm.Rd @@ -37,7 +37,7 @@ vm_r <- vm( api_secret="", model="", python_version=python_version, - api_host="https://api.dev.vm.validmind.ai/api/v1/tracking" + api_host="https://app.prod.validmind.ai/api/v1/tracking" ) } diff --git a/validmind/__init__.py b/validmind/__init__.py index 45554259d..5b96ea574 100644 --- a/validmind/__init__.py +++ b/validmind/__init__.py @@ -21,7 +21,7 @@ import validmind as vm vm.init( - api_host = "https://api.dev.vm.validmind.ai/api/v1/tracking/tracking", + api_host = "https://app.prod.validmind.ai/api/v1/tracking/tracking", api_key = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", api_secret = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", project = ""