Deploying to gh-pages from @ af6fa60 🚀

curate_gpt.evaluation.html

@@ -524,7 +524,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="curate_gpt.evaluation.evaluation_datamodel.Task.model_fields">
-<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">FieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'additional_collections':</span> <span class="pre">FieldInfo(annotation=Union[List[str],</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'agent':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default='dae'),</span> <span class="pre">'embedding_model_name':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default='openai:'),</span> <span class="pre">'executed_on':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'extractor':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default='BasicExtractor'),</span> <span class="pre">'fields_to_mask':</span> <span class="pre">FieldInfo(annotation=Union[List[str],</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'fields_to_predict':</span> <span class="pre">FieldInfo(annotation=Union[List[str],</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'generate_background':</span> <span class="pre">FieldInfo(annotation=bool,</span> <span class="pre">required=False,</span> <span class="pre">default=False),</span> <span class="pre">'method':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'model_name':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default='gpt-3.5-turbo'),</span> <span class="pre">'num_testing':</span> <span class="pre">FieldInfo(annotation=int,</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'num_training':</span> <span class="pre">FieldInfo(annotation=int,</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'num_validation':</span> <span class="pre">FieldInfo(annotation=int,</span> <span class="pre">required=False,</span> <span class="pre">default=0),</span> <span class="pre">'report_path':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'results':</span> <span class="pre">FieldInfo(annotation=Union[ClassificationMetrics,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'source_collection':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'source_db_path':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'stratified_collection':</span> <span class="pre">FieldInfo(annotation=Union[StratifiedCollection,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'target_db_path':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'task_finished':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'task_started':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'working_directory':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">Path,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None)}</span></em><a class="headerlink" href="#curate_gpt.evaluation.evaluation_datamodel.Task.model_fields" title="Link to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">FieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'additional_collections':</span> <span class="pre">FieldInfo(annotation=Union[List[str],</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'agent':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default='dae'),</span> <span class="pre">'embedding_model_name':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default='openai:'),</span> <span class="pre">'executed_on':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'extractor':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default='BasicExtractor'),</span> <span class="pre">'fields_to_mask':</span> <span class="pre">FieldInfo(annotation=Union[List[str],</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'fields_to_predict':</span> <span class="pre">FieldInfo(annotation=Union[List[str],</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'generate_background':</span> <span class="pre">FieldInfo(annotation=bool,</span> <span class="pre">required=False,</span> <span class="pre">default=False),</span> <span class="pre">'method':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'model_name':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default='gpt-3.5-turbo'),</span> <span class="pre">'num_testing':</span> <span class="pre">FieldInfo(annotation=int,</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'num_training':</span> <span class="pre">FieldInfo(annotation=int,</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'num_validation':</span> <span class="pre">FieldInfo(annotation=int,</span> <span class="pre">required=False,</span> <span class="pre">default=0),</span> <span class="pre">'report_path':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'results':</span> <span class="pre">FieldInfo(annotation=Union[ClassificationMetrics,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'source_collection':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'source_db_path':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'stratified_collection':</span> <span class="pre">FieldInfo(annotation=Union[StratifiedCollection,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'target_db_path':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'task_finished':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'task_started':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None),</span> <span class="pre">'working_directory':</span> <span class="pre">FieldInfo(annotation=Union[Path,</span> <span class="pre">str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None)}</span></em><a class="headerlink" href="#curate_gpt.evaluation.evaluation_datamodel.Task.model_fields" title="Link to this definition"></a></dt>
 <dd><p>Metadata about the fields defined on the model,
 mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo] objects.</p>
 <p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
@@ -592,7 +592,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="curate_gpt.evaluation.evaluation_datamodel.Task.working_directory">
-<span class="sig-name descname"><span class="pre">working_directory</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">Path</span></code><span class="pre">,</span> <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code><span class="pre">]</span></em><a class="headerlink" href="#curate_gpt.evaluation.evaluation_datamodel.Task.working_directory" title="Link to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">working_directory</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">Path</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code><span class="pre">]</span></em><a class="headerlink" href="#curate_gpt.evaluation.evaluation_datamodel.Task.working_directory" title="Link to this definition"></a></dt>
 <dd></dd></dl>
 
 </dd></dl>

curate_gpt.formatters.html

@@ -57,6 +57,7 @@
 <li class="toctree-l2"><a class="reference internal" href="#module-curate_gpt.formatters.format_utils">curate_gpt.formatters.format_utils module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#curate_gpt.formatters.format_utils.camelify"><code class="docutils literal notranslate"><span class="pre">camelify()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#curate_gpt.formatters.format_utils.object_as_yaml"><code class="docutils literal notranslate"><span class="pre">object_as_yaml()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="#curate_gpt.formatters.format_utils.remove_formatting"><code class="docutils literal notranslate"><span class="pre">remove_formatting()</span></code></a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="#module-curate_gpt.formatters">Module contents</a></li>
@@ -134,6 +135,26 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 </dl>
 </dd></dl>
 
+<dl class="py function">
+<dt class="sig sig-object py" id="curate_gpt.formatters.format_utils.remove_formatting">
+<span class="sig-prename descclassname"><span class="pre">curate_gpt.formatters.format_utils.</span></span><span class="sig-name descname"><span class="pre">remove_formatting</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expect_format</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curate_gpt.formatters.format_utils.remove_formatting" title="Link to this definition"></a></dt>
+<dd><p>Remove markdown formatting from text if present.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>text</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>)</p></li>
+<li><p><strong>expect_format</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – The expected format of the text, e.g., “json” (optional)</p></li>
+</ul>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
+</dd>
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p></p>
+</dd>
+</dl>
+</dd></dl>
+
 </section>
 <section id="module-curate_gpt.formatters">
 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-curate_gpt.formatters" title="Link to this heading"></a></h2>

curate_gpt.html

@@ -733,6 +733,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
 <li class="toctree-l2"><a class="reference internal" href="curate_gpt.formatters.html#module-curate_gpt.formatters.format_utils">curate_gpt.formatters.format_utils module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="curate_gpt.formatters.html#curate_gpt.formatters.format_utils.camelify"><code class="docutils literal notranslate"><span class="pre">camelify()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="curate_gpt.formatters.html#curate_gpt.formatters.format_utils.object_as_yaml"><code class="docutils literal notranslate"><span class="pre">object_as_yaml()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="curate_gpt.formatters.html#curate_gpt.formatters.format_utils.remove_formatting"><code class="docutils literal notranslate"><span class="pre">remove_formatting()</span></code></a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="curate_gpt.formatters.html#module-curate_gpt.formatters">Module contents</a></li>

genindex.html

@@ -3354,6 +3354,8 @@ <h2 id="R">R</h2>
       </ul></li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="curate_gpt.formatters.html#curate_gpt.formatters.format_utils.remove_formatting">remove_formatting() (in module curate_gpt.formatters.format_utils)</a>
+</li>
       <li><a href="curate_gpt.agents.html#curate_gpt.agents.evidence_agent.EvidenceUpdatePolicyEnum.replace">replace (curate_gpt.agents.evidence_agent.EvidenceUpdatePolicyEnum attribute)</a>
 </li>
       <li><a href="curate_gpt.agents.html#curate_gpt.agents.chat_agent.replace_references_with_links">replace_references_with_links() (in module curate_gpt.agents.chat_agent)</a>