deploy: 20a5fe6

_sources/tutorial_3_agents.rst

@@ -303,7 +303,7 @@ If you make ``persona=='random'`` then we will randomly sample a row from ANES a
    task = "Write a paragraph about the importance of the environment to America."
    agent = Agent(persona='random', model='gpt-4o', task=task)
 
-ANES Option 3: Searching ANES using a pandas query string
+ANES Option 3: Searching ANES using a Pandas query string
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 If you want to get more specific, you can pass in a query string that will be used to filter the ANES dataset. Now, you may not know the exact variables in ANES, so we have a helper function that will print out the demographic/political columns we are using so you know what values to pass in.
@@ -367,7 +367,7 @@ on more than just ideology and state.
    the south. You live in a small town. You live in the state of west virginia.
 
 
-Using Different LLM Models
+Using different LLMs
 ---------------------------------------------------
 
 Plurals supports various LLMs by using LiteLLM to make API calls. Agents also support LiteLLM's ``kwargs`` arguments

_sources/tutorial_4_structures.rst

@@ -18,7 +18,7 @@ Every Structure can be moderated, which means that a Moderator Agent will overse
 Structures will return ``responses`` as a list or you can access the final response by calling the ``final_response`` attribute.
 
 
-Combination Instructions
+Combination instructions
 ------------------------
 
 

_sources/tutorial_5_moderators.rst

@@ -12,7 +12,7 @@ Moderators are a subclass of Agents who summarize multi-agent deliberation. Any
 
 - **Model:** Moderators are initialized to be a particular LLM.
 
-Setting a Moderator’s System Instructions
+Setting a Moderator’s system instructions
 -----------------------------------------
 
 Via personas
@@ -60,7 +60,7 @@ templates, so you cannot access any pre-defined moderator instructions
 when using ``system_instructions``. ``system_instructions='default'``
 will not access the default template like ``persona='default'`` would.
 
-Auto-Moderators
+Auto-moderators
 ~~~~~~~~~~~~~~~
 
 We have a special option where, if the ``system_instructions`` of a

index.html

@@ -362,13 +362,13 @@ <h2>Contents<a class="headerlink" href="#contents" title="Link to this heading">
 <li class="toctree-l2"><a class="reference internal" href="tutorial_3_agents.html#example-combining-anes-and-templates">Example combining ANES and templates</a></li>
 <li class="toctree-l2"><a class="reference internal" href="tutorial_3_agents.html#process-tasks">Process tasks</a></li>
 <li class="toctree-l2"><a class="reference internal" href="tutorial_3_agents.html#different-ways-to-set-up-system-instructions">Different ways to set up system instructions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="tutorial_3_agents.html#using-different-llm-models">Using Different LLM Models</a></li>
+<li class="toctree-l2"><a class="reference internal" href="tutorial_3_agents.html#using-different-llms">Using different LLMs</a></li>
 <li class="toctree-l2"><a class="reference internal" href="tutorial_3_agents.html#inspecting-the-exact-prompts-that-an-agent-is-doing">Inspecting the exact prompts that an Agent is doing</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="tutorial_4_structures.html">Structures</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="tutorial_4_structures.html#overview">Overview</a></li>
-<li class="toctree-l2"><a class="reference internal" href="tutorial_4_structures.html#combination-instructions">Combination Instructions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="tutorial_4_structures.html#combination-instructions">Combination instructions</a></li>
 <li class="toctree-l2"><a class="reference internal" href="tutorial_4_structures.html#ensemble">Ensemble</a></li>
 <li class="toctree-l2"><a class="reference internal" href="tutorial_4_structures.html#chain">Chain</a></li>
 <li class="toctree-l2"><a class="reference internal" href="tutorial_4_structures.html#debate">Debate</a></li>
@@ -377,7 +377,7 @@ <h2>Contents<a class="headerlink" href="#contents" title="Link to this heading">
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="tutorial_5_moderators.html">Moderators</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="tutorial_5_moderators.html#setting-a-moderators-system-instructions">Setting a Moderator’s System Instructions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="tutorial_5_moderators.html#setting-a-moderators-system-instructions">Setting a Moderator’s system instructions</a></li>
 <li class="toctree-l2"><a class="reference internal" href="tutorial_5_moderators.html#setting-a-moderators-combination-instructions">Setting a Moderator’s combination instructions</a></li>
 </ul>
 </li>

tutorial_3_agents.html

