diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
deleted file mode 100644
index 8db50953f..000000000
--- a/.github/workflows/docs.yaml
+++ /dev/null
@@ -1,57 +0,0 @@
-# This workflow will install Python dependencies and generate Markdown
-# documentation from docstrings using Sphinx. We generate the HTML
-# documentation to keep it up to date with the Markdown files
-name: Python Library API docs
-
-on:
- push:
- branches:
- - main
- - release-v1
- paths-ignore:
- - 'docs/_build/**'
- workflow_dispatch:
- inputs:
- note:
- description: 'Provide a description of the changes'
- required: true
- default: 'Update docs'
-
-permissions:
- contents: write
-
-jobs:
- docs:
- runs-on:
- group: ubuntu-vm-large
-
- steps:
- - uses: actions/checkout@v4
- with:
- token: ${{ secrets.GH_TOKEN }}
-
- - name: Install poetry
- run: pipx install poetry
-
- - name: Set up Python 3.11
- uses: actions/setup-python@v5
- with:
- python-version: '3.11'
- cache: 'poetry'
-
- - name: Install Dependencies
- run: |
- poetry env use python3.11
- poetry install -E huggingface -E llm
- poetry run pip install torch==2.0.1 --extra-index-url https://download.pytorch.org/whl/cpu
- poetry run pip install aequitas fairlearn vl-convert-python
-
- - name: Generate Docs
- run: make docs
-
- - name: Commit changes
- uses: EndBug/add-and-commit@v9
- with:
- default_author: github_actions
- message: 'Generate docs'
- add: 'docs/_build/'
diff --git a/.github/workflows/quarto-docs.yaml b/.github/workflows/quarto-docs.yaml
index 70a2d7993..286d39287 100644
--- a/.github/workflows/quarto-docs.yaml
+++ b/.github/workflows/quarto-docs.yaml
@@ -1,5 +1,5 @@
# This workflow will install Python dependencies and generate
-# Quarto documentation using Griffe for API extraction and
+# Quarto documentation using Griffe for API extraction and
# Jinja2 templates for the docs and navigation.
name: Python Library API docs for Quarto
@@ -7,15 +7,14 @@ on:
push:
branches:
- main
- - release-v1
paths-ignore:
- - 'docs/**'
+ - "docs/**"
workflow_dispatch:
inputs:
note:
- description: 'Provide a description of the changes'
+ description: "Provide a description of the changes"
required: true
- default: 'Update quarto docs'
+ default: "Update quarto docs"
permissions:
contents: write
@@ -27,8 +26,6 @@ jobs:
steps:
- uses: actions/checkout@v4
- with:
- token: ${{ secrets.GH_TOKEN }}
- name: Install poetry
run: pipx install poetry
@@ -36,8 +33,8 @@ jobs:
- name: Set up Python 3.11
uses: actions/setup-python@v5
with:
- python-version: '3.11'
- cache: 'poetry'
+ python-version: "3.11"
+ cache: "poetry"
- name: Install Dependencies
run: |
@@ -54,8 +51,8 @@ jobs:
uses: EndBug/add-and-commit@v9
with:
default_author: github_actions
- message: 'Generate quarto docs'
- add: 'docs/'
- remove: 'docs/_build/'
+ message: "Generate quarto docs"
+ add: "docs/"
+ remove: "docs/_build/"
pathspec_error_handling: ignore
- push: true
\ No newline at end of file
+ push: true
diff --git a/docs/_sidebar.yml b/docs/_sidebar.yml
index 716bbadb7..7caa48eb9 100644
--- a/docs/_sidebar.yml
+++ b/docs/_sidebar.yml
@@ -10,7 +10,7 @@ website:
- text: "---"
- text: "Python API"
# Root level items from validmind.qmd
- - text: "`2.8.14`"
+ - text: "`2.8.15`"
file: validmind/validmind.qmd#version__
- text: "init"
file: validmind/validmind.qmd#init
diff --git a/docs/validmind.qmd b/docs/validmind.qmd
index 880cfd6d8..197ea5087 100644
--- a/docs/validmind.qmd
+++ b/docs/validmind.qmd
@@ -44,7 +44,7 @@ After you have pasted the code snippet into your development source code and exe
::: {.signature}
-2.8.14
+2.8.15
:::
diff --git a/docs/validmind/tests.qmd b/docs/validmind/tests.qmd
index 290358a65..20c5c95e0 100644
--- a/docs/validmind/tests.qmd
+++ b/docs/validmind/tests.qmd
@@ -20,7 +20,7 @@ ValidMind Tests Module
::: {.signature}
-deflist_tests(filter=None,task=None,tags=None,pretty=True,truncate=True):
+deflist_tests(filter:Optional\[str\]=None,task:Optional\[str\]=None,tags:Optional\[List\[str\]\]=None,pretty:bool=True,truncate:bool=True) → Union\[List\[str\], None\]:
:::
@@ -36,17 +36,13 @@ List all tests in the tests directory.
- `pretty (bool, optional)`: If True, returns a pandas DataFrame with a formatted table. Defaults to True.
- `truncate (bool, optional)`: If True, truncates the test description to the first line. Defaults to True. (only used if pretty=True)
-**Returns**
-
-- list or pandas.DataFrame: A list of all tests or a formatted table.
-
## load_test
::: {.signature}
-defload_test(test_id:str,test_func:callable=None,reload:bool=False):
+defload_test(test_id:str,test_func:Optional\[Callable\[..., Any\]\]=None,reload:bool=False) → Callable\[..., Any\]:
:::
@@ -60,6 +56,7 @@ Test IDs are in the format `namespace.path_to_module.TestClassOrFuncName[:tag]`.
- `test_id (str)`: The test ID in the format `namespace.path_to_module.TestName[:tag]`
- `test_func (callable, optional)`: The test function to load. If not provided, the test will be loaded from the test provider. Defaults to None.
+- `reload (bool, optional)`: If True, reload the test even if it's already loaded. Defaults to False.
## describe_test
@@ -67,7 +64,7 @@ Test IDs are in the format `namespace.path_to_module.TestClassOrFuncName[:tag]`.
::: {.signature}
-defdescribe_test(test_id:TestID (Union of validmind.data_validation.\*, validmind.model_validation.\*, validmind.prompt_validation.\* and str)=None,raw:bool=False,show:bool=True):
+defdescribe_test(test_id:Optional\[TestID (Union of validmind.data_validation.\*, validmind.model_validation.\*, validmind.prompt_validation.\* and str)\]=None,raw:bool=False,show:bool=True) → Union\[str, HTML, Dict\[str, Any\]\]:
:::
@@ -131,13 +128,13 @@ This function is the main entry point for running tests. It can run simple unit
::: {.signature}
-deflist_tags():
+deflist_tags() → List\[str\]:
:::
-List unique tags from all test classes.
+List all unique available tags
## list_tasks
@@ -145,13 +142,13 @@ List unique tags from all test classes.
::: {.signature}
-deflist_tasks():
+deflist_tasks() → List\[str\]:
:::
-List unique tasks from all test classes.
+List all unique available tasks
## list_tasks_and_tags
@@ -159,7 +156,7 @@ List unique tasks from all test classes.
::: {.signature}
-deflist_tasks_and_tags(as_json=False):
+deflist_tasks_and_tags(as_json:bool=False) → Union\[str, Dict\[str, List\[str\]\]\]:
:::
diff --git a/docs/validmind/version.qmd b/docs/validmind/version.qmd
index c371c8f2e..eb212ee14 100644
--- a/docs/validmind/version.qmd
+++ b/docs/validmind/version.qmd
@@ -9,6 +9,6 @@ sidebar: validmind-reference
::: {.signature}
-2.8.14
+2.8.15
:::