[skip ci] Update docs

docs/_build/html/_modules/index.html

@@ -96,7 +96,7 @@ <h1>All modules for which code is available</h1>
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, NotDiamond.
-      <span class="lastupdated">Last updated on Nov 25, 2024.
+      <span class="lastupdated">Last updated on Nov 26, 2024.
       </span></p>
   </div>
 

docs/_build/html/_modules/notdiamond/exceptions.html

@@ -131,7 +131,7 @@ <h1>Source code for notdiamond.exceptions</h1><div class="highlight"><pre>
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, NotDiamond.
-      <span class="lastupdated">Last updated on Nov 25, 2024.
+      <span class="lastupdated">Last updated on Nov 26, 2024.
       </span></p>
   </div>
 

docs/_build/html/_modules/notdiamond/llms/client.html

@@ -1857,7 +1857,7 @@ <h1>Source code for notdiamond.llms.client</h1><div class="highlight"><pre>
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, NotDiamond.
-      <span class="lastupdated">Last updated on Nov 25, 2024.
+      <span class="lastupdated">Last updated on Nov 26, 2024.
       </span></p>
   </div>
 

docs/_build/html/_modules/notdiamond/llms/config.html

@@ -442,7 +442,7 @@ <h1>Source code for notdiamond.llms.config</h1><div class="highlight"><pre>
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, NotDiamond.
-      <span class="lastupdated">Last updated on Nov 25, 2024.
+      <span class="lastupdated">Last updated on Nov 26, 2024.
       </span></p>
   </div>
 

docs/_build/html/_modules/notdiamond/llms/providers.html

@@ -283,7 +283,7 @@ <h1>Source code for notdiamond.llms.providers</h1><div class="highlight"><pre>
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, NotDiamond.
-      <span class="lastupdated">Last updated on Nov 25, 2024.
+      <span class="lastupdated">Last updated on Nov 26, 2024.
       </span></p>
   </div>
 

docs/_build/html/_modules/notdiamond/llms/request.html

@@ -439,7 +439,7 @@ <h1>Source code for notdiamond.llms.request</h1><div class="highlight"><pre>
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, NotDiamond.
-      <span class="lastupdated">Last updated on Nov 25, 2024.
+      <span class="lastupdated">Last updated on Nov 26, 2024.
       </span></p>
   </div>
 

docs/_build/html/_modules/notdiamond/metrics/metric.html

@@ -133,7 +133,7 @@ <h1>Source code for notdiamond.metrics.metric</h1><div class="highlight"><pre>
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, NotDiamond.
-      <span class="lastupdated">Last updated on Nov 25, 2024.
+      <span class="lastupdated">Last updated on Nov 26, 2024.
       </span></p>
   </div>
 

docs/_build/html/_modules/notdiamond/metrics/request.html

@@ -132,7 +132,7 @@ <h1>Source code for notdiamond.metrics.request</h1><div class="highlight"><pre>
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, NotDiamond.
-      <span class="lastupdated">Last updated on Nov 25, 2024.
+      <span class="lastupdated">Last updated on Nov 26, 2024.
       </span></p>
   </div>
 

docs/_build/html/_modules/notdiamond/prompts.html

@@ -146,7 +146,7 @@ <h1>Source code for notdiamond.prompts</h1><div class="highlight"><pre>
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, NotDiamond.
-      <span class="lastupdated">Last updated on Nov 25, 2024.
+      <span class="lastupdated">Last updated on Nov 26, 2024.
       </span></p>
   </div>
 

docs/_build/html/_modules/notdiamond/toolkit/litellm/litellm_notdiamond.html

@@ -404,7 +404,7 @@ <h1>Source code for notdiamond.toolkit.litellm.litellm_notdiamond</h1><div class
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, NotDiamond.
-      <span class="lastupdated">Last updated on Nov 25, 2024.
+      <span class="lastupdated">Last updated on Nov 26, 2024.
       </span></p>
   </div>
 

docs/_build/html/_modules/notdiamond/toolkit/litellm/main.html

@@ -3170,7 +3170,7 @@ <h1>Source code for notdiamond.toolkit.litellm.main</h1><div class="highlight"><
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, NotDiamond.
-      <span class="lastupdated">Last updated on Nov 25, 2024.
+      <span class="lastupdated">Last updated on Nov 26, 2024.
       </span></p>
   </div>
 

docs/_build/html/_modules/notdiamond/toolkit/openai.html

@@ -298,7 +298,7 @@ <h1>Source code for notdiamond.toolkit.openai</h1><div class="highlight"><pre>
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, NotDiamond.
-      <span class="lastupdated">Last updated on Nov 25, 2024.
+      <span class="lastupdated">Last updated on Nov 26, 2024.
       </span></p>
   </div>
 

docs/_build/html/_modules/notdiamond/types.html

@@ -137,7 +137,7 @@ <h1>Source code for notdiamond.types</h1><div class="highlight"><pre>
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, NotDiamond.
-      <span class="lastupdated">Last updated on Nov 25, 2024.
+      <span class="lastupdated">Last updated on Nov 26, 2024.
       </span></p>
   </div>
 

docs/_build/html/index.html

@@ -112,7 +112,7 @@ <h1>Not Diamond Python library documentation<a class="headerlink" href="#not-dia
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, NotDiamond.
-      <span class="lastupdated">Last updated on Nov 25, 2024.
+      <span class="lastupdated">Last updated on Nov 26, 2024.
       </span></p>
   </div>
 

