Skip to content

Commit

Permalink
deploy: d66f4c7
Browse files Browse the repository at this point in the history
  • Loading branch information
MadcowD committed Nov 20, 2024
1 parent 1cee7a7 commit 50e3b7f
Show file tree
Hide file tree
Showing 12 changed files with 1,530 additions and 110 deletions.
8 changes: 5 additions & 3 deletions _sources/core_concepts/configuration.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,18 @@ Configuration
ell provides various configuration options to customize its behavior.

.. autofunction:: ell.init
:no-index:

This ``init`` function is a convenience function that sets up the configuration for ell. It is a thin wrapper around the ``Config`` class, which is a Pydantic model.

You can modify the global configuration using the ``ell.config`` object which is an instance of ``Config``:

.. autopydantic_model:: ell.Config
:members:
:exclude-members: default_client, registry, store
:exclude-members: default_client, registry, store, providers
:model-show-json: false
:model-show-validator-members: false
:model-show-config-summary: false
:model-show-field-summary: false
:model-show-validator-summary: false
:model-show-field-summary: true
:model-show-validator-summary: false
:no-index:
2 changes: 1 addition & 1 deletion _sources/core_concepts/tool_usage.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ This is accomplished by a language model program that takes the source code of a
.. code-block:: python
@ell.simple(model="claude-3-5-sonnet", temperature=0.0)
@ell.simple(model="claude-3-5-sonnet-20241022", temperature=0.0)
def generate_tool_spec(tool_source: str):
'''
You are a helpful assistant that takes in source code for a python function and produces a JSON schema for the function.
Expand Down
79 changes: 73 additions & 6 deletions _sources/installation.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,87 @@ Installing ell

.. code-block:: bash
pip install -U ell-ai
pip install -U ell-ai[all]
By default, this installs only the OpenAI client SDK. If you want to include the Anthropic client SDK, use the "anthropic" extra like so:

.. code-block:: bash
pip install -U 'ell-ai[anthropic]'
This installs ``ell``, ``ell-studio``, versioning and tracing with SQLite, and the default provider clients.

2. Verify installation:

.. code-block:: bash
python -c "import ell; print(ell.__version__)"
Custom Installation
-------------------

You can create a custom ``ell`` installation with the following options.

Install ``ell`` without storage or ``ell-studio`` and with the default OpenAI client:

.. code-block:: bash
pip install -U ell-ai
Supported options:

``anthropic``
~~~~~~~~~~~~~
Adds the Anthropic client.

.. code-block:: bash
pip install -U ell-ai[anthropic]
``groq``
~~~~~~~~
Adds the Groq client.

.. code-block:: bash
pip install -U ell-ai[groq]
``studio``
~~~~~~~~~~
Adds ``ell-studio``.

.. code-block:: bash
pip install -U ell-ai[studio]
``sqlite``
~~~~~~~~~~
SQLite storage for versioning and tracing.

.. code-block:: bash
pip install -U ell-ai[sqlite]
``postgres``
~~~~~~~~~~~~
Postgres storage for versioning and tracing.

Include this option if you'd like to use ``ell-studio`` with Postgres.

.. code-block:: bash
pip install -U ell-ai[postgres]
Combining options
~~~~~~~~~~~~~~~~~

All options are additive and can be combined as needed.

Example: Install ``ell`` with ``ell-studio``, Postgres, and the Anthropic client:

.. code-block:: bash
pip install -U ell-ai[studio, postgres, anthropic]
API Key Setup
-------------

Expand Down
105 changes: 48 additions & 57 deletions core_concepts/configuration.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions core_concepts/ell_simple.html
Original file line number Diff line number Diff line change
Expand Up @@ -585,8 +585,8 @@ <h2>Reference<a class="headerlink" href="#reference" title="Link to this heading
</div>
<p>See Also:</p>
<ul class="simple">
<li><p><a class="reference internal" href="ell_complex.html#ell.complex" title="ell.complex"><code class="xref py py-func docutils literal notranslate"><span class="pre">ell.complex()</span></code></a>: For LMPs that preserve full structure of model responses, including multimodal outputs.</p></li>
<li><p><code class="xref py py-func docutils literal notranslate"><span class="pre">ell.tool()</span></code>: For defining tools that can be used within complex LMPs.</p></li>
<li><p><a class="reference internal" href="../reference/index.html#ell.complex" title="ell.complex"><code class="xref py py-func docutils literal notranslate"><span class="pre">ell.complex()</span></code></a>: For LMPs that preserve full structure of model responses, including multimodal outputs.</p></li>
<li><p><a class="reference internal" href="../reference/index.html#ell.tool" title="ell.tool"><code class="xref py py-func docutils literal notranslate"><span class="pre">ell.tool()</span></code></a>: For defining tools that can be used within complex LMPs.</p></li>
<li><p><code class="xref py py-mod docutils literal notranslate"><span class="pre">ell.studio</span></code>: For visualizing and analyzing LMP executions.</p></li>
</ul>
</dd></dl>
Expand Down
28 changes: 24 additions & 4 deletions core_concepts/message_api.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion core_concepts/tool_usage.html
Original file line number Diff line number Diff line change
Expand Up @@ -576,7 +576,7 @@ <h2>Future Features: Tool Spec Autogeneration<a class="headerlink" href="#future
</span></code></pre></div>
</div>
<p>This is accomplished by a language model program that takes the source code of a tool function as input and generates the corresponding tool specification.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><code><span id="line-1"><span class="nd">@ell</span><span class="o">.</span><span class="n">simple</span><span class="p">(</span><span class="n">model</span><span class="o">=</span><span class="s2">"claude-3-5-sonnet"</span><span class="p">,</span> <span class="n">temperature</span><span class="o">=</span><span class="mf">0.0</span><span class="p">)</span>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><code><span id="line-1"><span class="nd">@ell</span><span class="o">.</span><span class="n">simple</span><span class="p">(</span><span class="n">model</span><span class="o">=</span><span class="s2">"claude-3-5-sonnet-20241022"</span><span class="p">,</span> <span class="n">temperature</span><span class="o">=</span><span class="mf">0.0</span><span class="p">)</span>
</span><span id="line-2"><span class="k">def</span> <span class="nf">generate_tool_spec</span><span class="p">(</span><span class="n">tool_source</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
</span><span id="line-3"><span class="w"> </span><span class="sd">'''</span>
</span><span id="line-4"><span class="sd"> You are a helpful assistant that takes in source code for a python function and produces a JSON schema for the function.</span>
Expand Down
Loading

0 comments on commit 50e3b7f

Please sign in to comment.