Deployed 0d8a735 with MkDocs version: 1.6.0

truera · Jun 14, 2024 · 4dfd213 · 4dfd213
1 parent 38db62c
commit 4dfd213
Show file tree

Hide file tree

Showing 11 changed files with 225 additions and 181 deletions.
diff --git a/conf/index.html b/conf/index.html
@@ -4089,7 +4089,7 @@ <h1>Conf</h1>
 </style>
 <!-- End of mermaid configuration --><div class="jupyter-wrapper">
 <div class="jp-Notebook" data-jp-theme-light="true" data-jp-theme-name="JupyterLab Light">
-<div class="jp-Cell jp-MarkdownCell jp-Notebook-cell" id="cell-id=08e1481a">
+<div class="jp-Cell jp-MarkdownCell jp-Notebook-cell" id="cell-id=f200addf">
 <div class="jp-Cell-inputWrapper" tabindex="0">
 <div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
 </div>
@@ -4103,7 +4103,7 @@ <h1>Conf</h1>
 </div>
 </div>
 </div>
-<div class="jp-Cell jp-MarkdownCell jp-Notebook-cell" id="cell-id=f612ccbd">
+<div class="jp-Cell jp-MarkdownCell jp-Notebook-cell" id="cell-id=048f9342">
 <div class="jp-Cell-inputWrapper" tabindex="0">
 <div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
 </div>
@@ -4114,7 +4114,7 @@ <h1>Conf</h1>
 </div>
 </div>
 </div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
-<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=c8415720">
+<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=e370896e">
 <div class="jp-Cell-inputWrapper" tabindex="0">
 <div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
 </div>
@@ -4151,7 +4151,7 @@ <h1>Conf</h1>
 </div>
 </div>
 </div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
-<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=e849e918">
+<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=1f2cb6c7">
 <div class="jp-Cell-inputWrapper" tabindex="0">
 <div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
 </div>
@@ -4182,7 +4182,7 @@ <h1>Conf</h1>
 </div>
 </div>
 </div>
-<div class="jp-Cell jp-MarkdownCell jp-Notebook-cell" id="cell-id=368ec371">
+<div class="jp-Cell jp-MarkdownCell jp-Notebook-cell" id="cell-id=0dfcc83b">
 <div class="jp-Cell-inputWrapper" tabindex="0">
 <div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
 </div>
@@ -4193,7 +4193,7 @@ <h1>Conf</h1>
 </div>
 </div>
 </div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
-<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=75a03bd3">
+<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=0b4891c5">
 <div class="jp-Cell-inputWrapper" tabindex="0">
 <div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
 </div>
@@ -4224,7 +4224,7 @@ <h1>Conf</h1>
 </div>
 </div>
 </div>
-<div class="jp-Cell jp-MarkdownCell jp-Notebook-cell" id="cell-id=a889124f">
+<div class="jp-Cell jp-MarkdownCell jp-Notebook-cell" id="cell-id=74ee9385">
 <div class="jp-Cell-inputWrapper" tabindex="0">
 <div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
 </div>
@@ -4235,7 +4235,7 @@ <h1>Conf</h1>
 </div>
 </div>
 </div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
-<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=02c39ff6">
+<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=bcb685ad">
 <div class="jp-Cell-inputWrapper" tabindex="0">
 <div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
 </div>
@@ -4278,7 +4278,7 @@ <h1>Conf</h1>
 </div>
 </div>
 </div>
-<div class="jp-Cell jp-MarkdownCell jp-Notebook-cell" id="cell-id=df16fdbd">
+<div class="jp-Cell jp-MarkdownCell jp-Notebook-cell" id="cell-id=4f9ac8b5">
 <div class="jp-Cell-inputWrapper" tabindex="0">
 <div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
 </div>
@@ -4291,7 +4291,7 @@ <h1>Conf</h1>
 </div>
 </div>
 </div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
-<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=8aaa554c">
+<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=3a465893">
 <div class="jp-Cell-inputWrapper" tabindex="0">
 <div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
 </div>
@@ -4324,7 +4324,7 @@ <h1>Conf</h1>
 </div>
 </div>
 </div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
-<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=c00b3d11">
+<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=ccc3d879">
 <div class="jp-Cell-inputWrapper" tabindex="0">
 <div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
 </div>
@@ -4353,7 +4353,7 @@ <h1>Conf</h1>
 </div>
 </div>
 </div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
-<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=4cad1d42">
+<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=80fe8cfb">
 <div class="jp-Cell-inputWrapper" tabindex="0">
 <div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
 </div>
@@ -4382,7 +4382,7 @@ <h1>Conf</h1>
 </div>
 </div>
 </div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
-<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=0a1d963b">
+<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=ea868efc">
 <div class="jp-Cell-inputWrapper" tabindex="0">
 <div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
 </div>
@@ -4415,7 +4415,7 @@ <h1>Conf</h1>
 </div>
 </div>
 </div>
