Deploying to gh-pages from @ e35bed8 🚀

curate_gpt.evaluation.html

@@ -258,6 +258,26 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 </dl>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="curate_gpt.evaluation.dae_evaluator.DatabaseAugmentedCompletionEvaluator.evaluate_object">
+<span class="sig-name descname"><span class="pre">evaluate_object</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curate_gpt.evaluation.dae_evaluator.DatabaseAugmentedCompletionEvaluator.evaluate_object" title="Link to this definition"></a></dt>
+<dd><p>Evaluate the agent on a single object.</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>obj</strong></p></li>
+<li><p><strong>kwargs</strong></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"><a class="reference internal" href="#curate_gpt.evaluation.evaluation_datamodel.ClassificationMetrics" title="curate_gpt.evaluation.evaluation_datamodel.ClassificationMetrics"><code class="xref py py-class docutils literal notranslate"><span class="pre">ClassificationMetrics</span></code></a></span></p>
+</dd>
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p></p>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py attribute">
 <dt class="sig sig-object py" id="curate_gpt.evaluation.dae_evaluator.DatabaseAugmentedCompletionEvaluator.fields_to_mask">
 <span class="sig-name descname"><span class="pre">fields_to_mask</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">List</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></em><a class="headerlink" href="#curate_gpt.evaluation.dae_evaluator.DatabaseAugmentedCompletionEvaluator.fields_to_mask" title="Link to this definition"></a></dt>
@@ -524,7 +544,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[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>
+<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>
 <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 +612,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">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>
+<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>
 <dd></dd></dl>
 
 </dd></dl>

curate_gpt.html

@@ -522,6 +522,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
 <li class="toctree-l3"><a class="reference internal" href="curate_gpt.evaluation.html#curate_gpt.evaluation.dae_evaluator.DatabaseAugmentedCompletionEvaluator"><code class="docutils literal notranslate"><span class="pre">DatabaseAugmentedCompletionEvaluator</span></code></a><ul>
 <li class="toctree-l4"><a class="reference internal" href="curate_gpt.evaluation.html#curate_gpt.evaluation.dae_evaluator.DatabaseAugmentedCompletionEvaluator.agent"><code class="docutils literal notranslate"><span class="pre">DatabaseAugmentedCompletionEvaluator.agent</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="curate_gpt.evaluation.html#curate_gpt.evaluation.dae_evaluator.DatabaseAugmentedCompletionEvaluator.evaluate"><code class="docutils literal notranslate"><span class="pre">DatabaseAugmentedCompletionEvaluator.evaluate()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="curate_gpt.evaluation.html#curate_gpt.evaluation.dae_evaluator.DatabaseAugmentedCompletionEvaluator.evaluate_object"><code class="docutils literal notranslate"><span class="pre">DatabaseAugmentedCompletionEvaluator.evaluate_object()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="curate_gpt.evaluation.html#curate_gpt.evaluation.dae_evaluator.DatabaseAugmentedCompletionEvaluator.fields_to_mask"><code class="docutils literal notranslate"><span class="pre">DatabaseAugmentedCompletionEvaluator.fields_to_mask</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="curate_gpt.evaluation.html#curate_gpt.evaluation.dae_evaluator.DatabaseAugmentedCompletionEvaluator.fields_to_predict"><code class="docutils literal notranslate"><span class="pre">DatabaseAugmentedCompletionEvaluator.fields_to_predict</span></code></a></li>
 </ul>

genindex.html

@@ -1536,7 +1536,11 @@ <h2 id="E">E</h2>
 </li>
       </ul></li>
       <li><a href="curate_gpt.evaluation.html#curate_gpt.evaluation.base_evaluator.BaseEvaluator.evaluate_object">evaluate_object() (curate_gpt.evaluation.base_evaluator.BaseEvaluator method)</a>
+
+      <ul>
+        <li><a href="curate_gpt.evaluation.html#curate_gpt.evaluation.dae_evaluator.DatabaseAugmentedCompletionEvaluator.evaluate_object">(curate_gpt.evaluation.dae_evaluator.DatabaseAugmentedCompletionEvaluator method)</a>
 </li>
+      </ul></li>
       <li><a href="curate_gpt.evaluation.html#curate_gpt.evaluation.calc_statistics.evaluate_predictions">evaluate_predictions() (in module curate_gpt.evaluation.calc_statistics)</a>
 </li>
       <li><a href="curate_gpt.agents.html#curate_gpt.agents.evidence_agent.EvidenceAgent.evidence_update_policy">evidence_update_policy (curate_gpt.agents.evidence_agent.EvidenceAgent attribute)</a>
@@ -1563,6 +1567,8 @@ <h2 id="E">E</h2>
       </ul></li>
       <li><a href="curate_gpt.utils.html#curate_gpt.utils.eval_utils.Outcome.expected">expected (curate_gpt.utils.eval_utils.Outcome attribute)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="curate_gpt.wrappers.html#curate_gpt.wrappers.base_wrapper.BaseWrapper.external_search">external_search() (curate_gpt.wrappers.base_wrapper.BaseWrapper method)</a>
 
       <ul>
@@ -1593,8 +1599,6 @@ <h2 id="E">E</h2>
         <li><a href="curate_gpt.wrappers.ontology.html#curate_gpt.wrappers.ontology.OntologyWrapper.external_search">(curate_gpt.wrappers.ontology.OntologyWrapper method)</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="curate_gpt.agents.html#curate_gpt.agents.dase_agent.DatabaseAugmentedStructuredExtraction.extract">extract() (curate_gpt.agents.dase_agent.DatabaseAugmentedStructuredExtraction method)</a>
 
       <ul>