Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
30 changes: 23 additions & 7 deletions .github/workflows/quarto-docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -225,3 +225,5 @@ my_tests/

# Quarto docs
docs/validmind.json
*.html
*.qmd
12 changes: 0 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,18 +143,6 @@ make version tag=patch

The value of `tag` corresponds to one of the options provided by Poetry: <https://python-poetry.org/docs/cli/#version>

## 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.
Expand Down
2 changes: 1 addition & 1 deletion notebooks/code_sharing/r/r_customer_churn_demo.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ vm_r <- vm(
api_secret="<your_api_secret_here>",
model="<your_model_id_here>",
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"
)
```

Expand Down
2 changes: 1 addition & 1 deletion notebooks/code_sharing/r/r_customer_churn_demo_xgboost.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ vm_r <- vm(
api_secret="<your_api_secret_here>",
model="<your_model_id_here>",
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"
)
```

Expand Down
2 changes: 1 addition & 1 deletion notebooks/code_sharing/r/r_mortality_demo.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ vm_r <- vm(
api_secret="<your_api_secret_here>",
model="<your_project_id_here>",
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"
)
```

Expand Down
2 changes: 1 addition & 1 deletion notebooks/code_sharing/r/r_time_series_data_validation.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ vm_r <- vm(
api_secret="<your_api_secret_here>",
model="<your_project_id_here>",
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"
)
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
)
```

Expand Down
2 changes: 1 addition & 1 deletion r/validmind/R/platform.R
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
#' api_secret="<your_api_secret_here>",
#' model="<your_model_id_here>",
#' 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"
#' )
#'}
#'
Expand Down
2 changes: 1 addition & 1 deletion r/validmind/man/vm.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion validmind/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 = "<project-identifier>"
Expand Down
Loading