Skip to content

Commit

Permalink
deploy: 1b3a6c2
Browse files Browse the repository at this point in the history
  • Loading branch information
MadcowD committed Oct 9, 2024
1 parent b7a7623 commit 6c4535c
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 4 deletions.
9 changes: 8 additions & 1 deletion core_concepts/configuration.html
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ <h1>Configuration<a class="headerlink" href="#configuration" title="Link to this
<p>ell provides various configuration options to customize its behavior.</p>
<dl class="py function">
<dt class="sig sig-object py" id="ell.init">
<span class="sig-prename descclassname"><span class="pre">ell.</span></span><span class="sig-name descname"><span class="pre">init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">store</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Store</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</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>, <em class="sig-param"><span class="n"><span class="pre">autocommit</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">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lazy_versioning</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">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_api_params</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">Any</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon"></span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#ell.init" title="Link to this definition" x-intersect.margin.0%.0%.-70%.0%="activeSection = '#ell.init'"></a></dt>
<span class="sig-prename descclassname"><span class="pre">ell.</span></span><span class="sig-name descname"><span class="pre">init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">store</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Store</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</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>, <em class="sig-param"><span class="n"><span class="pre">autocommit</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">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lazy_versioning</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">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_api_params</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">Any</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">autocommit_model</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">'gpt-4o-mini'</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon"></span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#ell.init" title="Link to this definition" x-intersect.margin.0%.0%.-70%.0%="activeSection = '#ell.init'"></a></dt>
<dd><p>Initialize the ELL configuration with various settings.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Expand All @@ -362,6 +362,7 @@ <h1>Configuration<a class="headerlink" href="#configuration" title="Link to this
<li><p><strong>lazy_versioning</strong> (<em>bool</em>) – Enable or disable lazy versioning.</p></li>
<li><p><strong>default_api_params</strong> (<em>Dict</em><em>[</em><em>str</em><em>, </em><em>Any</em><em>]</em><em>, </em><em>optional</em>) – Set default parameters for language models.</p></li>
<li><p><strong>default_openai_client</strong> (<em>openai.Client</em><em>, </em><em>optional</em>) – Set the default OpenAI client.</p></li>
<li><p><strong>autocommit_model</strong> (<em>str</em>) – Set the model used for autocommitting.</p></li>
</ul>
</dd>
</dl>
Expand All @@ -377,6 +378,11 @@ <h1>Configuration<a class="headerlink" href="#configuration" title="Link to this
<dd><p>If True, enables automatic committing of changes to the store.</p>
</dd></dl>
<dl class="py attribute pydantic_field">
<dt class="sig sig-object py" id="ell.Config.autocommit_model">
<em class="property"><span class="pre">field</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">autocommit_model</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'gpt-4o-mini'</span></em><a class="headerlink" href="#ell.Config.autocommit_model" title="Link to this definition" x-intersect.margin.0%.0%.-70%.0%="activeSection = '#ell.Config.autocommit_model'"></a></dt>
<dd><p>When set, changes the default autocommit model from GPT 4o mini.</p>
</dd></dl>
<dl class="py attribute pydantic_field">
<dt class="sig sig-object py" id="ell.Config.default_api_params">
<em class="property"><span class="pre">field</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">default_api_params</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><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">Any</span><span class="p"><span class="pre">]</span></span></em><em class="property"> <span class="pre">[Optional]</span></em><a class="headerlink" href="#ell.Config.default_api_params" title="Link to this definition" x-intersect.margin.0%.0%.-70%.0%="activeSection = '#ell.Config.default_api_params'"></a></dt>
<dd><p>Default parameters for language models.</p>
Expand Down Expand Up @@ -488,6 +494,7 @@ <h1>Configuration<a class="headerlink" href="#configuration" title="Link to this
<li><a :data-current="activeSection === '#ell.init'" class="reference internal" href="#ell.init"><code class="docutils literal notranslate"><span class="pre">init()</span></code></a></li>
<li><a :data-current="activeSection === '#ell.Config'" class="reference internal" href="#ell.Config"><code class="docutils literal notranslate"><span class="pre">Config</span></code></a><ul>
<li><a :data-current="activeSection === '#ell.Config.autocommit'" class="reference internal" href="#ell.Config.autocommit"><code class="docutils literal notranslate"><span class="pre">Config.autocommit</span></code></a></li>
<li><a :data-current="activeSection === '#ell.Config.autocommit_model'" class="reference internal" href="#ell.Config.autocommit_model"><code class="docutils literal notranslate"><span class="pre">Config.autocommit_model</span></code></a></li>
<li><a :data-current="activeSection === '#ell.Config.default_api_params'" class="reference internal" href="#ell.Config.default_api_params"><code class="docutils literal notranslate"><span class="pre">Config.default_api_params</span></code></a></li>
<li><a :data-current="activeSection === '#ell.Config.lazy_versioning'" class="reference internal" href="#ell.Config.lazy_versioning"><code class="docutils literal notranslate"><span class="pre">Config.lazy_versioning</span></code></a></li>
<li><a :data-current="activeSection === '#ell.Config.override_wrapped_logging_width'" class="reference internal" href="#ell.Config.override_wrapped_logging_width"><code class="docutils literal notranslate"><span class="pre">Config.override_wrapped_logging_width</span></code></a></li>
Expand Down
6 changes: 4 additions & 2 deletions genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -415,11 +415,13 @@ <h2 id="A">A</h2>
<td style="width: 33%; vertical-align: top;"><ul style="margin-left:0;list-style-type:none">
<li><a href="core_concepts/message_api.html#ell.assistant">assistant() (in module ell)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul style="margin-left:0;list-style-type:none">
<li><a href="core_concepts/message_api.html#ell.Message.audios">audios (ell.Message property)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul style="margin-left:0;list-style-type:none">
<li><a href="core_concepts/configuration.html#ell.Config.autocommit">autocommit (ell.Config attribute)</a>
</li>
<li><a href="core_concepts/configuration.html#ell.Config.autocommit_model">autocommit_model (ell.Config attribute)</a>
</li>
</ul></td>
</tr>
Expand Down
Binary file modified objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit 6c4535c

Please sign in to comment.