Skip to content
This repository has been archived by the owner on Jan 9, 2024. It is now read-only.

Commit

Permalink
make html
Browse files Browse the repository at this point in the history
  • Loading branch information
jeffrey committed Jan 3, 2024
1 parent 979c6f9 commit 562aeb5
Show file tree
Hide file tree
Showing 18 changed files with 597 additions and 360 deletions.
Binary file modified docs/build/doctrees/RAGchain.benchmark.answer.doctree
View file
Binary file not shown.
Binary file modified docs/build/doctrees/RAGchain.benchmark.doctree
View file
Binary file not shown.
Binary file modified docs/build/doctrees/RAGchain.benchmark.retrieval.doctree
View file
Binary file not shown.
Binary file modified docs/build/doctrees/RAGchain.utils.linker.doctree
View file
Binary file not shown.
Binary file modified docs/build/doctrees/RAGchain.utils.websearch.doctree
View file
Binary file not shown.
Binary file modified docs/build/doctrees/environment.pickle
View file
Binary file not shown.
49 changes: 49 additions & 0 deletions docs/build/html/RAGchain.benchmark.answer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,16 @@
</li>
</ul>
</li>
<li><a class="reference internal"
href="#RAGchain.benchmark.answer.metrics.EM_answer"><code
class="docutils literal notranslate"><span class="pre">EM_answer</span></code></a>
<ul>
<li><a class="reference internal"
href="#RAGchain.benchmark.answer.metrics.EM_answer.retrieval_metric_function"><code
class="docutils literal notranslate"><span class="pre">EM_answer.retrieval_metric_function()</span></code></a>
</li>
</ul>
</li>
<li><a class="reference internal" href="#RAGchain.benchmark.answer.metrics.KF1"><code
class="docutils literal notranslate"><span class="pre">KF1</span></code></a>
<ul>
Expand Down Expand Up @@ -382,6 +392,45 @@ <h2>RAGchain.benchmark.answer.metrics module<a class="headerlink"
</dd>
</dl>