-<div class="jp-Cell jp-MarkdownCell jp-Notebook-cell" id="cell-id=7bf92214">
+<div class="jp-Cell jp-MarkdownCell jp-Notebook-cell" id="cell-id=bc56b7a7">
 <div class="jp-Cell-inputWrapper" tabindex="0">
 <div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
 </div>
@@ -4426,7 +4426,7 @@ <h1>Conf</h1>
 </div>
 </div>
 </div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
-<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=d1604c6e">
+<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=1841e0b9">
 <div class="jp-Cell-inputWrapper" tabindex="0">
 <div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
 </div>
@@ -4459,7 +4459,7 @@ <h1>Conf</h1>
 </div>
 </div>
 </div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
-<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=d5d25f31">
+<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=dfcbda09">
 <div class="jp-Cell-inputWrapper" tabindex="0">
 <div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
 </div>
@@ -4492,7 +4492,7 @@ <h1>Conf</h1>
 </div>
 </div>
 </div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
-<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=dc2c643b">
+<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=fc06e943">
 <div class="jp-Cell-inputWrapper" tabindex="0">
 <div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
 </div>
@@ -4519,7 +4519,7 @@ <h1>Conf</h1>
 </div>
 </div>
 </div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
-<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=2eceb302">
+<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=dc4662b7">
 <div class="jp-Cell-inputWrapper" tabindex="0">
 <div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
 </div>
@@ -4546,7 +4546,7 @@ <h1>Conf</h1>
 </div>
 </div>
 </div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
-<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=fb6b1141">
+<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=48857766">
 <div class="jp-Cell-inputWrapper" tabindex="0">
 <div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
 </div>

diff --git a/docs_requirements.txt b/docs_requirements.txt
@@ -16,3 +16,5 @@ markdown-include     >= 0.8.1
 
 jupyter_contrib_nbextensions >= 0.7.0
 notebook <7
+
+black >= 24.4.2
diff --git a/objects.inv b/objects.inv
diff --git a/search/search_index.json b/search/search_index.json
diff --git a/sitemap.xml.gz b/sitemap.xml.gz
diff --git a/trulens_eval/api/feedback/index.html b/trulens_eval/api/feedback/index.html
@@ -2686,6 +2686,24 @@
     </span>
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#trulens_eval.feedback.feedback.SkipEval" class="md-nav__link">
+    <span class="md-ellipsis">
+      <code class="doc-symbol doc-symbol-toc doc-symbol-class"></code>&nbsp;SkipEval
+    </span>
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#trulens_eval.feedback.feedback.InvalidSelector" class="md-nav__link">
+    <span class="md-ellipsis">
+      <code class="doc-symbol doc-symbol-toc doc-symbol-class"></code>&nbsp;InvalidSelector
+    </span>
+  </a>
+
 </li>
 
         <li class="md-nav__item">
@@ -4805,6 +4823,24 @@
     </span>
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#trulens_eval.feedback.feedback.SkipEval" class="md-nav__link">
+    <span class="md-ellipsis">
+      <code class="doc-symbol doc-symbol-toc doc-symbol-class"></code>&nbsp;SkipEval
+    </span>
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#trulens_eval.feedback.feedback.InvalidSelector" class="md-nav__link">
+    <span class="md-ellipsis">
+      <code class="doc-symbol doc-symbol-toc doc-symbol-class"></code>&nbsp;InvalidSelector
+    </span>
+  </a>
+
 </li>
 
         <li class="md-nav__item">
@@ -6355,6 +6391,151 @@ <h2 id="trulens_eval.feedback.feedback.AggCallable" class="doc doc-heading">
 
 </div>
 
