Cron nb (#425)

* install deps + pkg for nb runs * lock nb runner to 3.11.x * use cohere api key from environ * ref env vars for cohere + openai
guardrails-ai · Nov 3, 2023 · 24285ab · 24285ab
1 parent 6fe2d00
commit 24285ab
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 3 deletions.
diff --git a/.github/workflows/examples_check.yml b/.github/workflows/examples_check.yml
@@ -9,18 +9,23 @@ jobs:
   execute_notebooks:
     runs-on: ubuntu-latest
 
+    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.x
+        python-version: 3.11.x
 
     - name: Install dependencies
       run: |
-        pip install jupyter nbconvert
+        make full; pip install jupyter nbconvert; pip install .
 
     - name: Execute notebooks and check for errors
       run: |

diff --git a/docs/examples/provenance.ipynb b/docs/examples/provenance.ipynb
@@ -298,9 +298,12 @@
     "from guardrails import Guard\n",
     "from guardrails.validators import ProvenanceV0\n",
     "from typing import List, Union\n",
+    "import os\n",
+    "\n",
+    "api_key = os.environ[\"COHERE_API_KEY\"]\n",
     "\n",
     "# Create a cohere client\n",
-    "cohere_client = cohere.Client(api_key=\"<Cohere_API_KEY>\")\n",
+    "cohere_client = cohere.Client(api_key=api_key)\n",
     "\n",
     "\n",
     "def embed_function(text: Union[str, List[str]]) -> np.ndarray:\n",