<dl class="py class">
<dt class="sig sig-object py" id="RAGchain.benchmark.answer.metrics.EM_answer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span
class="sig-prename descclassname"><span class="pre">RAGchain.benchmark.answer.metrics.</span></span><span
class="sig-name descname"><span class="pre">EM_answer</span></span><a
class="headerlink" href="#RAGchain.benchmark.answer.metrics.EM_answer"
title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal"
href="#RAGchain.benchmark.answer.metrics.BaseAnswerMetric"
title="RAGchain.benchmark.answer.metrics.BaseAnswerMetric"><code
class="xref py py-class docutils literal notranslate"><span class="pre">BaseAnswerMetric</span></code></a>
</p>
<dl class="py method">
<dt class="sig sig-object py"
id="RAGchain.benchmark.answer.metrics.EM_answer.retrieval_metric_function">
<span class="sig-name descname"><span class="pre">retrieval_metric_function</span></span><span
class="sig-paren">(</span><em class="sig-param"><span
class="n"><span class="pre">solutions</span></span><span
class="p"><span class="pre">:</span></span><span
class="w"> </span><span class="n"><span class="pre">List</span><span
class="p"><span class="pre">[</span></span><span
class="pre">str</span><span class="p"><span
class="pre">]</span></span></span></em>, <em class="sig-param"><span
class="n"><span class="pre">pred</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">float</span></span></span><a class="headerlink"
href="#RAGchain.benchmark.answer.metrics.EM_answer.retrieval_metric_function"
title="Link to this definition"></a>
</dt>
<dd></dd>
</dl>

</dd>
</dl>

<dl class="py class">
<dt class="sig sig-object py" id="RAGchain.benchmark.answer.metrics.KF1">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span
Expand Down
30 changes: 23 additions & 7 deletions docs/build/html/RAGchain.benchmark.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,16 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal"
href="RAGchain.benchmark.answer.html#RAGchain.benchmark.answer.metrics.EM_answer"><code
class="docutils literal notranslate"><span class="pre">EM_answer</span></code></a>
<ul>
<li class="toctree-l4"><a class="reference internal"
href="RAGchain.benchmark.answer.html#RAGchain.benchmark.answer.metrics.EM_answer.retrieval_metric_function"><code
class="docutils literal notranslate"><span class="pre">EM_answer.retrieval_metric_function()</span></code></a>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal"
href="RAGchain.benchmark.answer.html#RAGchain.benchmark.answer.metrics.KF1"><code
class="docutils literal notranslate"><span class="pre">KF1</span></code></a>
Expand Down Expand Up @@ -678,8 +688,14 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
<li class="toctree-l4"><a class="reference internal" href="RAGchain.benchmark.retrieval.html#RAGchain.benchmark.retrieval.metrics.DCG.retrieval_metric_function"><code class="docutils literal notranslate"><span class="pre">DCG.retrieval_metric_function()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="RAGchain.benchmark.retrieval.html#RAGchain.benchmark.retrieval.metrics.ExactlyMatch"><code class="docutils literal notranslate"><span class="pre">ExactlyMatch</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="RAGchain.benchmark.retrieval.html#RAGchain.benchmark.retrieval.metrics.ExactlyMatch.retrieval_metric_function"><code class="docutils literal notranslate"><span class="pre">ExactlyMatch.retrieval_metric_function()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal"
href="RAGchain.benchmark.retrieval.html#RAGchain.benchmark.retrieval.metrics.EM_retrieval"><code
class="docutils literal notranslate"><span class="pre">EM_retrieval</span></code></a>
<ul>
<li class="toctree-l4"><a class="reference internal"
href="RAGchain.benchmark.retrieval.html#RAGchain.benchmark.retrieval.metrics.EM_retrieval.retrieval_metric_function"><code
class="docutils literal notranslate"><span
class="pre">EM_retrieval.retrieval_metric_function()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="RAGchain.benchmark.retrieval.html#RAGchain.benchmark.retrieval.metrics.F1"><code class="docutils literal notranslate"><span class="pre">F1</span></code></a><ul>
Expand Down Expand Up @@ -817,9 +833,9 @@ <h2>RAGchain.benchmark.base module<a class="headerlink" href="#module-RAGchain.b
<span class="sig-name descname"><span class="pre">answer_gt_metrics</span></span><em
class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span
class="w"> </span><span class="pre">['BLEU',</span> <span class="pre">'METEOR',</span>
<span class="pre">'ROUGE']</span></em><a class="headerlink"
href="#RAGchain.benchmark.base.BaseEvaluator.answer_gt_metrics"
title="Link to this definition"></a></dt>
<span class="pre">'ROUGE',</span> <span class="pre">'EM_answer']</span></em><a
class="headerlink" href="#RAGchain.benchmark.base.BaseEvaluator.answer_gt_metrics"
title="Link to this definition"></a></dt>
<dd></dd>
</dl>