@@ -324,10 +324,10 @@ <h2> Contents </h2>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#using-anes-for-nationally-representative-personas">Using ANES for nationally representative personas</a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#anes-option-1-ideology-initializer">ANES Option 1: <code class="docutils literal notranslate"><span class="pre">ideology</span></code> initializer</a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#anes-option-2-random-sampling">ANES Option 2: Random sampling</a></li>
-<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#anes-option-3-searching-anes-using-a-pandas-query-string">ANES Option 3: Searching ANES using a pandas query string</a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#anes-option-3-searching-anes-using-a-pandas-query-string">ANES Option 3: Searching ANES using a Pandas query string</a></li>
 </ul>
 </li>
-<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#using-different-llm-models">Using Different LLM Models</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#using-different-llms">Using different LLMs</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#inspecting-the-exact-prompts-that-an-agent-is-doing">Inspecting the exact prompts that an Agent is doing</a></li>
 </ul>
             </nav>
@@ -598,7 +598,7 @@ <h3>ANES Option 2: Random sampling<a class="headerlink" href="#anes-option-2-ran
 </div>
 </section>
 <section id="anes-option-3-searching-anes-using-a-pandas-query-string">
-<h3>ANES Option 3: Searching ANES using a pandas query string<a class="headerlink" href="#anes-option-3-searching-anes-using-a-pandas-query-string" title="Link to this heading">#</a></h3>
+<h3>ANES Option 3: Searching ANES using a Pandas query string<a class="headerlink" href="#anes-option-3-searching-anes-using-a-pandas-query-string" title="Link to this heading">#</a></h3>
 <p>If you want to get more specific, you can pass in a query string that will be used to filter the ANES dataset. Now, you may not know the exact variables in ANES, so we have a helper function that will print out the demographic/political columns we are using so you know what values to pass in.</p>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">plurals.helpers</span> <span class="kn">import</span> <span class="n">print_anes_mapping</span>
 
@@ -649,8 +649,8 @@ <h3>ANES Option 3: Searching ANES using a pandas query string<a class="headerlin
 </div>
 </section>
 </section>
-<section id="using-different-llm-models">
-<h2>Using Different LLM Models<a class="headerlink" href="#using-different-llm-models" title="Link to this heading">#</a></h2>
+<section id="using-different-llms">
+<h2>Using different LLMs<a class="headerlink" href="#using-different-llms" title="Link to this heading">#</a></h2>
 <p>Plurals supports various LLMs by using LiteLLM to make API calls. Agents also support LiteLLM’s <code class="docutils literal notranslate"><span class="pre">kwargs</span></code> arguments
 so you can (e.g) pass in a temperature or max tokens. Here are some examples of using different models:</p>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">plurals.agent</span> <span class="kn">import</span> <span class="n">Agent</span>
@@ -741,10 +741,10 @@ <h2>Inspecting the exact prompts that an Agent is doing<a class="headerlink" hre
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#using-anes-for-nationally-representative-personas">Using ANES for nationally representative personas</a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#anes-option-1-ideology-initializer">ANES Option 1: <code class="docutils literal notranslate"><span class="pre">ideology</span></code> initializer</a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#anes-option-2-random-sampling">ANES Option 2: Random sampling</a></li>
-<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#anes-option-3-searching-anes-using-a-pandas-query-string">ANES Option 3: Searching ANES using a pandas query string</a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#anes-option-3-searching-anes-using-a-pandas-query-string">ANES Option 3: Searching ANES using a Pandas query string</a></li>
 </ul>
 </li>
-<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#using-different-llm-models">Using Different LLM Models</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#using-different-llms">Using different LLMs</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#inspecting-the-exact-prompts-that-an-agent-is-doing">Inspecting the exact prompts that an Agent is doing</a></li>
 </ul>
   </nav></div>

tutorial_4_structures.html

@@ -316,7 +316,7 @@ <h2> Contents </h2>
             <nav aria-label="Page">
                 <ul class="visible nav section-nav flex-column">
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#overview">Overview</a></li>
-<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#combination-instructions">Combination Instructions</a><ul class="nav section-nav flex-column">
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#combination-instructions">Combination instructions</a><ul class="nav section-nav flex-column">
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#using-a-template-for-combination-instructions">Using a template for combination instructions</a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#setting-your-own-combination-instructions">Setting your own combination instructions</a></li>
 </ul>
@@ -352,7 +352,7 @@ <h2>Overview<a class="headerlink" href="#overview" title="Link to this heading">
 Structures will return <code class="docutils literal notranslate"><span class="pre">responses</span></code> as a list or you can access the final response by calling the <code class="docutils literal notranslate"><span class="pre">final_response</span></code> attribute.</p>
 </section>
 <section id="combination-instructions">
