Merge branch 'guardrails-ai:main' into main

Author: jayercule

.github/workflows/ci.yml

@@ -9,7 +9,6 @@ on:
     branches:
       - main
       - dev
-      - "0.3.0"
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -21,17 +20,17 @@ jobs:
       matrix:
         python-version: ["3.8", "3.9", "3.10", "3.11"]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: Poetry cache
-        uses: actions/cache@v3
-        with:
-          path: ~/.cache/pypoetry
-          key: poetry-cache-${{ runner.os }}-${{ steps.setup_python.outputs.python-version }}-${{ env.POETRY_VERSION }}
+      # - name: Poetry cache
+      #   uses: actions/cache@v3
+      #   with:
+      #     path: ~/.cache/pypoetry
+      #     key: poetry-cache-${{ runner.os }}-${{ matrix.python-version }}-${{ env.POETRY_VERSION }}
 
       - name: Install Poetry
         uses: snok/install-poetry@v1
@@ -53,17 +52,17 @@ jobs:
         pydantic-version: ["1.10.9", "2.4.2"]
         openai-version: ["0.28.1", "1.2.4"]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: Poetry cache
-        uses: actions/cache@v3
-        with:
-          path: ~/.cache/pypoetry
-          key: poetry-cache-${{ runner.os }}-${{ steps.setup_python.outputs.python-version }}-${{ env.POETRY_VERSION }}-${{ matrix.pydantic-version }}
+      # - name: Poetry cache
+      #   uses: actions/cache@v3
+      #   with:
+      #     path: ~/.cache/pypoetry
+      #     key: poetry-cache-${{ runner.os }}-${{ matrix.python-version }}-${{ env.POETRY_VERSION }}-${{ matrix.pydantic-version }}
 
       - name: Install Poetry
         uses: snok/install-poetry@v1
@@ -75,28 +74,12 @@ jobs:
           poetry run pip install pydantic==${{ matrix.pydantic-version }}
           poetry run pip install openai==${{ matrix.openai-version }}
 
-      - if: matrix.pydantic-version == '2.4.2' && matrix.openai-version == '0.28.1'
-        name: Static analysis with pyright (ignoring pydantic v1 and openai v1)
-        run: |
-          make type-pydantic-v2-openai-v0
-
-      - if: matrix.pydantic-version == '1.10.9' && matrix.openai-version == '0.28.1'
-        name: Static analysis with mypy (ignoring pydantic v2 and openai v1)
-        run: |
-          make type-pydantic-v1-openai-v0
-
-      - if: matrix.pydantic-version == '2.4.2' && matrix.openai-version == '1.2.4'
-        name: Static analysis with pyright (ignoring pydantic v1 and openai v0)
-        run: |
-          make type-pydantic-v2-openai-v1
-
-      - if: matrix.pydantic-version == '1.10.9' && matrix.openai-version == '1.2.4'
-        name: Static analysis with mypy (ignoring pydantic v2 and openai v0)
+      - name: Static analysis with pyright
         run: |
-          make type-pydantic-v1-openai-v1
+          make type
 
   Pytests:
-    runs-on: ubuntu-latest
+    runs-on: LargeBois
     strategy:
       matrix:
         python-version: ["3.8", "3.9", "3.10", "3.11"]
@@ -106,17 +89,17 @@ jobs:
         pydantic-version: ["1.10.9", "2.4.2"]
         openai-version: ["0.28.1", "1.2.4"]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: Poetry cache
-        uses: actions/cache@v3
-        with:
-          path: ~/.cache/pypoetry
-          key: poetry-cache-${{ runner.os }}-${{ steps.setup_python.outputs.python-version }}-${{ env.POETRY_VERSION }}-${{ matrix.pydantic-version }}-${{ matrix.openai-version }}
+      # - name: Poetry cache
+      #   uses: actions/cache@v3
+      #   with:
+      #     path: ~/.cache/pypoetry
+      #     key: poetry-cache-${{ runner.os }}-${{ matrix.python-version }}-${{ env.POETRY_VERSION }}-${{ matrix.pydantic-version }}-${{ matrix.openai-version }}
 
       - name: Install Poetry
         uses: snok/install-poetry@v1
