Merge branch '0.3.0' into feature/claude

Author: zsimjee

.github/workflows/ci.yml

@@ -9,6 +9,7 @@ on:
         branches:
             - main
             - dev
+            - '0.3.0'
 
     # Allows you to run this workflow manually from the Actions tab
     workflow_dispatch:
@@ -139,3 +140,48 @@ jobs:
                     flags: unittests
                     name: codecov-umbrella
                     fail_ci_if_error: true
+    
+    Notebooks:
+        runs-on: ubuntu-latest
+        if: ${{ always() && contains(join(needs.*.result, ','), 'success') }}
+        needs: [Linting, Typing, Pytests]
+        
+        env:
+          COHERE_API_KEY: ${{ secrets.COHERE_API_KEY }}
+          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+
+
+        steps:
+        - name: Checkout repository
+          uses: actions/checkout@v2
+
+        - name: Set up Python
+          uses: actions/setup-python@v2
+          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: Install Poetry
+          uses: snok/install-poetry@v1
+          with:
+              virtualenvs-create: true
+              virtualenvs-in-project: true
+              installer-parallel: true
+
+        - name: Install dependencies
+          run: |
+            make full;
+            poetry add openai==0.28.1 jupyter nbconvert cohere;
+            # pip install openai==0.28.1 jupyter nbconvert;
+            # pip install .;
+
+        - name: Check for pypdfium2
+          run: poetry run pip show pypdfium2
+
+        - name: Execute notebooks and check for errors
+          run: ./.github/workflows/scripts/run_notebooks.sh

.github/workflows/examples_check.yml

@@ -31,17 +31,21 @@ jobs:
 
     - name: Install Poetry
       uses: snok/install-poetry@v1
+      with:
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+          installer-parallel: true
 
     - name: Install dependencies
-      run: make full; pip install jupyter nbconvert; pip install .
+      run: |
+        make full;
+        poetry add openai==0.28.1 jupyter nbconvert cohere;
+        # pip install openai==0.28.1 jupyter nbconvert;
+        # pip install .;
+
+    - name: Check for pypdfium2
+      run: poetry run pip show pypdfium2
 
     - name: Execute notebooks and check for errors
-      run: |
-        cd docs/examples
-        for notebook in $(ls *.ipynb); do
-          jupyter nbconvert --to notebook --execute "$notebook"
-          if [ $? -ne 0 ]; then
-            echo "Error found in $notebook"
-            exit 1
-          fi
-        done
+      run: ./.github/workflows/scripts/run_notebooks.sh
+

.github/workflows/release_version.yml

@@ -1,4 +1,4 @@
-name: Manual Release
+name: Release PyPi Version
 
 on:
   workflow_dispatch: # This event allows manual triggering
@@ -31,4 +31,4 @@ jobs:
       - name: Upload to PyPI
         env:
           PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-        run: poetry publish --build -u __token__ -p $PYPI_PASSWORD
+        run: poetry publish --build -u shreyar -p $PYPI_PASSWORD

.github/workflows/scripts/run_notebooks.sh

@@ -0,0 +1,38 @@
+#!/bin/bash
+
+mkdir /tmp/nltk_data;
+poetry run python -m nltk.downloader -d /tmp/nltk_data punkt;
+export NLTK_DATA=/tmp/nltk_data;
+
+cd docs/examples
+
+# Function to process a notebook
+process_notebook() {
+    notebook="$1"
+    invalid_notebooks=("valid_chess_moves.ipynb" "translation_with_quality_check.ipynb" "llamaindex-output-parsing.ipynb")
+    if [[ ! " ${invalid_notebooks[@]} " =~ " ${notebook} " ]]; then
+        echo "Processing $notebook..."
+        poetry run jupyter nbconvert --to notebook --execute "$notebook"
+        if [ $? -ne 0 ]; then
+            echo "Error found in $notebook"
+            echo "Error in $notebook. See logs for details." >> errors.txt
+        fi
+    fi
+}
+
+export -f process_notebook  # Export the function for parallel execution
+
+# Create a file to collect errors
+> errors.txt
+
+# Run in parallel
+ls *.ipynb | parallel process_notebook
+
+# Check if there were any errors
+if [ -s errors.txt ]; then
+    echo "Some notebooks had errors"
+    cat errors.txt
+    exit 1
+else
+    echo "All notebooks ran successfully."
+fi

Makefile

@@ -59,6 +59,9 @@ dev:
 full:
 	poetry install --all-extras
 
+self-install:
+	pip install -e .
+
 all: autoformat type lint docs test
 
 precommit:

README.md

@@ -154,7 +154,7 @@ Call the `Guard` object with the LLM API call as the first argument and add any
 import openai
 
 # Wrap the OpenAI API call with the `guard` object
-raw_llm_output, validated_output = guard(
+raw_llm_output, validated_output, *rest = guard(
     openai.Completion.create,
     engine="text-davinci-003",
     max_tokens=1024,

docs/api_reference/helper_classes.md

@@ -0,0 +1,4 @@
+::: guardrails.classes.generic
+    options:
+        members:
+            - "Stack"

docs/api_reference/history_and_logs.md

@@ -0,0 +1,8 @@
+::: guardrails.classes.history
+    options:
+        members:
+            - "Call"
+            - "CallInputs"
+            - "Inputs"
+            - "Iteration"
+            - "Outputs"

docs/concepts/guard.md

@@ -19,7 +19,7 @@ from guardrails import Guard
 
 guard = Guard.from_rail(...)
 
-raw_output, validated_output = guard(
+raw_output, validated_output, *rest = guard(
     openai.Completion.create,
     engine="text-davinci-003",
     max_tokens=1024,