Skip to content

Commit

Permalink
Deploying to gh-pages from @ 00e916e 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
caufieldjh committed Dec 2, 2024
1 parent 6cf8090 commit e53a10d
Show file tree
Hide file tree
Showing 7 changed files with 44 additions and 5 deletions.
18 changes: 18 additions & 0 deletions curategpt.agents.html
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,7 @@
<li class="toctree-l4"><a class="reference internal" href="#curategpt.agents.huggingface_agent.HuggingFaceAgent.api"><code class="docutils literal notranslate"><span class="pre">HuggingFaceAgent.api</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#curategpt.agents.huggingface_agent.HuggingFaceAgent.cached_download"><code class="docutils literal notranslate"><span class="pre">HuggingFaceAgent.cached_download()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#curategpt.agents.huggingface_agent.HuggingFaceAgent.upload"><code class="docutils literal notranslate"><span class="pre">HuggingFaceAgent.upload()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#curategpt.agents.huggingface_agent.HuggingFaceAgent.upload_duckdb"><code class="docutils literal notranslate"><span class="pre">HuggingFaceAgent.upload_duckdb()</span></code></a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -1402,6 +1403,23 @@ <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="curategpt.agents.huggingface_agent.HuggingFaceAgent.upload_duckdb">
<span class="sig-name descname"><span class="pre">upload_duckdb</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">objects</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">repo_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">private</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</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="#curategpt.agents.huggingface_agent.HuggingFaceAgent.upload_duckdb" title="Link to this definition"></a></dt>
<dd><p>Upload an entire collection to a Hugging Face repository.</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>objects</strong> – The objects to upload.</p></li>
<li><p><strong>metadata</strong> – The metadata associated with the collection.</p></li>
<li><p><strong>repo_id</strong> – The repository ID on Hugging Face.</p></li>
<li><p><strong>private</strong> – Whether the repository should be private.</p></li>
<li><p><strong>kwargs</strong> – Additional arguments such as batch size or metadata options.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

</dd></dl>

</section>
Expand Down
4 changes: 2 additions & 2 deletions curategpt.evaluation.html
Original file line number Diff line number Diff line change
Expand Up @@ -542,7 +542,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi

<dl class="py attribute">
<dt class="sig sig-object py" id="curategpt.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="#curategpt.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="#curategpt.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>
Expand Down Expand Up @@ -610,7 +610,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi

<dl class="py attribute">
<dt class="sig sig-object py" id="curategpt.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="#curategpt.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="#curategpt.evaluation.evaluation_datamodel.Task.working_directory" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>
Expand Down
3 changes: 3 additions & 0 deletions curategpt.html
Original file line number Diff line number Diff line change
Expand Up @@ -328,6 +328,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
<li class="toctree-l4"><a class="reference internal" href="curategpt.agents.html#curategpt.agents.huggingface_agent.HuggingFaceAgent.api"><code class="docutils literal notranslate"><span class="pre">HuggingFaceAgent.api</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="curategpt.agents.html#curategpt.agents.huggingface_agent.HuggingFaceAgent.cached_download"><code class="docutils literal notranslate"><span class="pre">HuggingFaceAgent.cached_download()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="curategpt.agents.html#curategpt.agents.huggingface_agent.HuggingFaceAgent.upload"><code class="docutils literal notranslate"><span class="pre">HuggingFaceAgent.upload()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="curategpt.agents.html#curategpt.agents.huggingface_agent.HuggingFaceAgent.upload_duckdb"><code class="docutils literal notranslate"><span class="pre">HuggingFaceAgent.upload_duckdb()</span></code></a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -847,6 +848,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
<li class="toctree-l4"><a class="reference internal" href="curategpt.store.html#curategpt.store.duckdb_adapter.DuckDBAdapter.id_to_object"><code class="docutils literal notranslate"><span class="pre">DuckDBAdapter.id_to_object</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="curategpt.store.html#curategpt.store.duckdb_adapter.DuckDBAdapter.identifier_field"><code class="docutils literal notranslate"><span class="pre">DuckDBAdapter.identifier_field()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="curategpt.store.html#curategpt.store.duckdb_adapter.DuckDBAdapter.insert"><code class="docutils literal notranslate"><span class="pre">DuckDBAdapter.insert()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="curategpt.store.html#curategpt.store.duckdb_adapter.DuckDBAdapter.insert_from_huggingface"><code class="docutils literal notranslate"><span class="pre">DuckDBAdapter.insert_from_huggingface()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="curategpt.store.html#curategpt.store.duckdb_adapter.DuckDBAdapter.kill_process"><code class="docutils literal notranslate"><span class="pre">DuckDBAdapter.kill_process()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="curategpt.store.html#curategpt.store.duckdb_adapter.DuckDBAdapter.list_collection_names"><code class="docutils literal notranslate"><span class="pre">DuckDBAdapter.list_collection_names()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="curategpt.store.html#curategpt.store.duckdb_adapter.DuckDBAdapter.lookup"><code class="docutils literal notranslate"><span class="pre">DuckDBAdapter.lookup()</span></code></a></li>
Expand Down Expand Up @@ -1050,6 +1052,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
<li class="toctree-l4"><a class="reference internal" href="curategpt.store.html#curategpt.store.DuckDBAdapter.id_to_object"><code class="docutils literal notranslate"><span class="pre">DuckDBAdapter.id_to_object</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="curategpt.store.html#curategpt.store.DuckDBAdapter.identifier_field"><code class="docutils literal notranslate"><span class="pre">DuckDBAdapter.identifier_field()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="curategpt.store.html#curategpt.store.DuckDBAdapter.insert"><code class="docutils literal notranslate"><span class="pre">DuckDBAdapter.insert()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="curategpt.store.html#curategpt.store.DuckDBAdapter.insert_from_huggingface"><code class="docutils literal notranslate"><span class="pre">DuckDBAdapter.insert_from_huggingface()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="curategpt.store.html#curategpt.store.DuckDBAdapter.kill_process"><code class="docutils literal notranslate"><span class="pre">DuckDBAdapter.kill_process()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="curategpt.store.html#curategpt.store.DuckDBAdapter.list_collection_names"><code class="docutils literal notranslate"><span class="pre">DuckDBAdapter.list_collection_names()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="curategpt.store.html#curategpt.store.DuckDBAdapter.lookup"><code class="docutils literal notranslate"><span class="pre">DuckDBAdapter.lookup()</span></code></a></li>
Expand Down
Loading

0 comments on commit e53a10d

Please sign in to comment.