@@ -138,51 +121,4 @@ jobs:
           file: ./coverage.xml
           flags: unittests
           name: codecov-umbrella
-          fail_ci_if_error: true
-
-  Notebooks:
-    runs-on: ubuntu-latest
-    needs: [Linting, Typing, Pytests]
-    strategy:
-      matrix:
-        # this line is automatically generated by the script in .github/workflows/scripts/update_notebook_matrix.sh
-        notebook: ["bug_free_python_code.ipynb","check_for_pii.ipynb","competitors_check.ipynb","extracting_entities.ipynb","generate_structured_data.ipynb","generate_structured_data_cohere.ipynb","guardrails_with_chat_models.ipynb","input_validation.ipynb","llamaindex-output-parsing.ipynb","no_secrets_in_generated_text.ipynb","provenance.ipynb","recipe_generation.ipynb","regex_validation.ipynb","response_is_on_topic.ipynb","secrets_detection.ipynb","select_choice_based_on_action.ipynb","streaming.ipynb","syntax_error_free_sql.ipynb","text_summarization_quality.ipynb","toxic_language.ipynb","translation_to_specific_language.ipynb","translation_with_quality_check.ipynb","valid_chess_moves.ipynb","value_within_distribution.ipynb"]
-    env:
-        COHERE_API_KEY: ${{ secrets.COHERE_API_KEY }}
-        OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
-        HUGGINGFACE_API_KEY: ${{ secrets.HUGGINGFACE_API_KEY }}
-        NLTK_DATA: /tmp/nltk_data
-    steps:
-        - name: Checkout repository
-          uses: actions/checkout@v2    
-        - name: Set up Python
-          uses: actions/setup-python@v4
-          with: 
-            python-version: 3.11.x
-        - name: Install Poetry
-          uses: snok/install-poetry@v1
-          with:
-            virtualenvs-create: true
-            virtualenvs-in-project: true
-            installer-parallel: true
-        - name: Load cached venv
-          uses: actions/cache@v3
-          with:
-            path: .venv
-            key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
-        - name: Install dependencies
-          run: |
-            make full;
-            poetry add "openai>=1.2.4" jupyter nbconvert cohere;
-        - name: Check for pypdfium2
-          run: poetry run pip show pypdfium2
-        - name: Huggingface Hub Login
-          run: poetry run huggingface-cli login --token $HUGGINGFACE_API_KEY
-        - name: download nltk data
-          run: |
-            mkdir /tmp/nltk_data;
-            poetry run python -m nltk.downloader -d /tmp/nltk_data punkt;
-        - name: Use venv
-          run: source .venv/bin/activate
-        - name: Execute notebooks and check for errors
-          run: bash ./.github/workflows/scripts/run_notebooks.sh ${{ matrix.notebook }}
+          fail_ci_if_error: true

.github/workflows/examples_check.yml

@@ -3,6 +3,10 @@ name: Notebook Execution and Error Check
 on:
   schedule:
     - cron: "0 0 * * *"
+  push:
+    branches:
+      - main
+      - dev
   workflow_dispatch:  # This enables manual triggering
 
 jobs:
@@ -19,16 +23,16 @@ jobs:
       NLTK_DATA: /tmp/nltk_data
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2    
+      uses: actions/checkout@v4   
     - name: Set up Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with: 
         python-version: 3.11.x
-    - name: Poetry cache
-      uses: actions/cache@v3
-      with:
-        path: ~/.cache/pypoetry
-        key: poetry-cache-${{ runner.os }}-${{ steps.setup_python.outputs.python-version }}-${{ env.POETRY_VERSION }}
+    # - name: Poetry cache
+    #   uses: actions/cache@v3
+    #   with:
+    #     path: ~/.cache/pypoetry
+    #     key: poetry-cache-${{ runner.os }}-${{ steps.setup_python.outputs.python-version }}-${{ env.POETRY_VERSION }}
     - name: Install Poetry
       uses: snok/install-poetry@v1
       with:
@@ -48,7 +52,7 @@ jobs:
         mkdir /tmp/nltk_data;
         poetry run python -m nltk.downloader -d /tmp/nltk_data punkt;
     - name: Use venv