docs/_build/html/py-modindex.html

@@ -163,7 +163,7 @@ <h1>Python Module Index</h1>
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, NotDiamond.
-      <span class="lastupdated">Last updated on Nov 25, 2024.
+      <span class="lastupdated">Last updated on Nov 26, 2024.
       </span></p>
   </div>
 

docs/_build/html/search.html

@@ -96,7 +96,7 @@
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, NotDiamond.
-      <span class="lastupdated">Last updated on Nov 25, 2024.
+      <span class="lastupdated">Last updated on Nov 26, 2024.
       </span></p>
   </div>
 

docs/_build/html/source/intro.html

@@ -146,7 +146,7 @@ <h2>Sending your first Not Diamond API request<a class="headerlink" href="#sendi
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, NotDiamond.
-      <span class="lastupdated">Last updated on Nov 25, 2024.
+      <span class="lastupdated">Last updated on Nov 26, 2024.
       </span></p>
   </div>
 

docs/_build/html/source/notdiamond.html

@@ -525,7 +525,7 @@ <h1>NotDiamond package<a class="headerlink" href="#notdiamond-package" title="Li
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, NotDiamond.
-      <span class="lastupdated">Last updated on Nov 25, 2024.
+      <span class="lastupdated">Last updated on Nov 26, 2024.
       </span></p>
   </div>
 

docs/_build/html/source/notdiamond.llms.html

@@ -1710,7 +1710,7 @@ <h2>notdiamond.llms.providers<a class="headerlink" href="#notdiamond-llms-provid
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, NotDiamond.
-      <span class="lastupdated">Last updated on Nov 25, 2024.
+      <span class="lastupdated">Last updated on Nov 26, 2024.
       </span></p>
   </div>
 

docs/_build/html/source/notdiamond.metrics.html

@@ -175,7 +175,7 @@ <h1>notdiamond.metrics<a class="headerlink" href="#notdiamond-metrics" title="Li
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, NotDiamond.
-      <span class="lastupdated">Last updated on Nov 25, 2024.
+      <span class="lastupdated">Last updated on Nov 26, 2024.
       </span></p>
   </div>
 

docs/_build/html/source/notdiamond.toolkit.html

@@ -196,7 +196,7 @@ <h2>notdiamond.toolkit.custom_router<a class="headerlink" href="#notdiamond-tool
 
 <dl class="py method">
 <dt class="sig sig-object py" id="notdiamond.toolkit.custom_router.CustomRouter.eval">
-<span class="sig-name descname"><span class="pre">eval</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="notdiamond.llms.html#notdiamond.llms.config.LLMConfig" title="notdiamond.llms.config.LLMConfig"><span class="pre">LLMConfig</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">DataFrame</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prompt_column</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_column</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">score_column</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">preference_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">DataFrame</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">DataFrame</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/notdiamond/toolkit/custom_router.html#CustomRouter.eval"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#notdiamond.toolkit.custom_router.CustomRouter.eval" title="Link to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">eval</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="notdiamond.llms.html#notdiamond.llms.config.LLMConfig" title="notdiamond.llms.config.LLMConfig"><span class="pre">LLMConfig</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">DataFrame</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prompt_column</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_column</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">score_column</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">preference_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include_latency</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">DataFrame</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">DataFrame</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/notdiamond/toolkit/custom_router.html#CustomRouter.eval"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#notdiamond.toolkit.custom_router.CustomRouter.eval" title="Link to this definition"></a></dt>
 <dd><p>Method to evaluate a custom router using provided dataset.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -211,6 +211,7 @@ <h2>notdiamond.toolkit.custom_router<a class="headerlink" href="#notdiamond-tool
 to the score given to the response from the LLM.</p></li>
 <li><p><strong>preference_id</strong> (<em>str</em>) – The preference_id associated with the custom router
 returned from .fit().</p></li>
+<li><p><strong>include_latency</strong> (<em>bool</em>)</p></li>
 </ul>
 </dd>
 <dt class="field-even">Raises<span class="colon">:</span></dt>
@@ -352,7 +353,7 @@ <h2>notdiamond.toolkit.langchain<a class="headerlink" href="#notdiamond-toolkit-
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, NotDiamond.
-      <span class="lastupdated">Last updated on Nov 25, 2024.
+      <span class="lastupdated">Last updated on Nov 26, 2024.
       </span></p>
   </div>
 

docs/_build/html/source/notdiamond.toolkit.litellm.html

@@ -405,7 +405,7 @@ <h1>notdiamond.toolkit.litellm<a class="headerlink" href="#notdiamond-toolkit-li
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, NotDiamond.
-      <span class="lastupdated">Last updated on Nov 25, 2024.
+      <span class="lastupdated">Last updated on Nov 26, 2024.
       </span></p>
   </div>
 

docs/_build/html/source/notdiamond.toolkit.rag.html

@@ -138,7 +138,7 @@ <h2>notdiamond.toolkit.rag.workflow<a class="headerlink" href="#notdiamond-toolk
 
   <div role="contentinfo">
     <p>&#169; Copyright 2024, NotDiamond.
-      <span class="lastupdated">Last updated on Nov 25, 2024.
+      <span class="lastupdated">Last updated on Nov 26, 2024.
       </span></p>
   </div>