Expand Down Expand Up @@ -876,8 +892,8 @@ <h2>RAGchain.benchmark.base module<a class="headerlink" href="#module-RAGchain.b
<span class="sig-name descname"><span class="pre">retrieval_gt_metrics</span></span><em
class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span
class="w"> </span><span class="pre">['Hole',</span> <span
class="pre">'TopK_Accuracy',</span> <span class="pre">'EM',</span> <span class="pre">'F1_score',</span>
<span class="pre">'Recall',</span> <span class="pre">'Precision']</span></em><a
class="pre">'TopK_Accuracy',</span> <span class="pre">'EM_retrieval',</span> <span
class="pre">'F1_score',</span> <span class="pre">'Recall',</span> <span class="pre">'Precision']</span></em><a
class="headerlink" href="#RAGchain.benchmark.base.BaseEvaluator.retrieval_gt_metrics"
title="Link to this definition"></a></dt>
<dd></dd>
Expand Down
40 changes: 34 additions & 6 deletions docs/build/html/RAGchain.benchmark.retrieval.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,13 @@
<li><a class="reference internal" href="#RAGchain.benchmark.retrieval.metrics.DCG.retrieval_metric_function"><code class="docutils literal notranslate"><span class="pre">DCG.retrieval_metric_function()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#RAGchain.benchmark.retrieval.metrics.ExactlyMatch"><code class="docutils literal notranslate"><span class="pre">ExactlyMatch</span></code></a><ul>
<li><a class="reference internal" href="#RAGchain.benchmark.retrieval.metrics.ExactlyMatch.retrieval_metric_function"><code class="docutils literal notranslate"><span class="pre">ExactlyMatch.retrieval_metric_function()</span></code></a></li>
<li><a class="reference internal" href="#RAGchain.benchmark.retrieval.metrics.EM_retrieval"><code
class="docutils literal notranslate"><span class="pre">EM_retrieval</span></code></a>
<ul>
<li><a class="reference internal"
href="#RAGchain.benchmark.retrieval.metrics.EM_retrieval.retrieval_metric_function"><code
class="docutils literal notranslate"><span
class="pre">EM_retrieval.retrieval_metric_function()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#RAGchain.benchmark.retrieval.metrics.F1"><code class="docutils literal notranslate"><span class="pre">F1</span></code></a><ul>
Expand Down Expand Up @@ -259,12 +264,35 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="RAGchain.benchmark.retrieval.metrics.ExactlyMatch">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">RAGchain.benchmark.retrieval.metrics.</span></span><span class="sig-name descname"><span class="pre">ExactlyMatch</span></span><a class="headerlink" href="#RAGchain.benchmark.retrieval.metrics.ExactlyMatch" title="Link to this definition"></a></dt>
<dt class="sig sig-object py" id="RAGchain.benchmark.retrieval.metrics.EM_retrieval">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span
class="sig-prename descclassname"><span class="pre">RAGchain.benchmark.retrieval.metrics.</span></span><span
class="sig-name descname"><span class="pre">EM_retrieval</span></span><a class="headerlink"
href="#RAGchain.benchmark.retrieval.metrics.EM_retrieval"
title="Link to this definition"></a>
</dt>
<dd><p>Bases: <a class="reference internal" href="#RAGchain.benchmark.retrieval.metrics.BaseRetrievalMetric" title="RAGchain.benchmark.retrieval.metrics.BaseRetrievalMetric"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseRetrievalMetric</span></code></a></p>
<dl class="py method">
<dt class="sig sig-object py" id="RAGchain.benchmark.retrieval.metrics.ExactlyMatch.retrieval_metric_function">
<span class="sig-name descname"><span class="pre">retrieval_metric_function</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">solution</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="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pred</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="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">k_value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</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">1</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">float</span></span></span><a class="headerlink" href="#RAGchain.benchmark.retrieval.metrics.ExactlyMatch.retrieval_metric_function" title="Link to this definition"></a></dt>
<dt class="sig sig-object py" id="RAGchain.benchmark.retrieval.metrics.EM_retrieval.retrieval_metric_function">
<span class="sig-name descname"><span class="pre">retrieval_metric_function</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">solution</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="p"><span
class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span
class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pred</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="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span
class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span
class="pre">k_value</span></span><span class="p"><span class="pre">:</span></span><span
class="w"> </span><span class="n"><span class="pre">int</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">1</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">float</span></span></span><a class="headerlink"
href="#RAGchain.benchmark.retrieval.metrics.EM_retrieval.retrieval_metric_function"
title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>
Expand Down
3 changes: 0 additions & 3 deletions docs/build/html/RAGchain.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -842,9 +842,6 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
<li class="toctree-l4"><a class="reference internal"
href="RAGchain.utils.websearch.html#module-RAGchain.utils.websearch.bing_search">RAGchain.utils.websearch.bing_search
module</a></li>
<li class="toctree-l4"><a class="reference internal"
href="RAGchain.utils.websearch.html#module-RAGchain.utils.websearch.brave_search">RAGchain.utils.websearch.brave_search
module</a></li>
<li class="toctree-l4"><a class="reference internal"
href="RAGchain.utils.websearch.html#module-RAGchain.utils.websearch.google_search">RAGchain.utils.websearch.google_search
module</a></li>
Expand Down
Loading

0 comments on commit 562aeb5

Please sign in to comment.