update docs in liwc.rst and build again

docs/build/html/index.html

@@ -230,10 +230,7 @@ <h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Link
 <li class="toctree-l2"><a class="reference internal" href="features_conceptual/index.html#conversation-level-features">Conversation-Level Features</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="feature_builder.html">feature_builder module</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="feature_builder.html#feature_builder.FeatureBuilder"><code class="docutils literal notranslate"><span class="pre">FeatureBuilder</span></code></a></li>
-</ul>
-</li>
+<li class="toctree-l1"><a class="reference internal" href="feature_builder.html">feature_builder module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="utils/index.html">Utilities</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="utils/index.html#driver-classes-utterance-conversation-and-speaker-level-features">“Driver” Classes: Utterance-, Conversation-, and Speaker-Level Features</a></li>
 <li class="toctree-l2"><a class="reference internal" href="utils/index.html#other-utilities">Other Utilities</a></li>

docs/build/html/py-modindex.html

@@ -90,11 +90,6 @@ <h1>Python Module Index</h1>
      <tr class="pcap"><td></td><td>&#160;</td><td></td></tr>
      <tr class="cap" id="cap-f"><td></td><td>
        <strong>f</strong></td><td></td></tr>
-     <tr>
-       <td></td>
-       <td>
-       <a href="feature_builder.html#module-feature_builder"><code class="xref">feature_builder</code></a></td><td>
-       <em></em></td></tr>
      <tr>
        <td><img src="_static/minus.png" class="toggler"
               id="toggle-1" style="display: none" alt="-" /></td>
@@ -245,16 +240,6 @@ <h1>Python Module Index</h1>
        <td>&#160;&#160;&#160;
        <a href="utils/calculate_chat_level_features.html#module-utils.calculate_chat_level_features"><code class="xref">utils.calculate_chat_level_features</code></a></td><td>
        <em></em></td></tr>
-     <tr class="cg-2">
-       <td></td>
-       <td>&#160;&#160;&#160;
-       <a href="utils/calculate_conversation_level_features.html#module-utils.calculate_conversation_level_features"><code class="xref">utils.calculate_conversation_level_features</code></a></td><td>
-       <em></em></td></tr>
-     <tr class="cg-2">
-       <td></td>
-       <td>&#160;&#160;&#160;
-       <a href="utils/calculate_user_level_features.html#module-utils.calculate_user_level_features"><code class="xref">utils.calculate_user_level_features</code></a></td><td>
-       <em></em></td></tr>
      <tr class="cg-2">
        <td></td>
        <td>&#160;&#160;&#160;

docs/build/html/utils/calculate_user_level_features.html

@@ -56,10 +56,7 @@
 <li class="toctree-l2 current"><a class="reference internal" href="index.html#driver-classes-utterance-conversation-and-speaker-level-features">“Driver” Classes: Utterance-, Conversation-, and Speaker-Level Features</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="calculate_chat_level_features.html">calculate_chat_level_features module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="calculate_conversation_level_features.html">calculate_conversation_level_features module</a></li>
