Merge pull request #1278 from luarss/topic/disable-update-warn

Add update warning opt out
confident-ai · Jan 19, 2025 · 1ee9da3 · 1ee9da3
2 parents 05390ee + a881ec6
commit 1ee9da3
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 2 deletions.
diff --git a/deepeval/__init__.py b/deepeval/__init__.py
@@ -1,3 +1,4 @@
+import os
 import warnings
 import re
 
@@ -65,4 +66,9 @@ def check_for_update():
         pass
 
 
-check_for_update()
+def update_warning_opt_out():
+    return os.getenv("DEEPEVAL_UPDATE_WARNING_OPT_OUT") == "YES"
+
+
+if not update_warning_opt_out():
+    check_for_update()
diff --git a/docs/docs/miscellaneous.mdx b/docs/docs/miscellaneous.mdx
@@ -0,0 +1,12 @@
+---
+id: miscellaneous
+title: Miscellaneous
+sidebar_label: Miscellaneous
+---
+
+Disable update warnings as follows:
+
+```console
+export DEEPEVAL_UPDATE_WARNING_OPT_OUT="YES"
+```
+
diff --git a/docs/sidebars.js b/docs/sidebars.js
@@ -163,7 +163,10 @@ module.exports = {
     {
       type: "category",
       label: "Others",
-      items: ["data-privacy"],
+      items: [
+        "data-privacy",
+        "miscellaneous",
+      ],
       collapsed: false,
     },
   ],