-      run: source $VENV
+      run: source .venv/bin/activate
     - name: Execute notebooks and check for errors
       run: bash ./.github/workflows/scripts/run_notebooks.sh ${{ matrix.notebook }}
 

.github/workflows/install_from_hub.yml

@@ -0,0 +1,22 @@
+name: Notebook Execution and Error Check
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:  # This enables manual triggering
+
+jobs:
+  install_from_hub:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with: 
+        python-version: 3.11.x
+    - name: pip install from main
+      run: pip install git+https://github.com/guardrails-ai/guardrails.git@main
+    - name: Install PII validator
+      run: guardrails hub install hub://guardrails/detect_pii
+    - name: Verify PII validator is addressable
+      run: echo 'from guardrails.hub import DetectPII' | python 

.github/workflows/release_version.yml

@@ -31,4 +31,4 @@ jobs:
       - name: Upload to PyPI
         env:
           PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-        run: poetry publish --build -u shreyar -p $PYPI_PASSWORD
+        run: poetry publish --build -u __token__ -p $PYPI_PASSWORD

.github/workflows/scripts/update_notebook_matrix.sh

@@ -16,7 +16,4 @@ notebook_names="${notebook_names%,}]"
 
 # find line that begins with "notebook:" and replace it with notebook: $notebook_names
 sed "s/notebook: \[.*\]/notebook: $notebook_names/" .github/workflows/examples_check.yml > .github/workflows/examples_check.yml.tmp
-mv .github/workflows/examples_check.yml.tmp .github/workflows/examples_check.yml
-
-sed "s/notebook: \[.*\]/notebook: $notebook_names/" .github/workflows/ci.yml > .github/workflows/ci.yml.tmp
-mv .github/workflows/ci.yml.tmp .github/workflows/ci.yml
+mv .github/workflows/examples_check.yml.tmp .github/workflows/examples_check.yml

.isort.cfg

@@ -20,7 +20,8 @@ Follow these steps before committing your changes:
 
 1. Ensure tests pass: `make test`
 2. Format your code: `make autoformat`
-3. Update documentation if needed. Docs are located in the `docs` directory. You can serve docs using `mkdocs serve`.
+3. Run static analysis: `make type`
+4. Update documentation if needed. Docs are located in the `docs` directory. You can serve docs using `mkdocs serve`.
 
 ### Optional: Pre-Commit Hooks
 
@@ -38,13 +39,16 @@ Thank you for your contribution and happy coding!
 
 ## Documentation
 
-Docs are served via mkdocs using the mkdocstring plugin. To serve docs locally, run the following
+Docs are served via docusaurus. To serve docs locally, run the following
 
 ```bash
 # install dependencies
-pip install -e ".[dev]";
+pip install -e ".[dev]"
 
-# serve docs
-mkdocs serve;
+# install npm dependencies
+npm i
+
+# serve the docs
+npm run start
 ```
-then navigate to `localhost:8000` in your browser.
+then navigate to `localhost:3000` in your browser.

CNAME

@@ -1,12 +1,20 @@
 MKDOCS_SERVE_ADDR ?= localhost:8000 # Default address for mkdocs serve, format: <host>:<port>, override with `make docs-serve MKDOCS_SERVE_ADDR=<host>:<port>`
 
+# Extract major package versions for OpenAI and Pydantic
+OPENAI_VERSION_MAJOR := $(shell poetry run python -c 'import openai; print(openai.__version__.split(".")[0])')
+PYDANTIC_VERSION_MAJOR := $(shell poetry run python -c 'import pydantic; print(pydantic.__version__.split(".")[0])')
+
+# Construct the typing command using only major versions
+TYPING_CMD := type-pydantic-v$(PYDANTIC_VERSION_MAJOR)-openai-v$(OPENAI_VERSION_MAJOR)
+
 autoformat:
 	poetry run black guardrails/ tests/
 	poetry run isort --atomic guardrails/ tests/
 	poetry run docformatter --in-place --recursive guardrails tests
 
+.PHONY: type
 type:
-	poetry run pyright guardrails/
+	@make $(TYPING_CMD)
 
 type-pydantic-v1-openai-v0:
 	echo '{"exclude": ["guardrails/utils/pydantic_utils/v2.py", "guardrails/utils/openai_utils/v1.py"]}' > pyrightconfig.json