+<div class="doc doc-object doc-class">
+
+
+
+<h2 id="trulens_eval.feedback.feedback.SkipEval" class="doc doc-heading">
+<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code>            <span class="doc doc-object-name doc-class-name">trulens_eval.feedback.feedback.SkipEval</span>
+
+
+<a href="#trulens_eval.feedback.feedback.SkipEval" class="headerlink" title="Permanent link">&para;</a></h2>
+
+
+    <div class="doc doc-contents first">
+            <p class="doc doc-class-bases">
+              Bases: <code><a class="autorefs autorefs-external" href="https://docs.python.org/3/library/exceptions.html#Exception">Exception</a></code></p>
+
+
+      <p>Raised when evaluating a feedback function implementation to skip it so
+it is not aggregated with other non-skipped results.</p>
+
+
+<table>
+      <thead>
+        <tr>
+          <th><span class="doc-section-title">PARAMETER</span></th>
+          <th><span>DESCRIPTION</span></th>
+        </tr>
+      </thead>
+      <tbody>
+          <tr class="doc-section-item">
+            <td><code>reason</code></td>
+            <td class="doc-param-details">
+              <div class="doc-md-description">
+                <p>Optional reason for why this evaluation was skipped.</p>
+              </div>
+              <p>
+                  <span class="doc-param-annotation">
+                    <b>TYPE:</b>
+                      <code><a class="autorefs autorefs-external" title="typing.Optional" href="https://docs.python.org/3/library/typing.html#typing.Optional">Optional</a>[<a class="autorefs autorefs-external" href="https://docs.python.org/3/library/stdtypes.html#str">str</a>]</code>
+                  </span>
+                  <span class="doc-param-default">
+                    <b>DEFAULT:</b>
+                      <code>None</code>
+                  </span>
+              </p>
+            </td>
+          </tr>
+          <tr class="doc-section-item">
+            <td><code>feedback</code></td>
+            <td class="doc-param-details">
+              <div class="doc-md-description">
+                <p>The Feedback instance this run corresponds to.</p>
+              </div>
+              <p>
+                  <span class="doc-param-annotation">
+                    <b>TYPE:</b>
+                      <code><a class="autorefs autorefs-external" title="typing.Optional" href="https://docs.python.org/3/library/typing.html#typing.Optional">Optional</a>[<a class="autorefs autorefs-internal" title="trulens_eval.feedback.feedback.Feedback" href="#trulens_eval.feedback.feedback.Feedback">Feedback</a>]</code>
+                  </span>
+                  <span class="doc-param-default">
+                    <b>DEFAULT:</b>
+                      <code>None</code>
+                  </span>
+              </p>
+            </td>
+          </tr>
+          <tr class="doc-section-item">
+            <td><code>ins</code></td>
+            <td class="doc-param-details">
+              <div class="doc-md-description">
+                <p>The arguments to this run.</p>
+              </div>
+              <p>
+                  <span class="doc-param-annotation">
+                    <b>TYPE:</b>
+                      <code><a class="autorefs autorefs-external" title="typing.Optional" href="https://docs.python.org/3/library/typing.html#typing.Optional">Optional</a>[<a class="autorefs autorefs-external" title="typing.Dict" href="https://docs.python.org/3/library/typing.html#typing.Dict">Dict</a>[<a class="autorefs autorefs-external" href="https://docs.python.org/3/library/stdtypes.html#str">str</a>, <a class="autorefs autorefs-external" title="typing.Any" href="https://docs.python.org/3/library/typing.html#typing.Any">Any</a>]]</code>
+                  </span>
+                  <span class="doc-param-default">
+                    <b>DEFAULT:</b>
+                      <code>None</code>
+                  </span>
+              </p>
+            </td>
+          </tr>
+      </tbody>
+    </table>
+
+
+
+
+  <div class="doc doc-children">
+
+
+
+
+
+
+
+
+
+
+
+  </div>
+
+    </div>
+
+</div>
+
+<div class="doc doc-object doc-class">
+
+
+
+<h2 id="trulens_eval.feedback.feedback.InvalidSelector" class="doc doc-heading">
+<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code>            <span class="doc doc-object-name doc-class-name">trulens_eval.feedback.feedback.InvalidSelector</span>
+
+
+<a href="#trulens_eval.feedback.feedback.InvalidSelector" class="headerlink" title="Permanent link">&para;</a></h2>
+
+
+    <div class="doc doc-contents first">
+            <p class="doc doc-class-bases">
+              Bases: <code><a class="autorefs autorefs-external" href="https://docs.python.org/3/library/exceptions.html#Exception">Exception</a></code></p>
+
+
+      <p>Raised when a selector names something that is missing in a record/app.</p>
+
+
+
+
+  <div class="doc doc-children">
+
+
+
+
+
+
+
+
+
+
+
+  </div>
+
+    </div>
+
+</div>
+
 <div class="doc doc-object doc-module">
 
 

diff --git a/trulens_eval/api/provider/huggingface/index.html b/trulens_eval/api/provider/huggingface/index.html
@@ -4657,7 +4657,7 @@ <h4 id="trulens_eval.feedback.provider.hugs.Huggingface.hallucination_evaluator"
             </td>
           </tr>
           <tr class="doc-section-item">
-            <td><code>retrieved_text_chunk</code></td>
+            <td><code>retrieved_text_chunks</code></td>
             <td class="doc-param-details">
               <div class="doc-md-description">
                 <p>These are the text chunks you have retrieved during RAG</p>

diff --git a/trulens_eval/api/providers/index.html b/trulens_eval/api/providers/index.html
@@ -5127,7 +5127,7 @@ <h4 id="trulens_eval.feedback.provider.hugs.Huggingface.hallucination_evaluator"
             </td>
           </tr>
           <tr class="doc-section-item">
-            <td><code>retrieved_text_chunk</code></td>
+            <td><code>retrieved_text_chunks</code></td>
             <td class="doc-param-details">
               <div class="doc-md-description">
                 <p>These are the text chunks you have retrieved during RAG</p>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -16,3 +16,5 @@ markdown-include >= 0.8.1

		jupyter_contrib_nbextensions >= 0.7.0
		notebook <7

		black >= 24.4.2