-<li class="toctree-l3 current"><a class="current reference internal" href="#">calculate_user_level_features module</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="#utils.calculate_user_level_features.UserLevelFeaturesCalculator"><code class="docutils literal notranslate"><span class="pre">UserLevelFeaturesCalculator</span></code></a></li>
-</ul>
-</li>
+<li class="toctree-l3 current"><a class="current reference internal" href="#">calculate_user_level_features module</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="index.html#other-utilities">Other Utilities</a></li>
@@ -92,110 +89,8 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <section id="module-utils.calculate_user_level_features">
-<span id="calculate-user-level-features-module"></span><span id="user-level-features"></span><h1>calculate_user_level_features module<a class="headerlink" href="#module-utils.calculate_user_level_features" title="Link to this heading"></a></h1>
-<dl class="py class">
-<dt class="sig sig-object py" id="utils.calculate_user_level_features.UserLevelFeaturesCalculator">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">utils.calculate_user_level_features.</span></span><span class="sig-name descname"><span class="pre">UserLevelFeaturesCalculator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chat_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vect_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">conversation_id_col</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">speaker_id_col</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_aggregation</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_methods</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_columns</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">chat_features</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#utils.calculate_user_level_features.UserLevelFeaturesCalculator" title="Link to this definition"></a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
-<p>Initialize variables and objects used by the UserLevelFeaturesCalculator class.</p>
-<p>This class uses various feature modules to define user- (speaker) level features. It reads input data and
-initializes variables required to compute the features.</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>chat_data</strong> (<em>pd.DataFrame</em>) – Pandas dataframe of chat-level features read from the input dataset</p></li>
-<li><p><strong>user_data</strong> (<em>pd.DataFrame</em>) – Pandas dataframe of user-level features derived from the chat-level dataframe</p></li>
-<li><p><strong>vect_data</strong> (<em>pd.DataFrame</em>) – Pandas dataframe of message embeddings corresponding to each instance of the chat data</p></li>
-<li><p><strong>conversation_id_col</strong> (<em>str</em>) – A string representing the column name that should be selected as the conversation ID. Defaults to “conversation_num”.</p></li>
-<li><p><strong>speaker_id_col</strong> (<em>str</em>) – A string representing the column name that should be selected as the speaker ID. Defaults to “speaker_nickname”.</p></li>
-<li><p><strong>user_aggregation</strong> (<em>bool</em>) – If true, will aggregate features at the user level</p></li>
-<li><p><strong>user_methods</strong> (<em>list</em>) – Specifies which functions users want to aggregate with (e.g., mean, stdev…) at the user level</p></li>
-<li><p><strong>user_columns</strong> (<em>list</em>) – Specifies which columns (at the chat level) users want aggregated for the user level</p></li>
-<li><p><strong>chat_features</strong> (<em>list</em>) – Tracks all the chat-level features generated by the toolkit</p></li>
-</ul>
-</dd>
-</dl>
-<dl class="py method">
-<dt class="sig sig-object py" id="utils.calculate_user_level_features.UserLevelFeaturesCalculator.calculate_user_level_features">
-<span class="sig-name descname"><span class="pre">calculate_user_level_features</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">DataFrame</span></span></span><a class="headerlink" href="#utils.calculate_user_level_features.UserLevelFeaturesCalculator.calculate_user_level_features" title="Link to this definition"></a></dt>
-<dd><p>Main driver function for creating user-level features.</p>
-<p>This function computes various user-level features by aggregating chat-level data,
-and appends them as new columns to the input user-level data.</p>
-<dl class="field-list simple">
-<dt class="field-odd">Returns<span class="colon">:</span></dt>
-<dd class="field-odd"><p>The user-level dataset with new columns for each user-level feature</p>
-</dd>
-<dt class="field-even">Return type<span class="colon">:</span></dt>
-<dd class="field-even"><p>pd.DataFrame</p>
-</dd>
-</dl>
-</dd></dl>
-
-<dl class="py method">
-<dt class="sig sig-object py" id="utils.calculate_user_level_features.UserLevelFeaturesCalculator.get_centroids">
-<span class="sig-name descname"><span class="pre">get_centroids</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#utils.calculate_user_level_features.UserLevelFeaturesCalculator.get_centroids" title="Link to this definition"></a></dt>
-<dd><p>Calculate the centroid of each user’s chats in a given conversation for future discursive metric calculations.</p>
-<p>This function computes and appends the mean embedding (centroid) of each user’s chats to the user-level data.</p>
-<dl class="field-list simple">
-<dt class="field-odd">Returns<span class="colon">:</span></dt>
-<dd class="field-odd"><p>None</p>
-</dd>
-<dt class="field-even">Return type<span class="colon">:</span></dt>
-<dd class="field-even"><p>None</p>
-</dd>
-</dl>
-</dd></dl>
-
-<dl class="py method">
-<dt class="sig sig-object py" id="utils.calculate_user_level_features.UserLevelFeaturesCalculator.get_user_level_summary_statistics_features">
-<span class="sig-name descname"><span class="pre">get_user_level_summary_statistics_features</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#utils.calculate_user_level_features.UserLevelFeaturesCalculator.get_user_level_summary_statistics_features" title="Link to this definition"></a></dt>
-<dd><p>This function is used to aggregate the summary statistics from
-chat level features to user level features.</p>
-<p>There are many possible ways to aggregate user level features, e.g.:
-- Mean of all chats by a given user;
-- Max of all chats by a given user;
-- Weighted mean (e.g., looking at different time points?)
-… and so on.</p>
-<p>This is an open question, so we are putting a TODO here.</p>
-</dd></dl>
-
-<dl class="py method">
-<dt class="sig sig-object py" id="utils.calculate_user_level_features.UserLevelFeaturesCalculator.get_user_level_summed_features">
-<span class="sig-name descname"><span class="pre">get_user_level_summed_features</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#utils.calculate_user_level_features.UserLevelFeaturesCalculator.get_user_level_summed_features" title="Link to this definition"></a></dt>
-<dd><p>Aggregate summary statistics from chat-level features that need to be summed together.</p>
-<p>Features for which summing makes sense include:
-- Word count (total number of words)
-- Character count
-- Message count</p>
-<p>This function calculates and merges the summed features into the user-level data.</p>
-<dl class="field-list simple">
-<dt class="field-odd">Returns<span class="colon">:</span></dt>
-<dd class="field-odd"><p>None</p>
-</dd>
-<dt class="field-even">Return type<span class="colon">:</span></dt>
-<dd class="field-even"><p>None</p>
-</dd>
-</dl>
-</dd></dl>
-
-<dl class="py method">
-<dt class="sig sig-object py" id="utils.calculate_user_level_features.UserLevelFeaturesCalculator.get_user_network">
-<span class="sig-name descname"><span class="pre">get_user_network</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#utils.calculate_user_level_features.UserLevelFeaturesCalculator.get_user_network" title="Link to this definition"></a></dt>
-<dd><p>Get the user list per user per conversation.</p>
-<p>This function calculates and appends the list of other users in a given conversation to the user-level data.</p>
-<dl class="field-list simple">
-<dt class="field-odd">Returns<span class="colon">:</span></dt>
-<dd class="field-odd"><p>None</p>
-</dd>
-<dt class="field-even">Return type<span class="colon">:</span></dt>
-<dd class="field-even"><p>None</p>
-</dd>
-</dl>
-</dd></dl>
-
-</dd></dl>
-
+  <section id="calculate-user-level-features-module">
+<span id="user-level-features"></span><h1>calculate_user_level_features module<a class="headerlink" href="#calculate-user-level-features-module" title="Link to this heading"></a></h1>
 </section>