-<h2>Combination Instructions<a class="headerlink" href="#combination-instructions" title="Link to this heading">#</a></h2>
+<h2>Combination instructions<a class="headerlink" href="#combination-instructions" title="Link to this heading">#</a></h2>
 <p><strong>Combination instructions</strong> describe how agents are instructed to combine information in the structure. It is a special kind of instruction that only kicks in when there are previous responses from an agent’s view. These instructions allow you to customize how Agents deliberate. There are two ways to set <code class="docutils literal notranslate"><span class="pre">combination_instructions</span></code>:</p>
 <section id="using-a-template-for-combination-instructions">
 <h3>Using a template for combination instructions<a class="headerlink" href="#using-a-template-for-combination-instructions" title="Link to this heading">#</a></h3>
@@ -702,7 +702,7 @@ <h2>Tracing what is going on in Structures<a class="headerlink" href="#tracing-w
   <nav class="bd-toc-nav page-toc">
     <ul class="visible nav section-nav flex-column">
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#overview">Overview</a></li>
-<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#combination-instructions">Combination Instructions</a><ul class="nav section-nav flex-column">
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#combination-instructions">Combination instructions</a><ul class="nav section-nav flex-column">
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#using-a-template-for-combination-instructions">Using a template for combination instructions</a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#setting-your-own-combination-instructions">Setting your own combination instructions</a></li>
 </ul>

tutorial_5_moderators.html

@@ -315,10 +315,10 @@ <h2> Contents </h2>
             </div>
             <nav aria-label="Page">
                 <ul class="visible nav section-nav flex-column">
-<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#setting-a-moderators-system-instructions">Setting a Moderator’s System Instructions</a><ul class="nav section-nav flex-column">
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#setting-a-moderators-system-instructions">Setting a Moderator’s system instructions</a><ul class="nav section-nav flex-column">
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#via-personas">Via personas</a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#moderator-system-instructions-set-directly">Moderator system instructions set directly</a></li>
-<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#auto-moderators">Auto-Moderators</a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#auto-moderators">Auto-moderators</a></li>
 </ul>
 </li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#setting-a-moderators-combination-instructions">Setting a Moderator’s combination instructions</a></li>
@@ -343,7 +343,7 @@ <h1>Moderators<a class="headerlink" href="#moderators" title="Link to this headi
 <li><p><strong>Model:</strong> Moderators are initialized to be a particular LLM.</p></li>
 </ul>
 <section id="setting-a-moderators-system-instructions">
-<h2>Setting a Moderator’s System Instructions<a class="headerlink" href="#setting-a-moderators-system-instructions" title="Link to this heading">#</a></h2>
+<h2>Setting a Moderator’s system instructions<a class="headerlink" href="#setting-a-moderators-system-instructions" title="Link to this heading">#</a></h2>
 <section id="via-personas">
 <h3>Via personas<a class="headerlink" href="#via-personas" title="Link to this heading">#</a></h3>
 <p>Like Agents, <code class="docutils literal notranslate"><span class="pre">personas</span></code> and <code class="docutils literal notranslate"><span class="pre">system_instructions</span></code> are different ways
@@ -383,7 +383,7 @@ <h3>Moderator system instructions set directly<a class="headerlink" href="#moder
 will not access the default template like <code class="docutils literal notranslate"><span class="pre">persona='default'</span></code> would.</p>
 </section>
 <section id="auto-moderators">
-<h3>Auto-Moderators<a class="headerlink" href="#auto-moderators" title="Link to this heading">#</a></h3>
+<h3>Auto-moderators<a class="headerlink" href="#auto-moderators" title="Link to this heading">#</a></h3>
 <p>We have a special option where, if the <code class="docutils literal notranslate"><span class="pre">system_instructions</span></code> of a
 moderator are set to <code class="docutils literal notranslate"><span class="pre">auto</span></code>, then the moderator will, given a task,
 come up with its own system instructions. Here is how to do this!</p>
@@ -509,10 +509,10 @@ <h2>Setting a Moderator’s combination instructions<a class="headerlink" href="
   </div>
   <nav class="bd-toc-nav page-toc">
     <ul class="visible nav section-nav flex-column">
-<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#setting-a-moderators-system-instructions">Setting a Moderator’s System Instructions</a><ul class="nav section-nav flex-column">
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#setting-a-moderators-system-instructions">Setting a Moderator’s system instructions</a><ul class="nav section-nav flex-column">
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#via-personas">Via personas</a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#moderator-system-instructions-set-directly">Moderator system instructions set directly</a></li>
-<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#auto-moderators">Auto-Moderators</a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#auto-moderators">Auto-moderators</a></li>
 </ul>
 </li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#setting-a-moderators-combination-instructions">Setting a Moderator’s combination instructions</a></li>