Skip to content

Commit

Permalink
update docs & rebuild
Browse files Browse the repository at this point in the history
  • Loading branch information
xehu committed Dec 6, 2024
1 parent 65468f3 commit 01e6472
Show file tree
Hide file tree
Showing 77 changed files with 61 additions and 22 deletions.
Binary file modified docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/doctrees/examples.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/feature_builder.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/features/basic_features.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/features/burstiness.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/features/certainty.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/features/discursive_diversity.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/features/fflow.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/features/get_all_DD_features.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/features/get_user_network.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/features/hedge.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/features/index.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/features/info_exchange_zscore.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/features/information_diversity.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/features/lexical_features_v2.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/doctrees/features/other_lexical_features.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/features/politeness_features.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/features/politeness_v2.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/features/politeness_v2_helper.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/features/question_num.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/features/readability.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/features/reddit_tags.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/features/temporal_features.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/features/textblob_sentiment_analysis.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/features/turn_taking_features.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/features/variance_in_DD.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/doctrees/features/word_mimicry.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/features_conceptual/TEMPLATE.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/doctrees/features_conceptual/index.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/features_conceptual/mimicry_bert.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/features_conceptual/moving_mimicry.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/doctrees/features_conceptual/positivity_bert.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/features_conceptual/turn_taking_index.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/features_conceptual/word_ttr.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/intro.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/utils/assign_chunk_nums.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/utils/calculate_chat_level_features.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/doctrees/utils/calculate_user_level_features.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/utils/check_embeddings.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/utils/gini_coefficient.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/utils/index.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/utils/preload_word_lists.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/utils/preprocess.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/utils/summarize_features.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/utils/zscore_chats_and_conversation.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 9a01a2cd3d4384710101b4a99edd7683
config: d7678f479036f3220c73480ec4f2c467
tags: 645f666f9bcd5a90fca523b33c5a78b7
1 change: 1 addition & 0 deletions docs/build/html/_sources/features/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ Once utterance-level features are computed, we compute conversation-level featur
variance_in_DD
within_person_discursive_range
turn_taking_features
lsm

Speaker- (User) Level Features
*********************************
Expand Down
3 changes: 2 additions & 1 deletion docs/build/html/_sources/features_conceptual/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,5 @@ Conversation-Level Features
turn_taking_index
team_burstiness
discursive_diversity
information_diversity
information_diversity
lsm
7 changes: 4 additions & 3 deletions docs/build/html/_static/searchtools.js
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ const Search = {

htmlToText: (htmlString, anchor) => {
const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
for (const removalQuery of [".headerlinks", "script", "style"]) {
for (const removalQuery of [".headerlink", "script", "style"]) {
htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() });
}
if (anchor) {
Expand Down Expand Up @@ -328,13 +328,14 @@ const Search = {
for (const [title, foundTitles] of Object.entries(allTitles)) {
if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) {
for (const [file, id] of foundTitles) {
let score = Math.round(100 * queryLower.length / title.length)
const score = Math.round(Scorer.title * queryLower.length / title.length);
const boost = titles[file] === title ? 1 : 0; // add a boost for document titles
normalResults.push([
docNames[file],
titles[file] !== title ? `${titles[file]} > ${title}` : title,
id !== null ? "#" + id : "",
null,
score,
score + boost,
filenames[file],
]);
}
Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/examples.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Utilities" href="utils/index.html" />
<link rel="prev" title="Information Diversity" href="features_conceptual/information_diversity.html" />
<link rel="prev" title="LANGUAGE STYLE MATCHING" href="features_conceptual/lsm.html" />
</head>

<body class="wy-body-for-nav">
Expand Down Expand Up @@ -459,7 +459,7 @@ <h4>Feature Column Names<a class="headerlink" href="#feature-column-names" title
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="features_conceptual/information_diversity.html" class="btn btn-neutral float-left" title="Information Diversity" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="features_conceptual/lsm.html" class="btn btn-neutral float-left" title="LANGUAGE STYLE MATCHING" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="utils/index.html" class="btn btn-neutral float-right" title="Utilities" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/feature_builder.html
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@
<span id="feature-builder-module"></span><span id="feature-builder"></span><h1>feature_builder module<a class="headerlink" href="#module-feature_builder" title="Link to this heading"></a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="feature_builder.FeatureBuilder">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">feature_builder.</span></span><span class="sig-name descname"><span class="pre">FeatureBuilder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">input_df:</span> <span class="pre">~pandas.core.frame.DataFrame,</span> <span class="pre">vector_directory:</span> <span class="pre">./vector_data/,</span> <span class="pre">output_file_base='output',</span> <span class="pre">output_file_path_chat_level=None,</span> <span class="pre">output_file_path_user_level=None,</span> <span class="pre">output_file_path_conv_level=None,</span> <span class="pre">custom_features:</span> <span class="pre">list</span> <span class="pre">=</span> <span class="pre">[],</span> <span class="pre">analyze_first_pct:</span> <span class="pre">list</span> <span class="pre">=</span> <span class="pre">[1.0],</span> <span class="pre">turns:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">False,</span> <span class="pre">conversation_id_col:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'conversation_num',</span> <span class="pre">speaker_id_col:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'speaker_nickname',</span> <span class="pre">message_col:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'message',</span> <span class="pre">timestamp_col:</span> <span class="pre">str</span> <span class="pre">|</span> <span class="pre">tuple[str,</span> <span class="pre">str]</span> <span class="pre">=</span> <span class="pre">'timestamp',</span> <span class="pre">grouping_keys:</span> <span class="pre">list</span> <span class="pre">=</span> <span class="pre">[],</span> <span class="pre">cumulative_grouping=False,</span> <span class="pre">within_task=False,</span> <span class="pre">ner_training_df:</span> <span class="pre">~pandas.core.frame.DataFrame</span> <span class="pre">=</span> <span class="pre">None,</span> <span class="pre">ner_cutoff:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">0.9,</span> <span class="pre">regenerate_vectors:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">False,</span> <span class="pre">compute_vectors_from_preprocessed:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">False</span></em><span class="sig-paren">)</span><a class="headerlink" href="#feature_builder.FeatureBuilder" title="Link to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">feature_builder.</span></span><span class="sig-name descname"><span class="pre">FeatureBuilder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_df</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">vector_directory</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">'./vector_data/'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_file_base</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">'output'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_file_path_chat_level</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_file_path_user_level</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_file_path_conv_level</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_features</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</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">[]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">analyze_first_pct</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</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">[1.0]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">turns</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">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><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'conversation_num'</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><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'speaker_nickname'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message_col</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">'message'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timestamp_col</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">tuple</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">str</span><span class="p"><span class="pre">]</span></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">'timestamp'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">grouping_keys</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</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">[]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cumulative_grouping</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="n"><span class="pre">within_task</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="n"><span class="pre">ner_training_df</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</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">ner_cutoff</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</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">0.9</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">regenerate_vectors</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">compute_vectors_from_preprocessed</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><span class="sig-paren">)</span><a class="headerlink" href="#feature_builder.FeatureBuilder" 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>The FeatureBuilder is the main engine that reads in the user’s inputs and specifications and generates
conversational features. The FeatureBuilder separately calls the classes (the ChatLevelFeaturesCalculator,
Expand Down
1 change: 1 addition & 0 deletions docs/build/html/features/burstiness.html
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@
<li class="toctree-l3"><a class="reference internal" href="variance_in_DD.html">variance_in_DD module</a></li>
<li class="toctree-l3"><a class="reference internal" href="within_person_discursive_range.html">within_person_discursive_range module</a></li>
<li class="toctree-l3"><a class="reference internal" href="turn_taking_features.html">turn_taking_features module</a></li>
<li class="toctree-l3"><a class="reference internal" href="lsm.html">lsm module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="index.html#speaker-user-level-features">Speaker- (User) Level Features</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/build/html/features/discursive_diversity.html
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@
<li class="toctree-l3"><a class="reference internal" href="variance_in_DD.html">variance_in_DD module</a></li>
<li class="toctree-l3"><a class="reference internal" href="within_person_discursive_range.html">within_person_discursive_range module</a></li>
<li class="toctree-l3"><a class="reference internal" href="turn_taking_features.html">turn_taking_features module</a></li>
<li class="toctree-l3"><a class="reference internal" href="lsm.html">lsm module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="index.html#speaker-user-level-features">Speaker- (User) Level Features</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/build/html/features/get_all_DD_features.html
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@
<li class="toctree-l3"><a class="reference internal" href="variance_in_DD.html">variance_in_DD module</a></li>
<li class="toctree-l3"><a class="reference internal" href="within_person_discursive_range.html">within_person_discursive_range module</a></li>
<li class="toctree-l3"><a class="reference internal" href="turn_taking_features.html">turn_taking_features module</a></li>
<li class="toctree-l3"><a class="reference internal" href="lsm.html">lsm module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="index.html#speaker-user-level-features">Speaker- (User) Level Features</a></li>
Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/features/get_user_network.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Features: Conceptual Documentation" href="../features_conceptual/index.html" />
<link rel="prev" title="turn_taking_features module" href="turn_taking_features.html" />
<link rel="prev" title="lsm module" href="lsm.html" />
</head>

<body class="wy-body-for-nav">
Expand Down Expand Up @@ -142,7 +142,7 @@
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="turn_taking_features.html" class="btn btn-neutral float-left" title="turn_taking_features module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="lsm.html" class="btn btn-neutral float-left" title="lsm module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../features_conceptual/index.html" class="btn btn-neutral float-right" title="Features: Conceptual Documentation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

Expand Down
2 changes: 2 additions & 0 deletions docs/build/html/features/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@
<li class="toctree-l3"><a class="reference internal" href="variance_in_DD.html">variance_in_DD module</a></li>
<li class="toctree-l3"><a class="reference internal" href="within_person_discursive_range.html">within_person_discursive_range module</a></li>
<li class="toctree-l3"><a class="reference internal" href="turn_taking_features.html">turn_taking_features module</a></li>
<li class="toctree-l3"><a class="reference internal" href="lsm.html">lsm module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#speaker-user-level-features">Speaker- (User) Level Features</a><ul>
Expand Down Expand Up @@ -157,6 +158,7 @@ <h2>Conversation-Level Features<a class="headerlink" href="#conversation-level-f
<li class="toctree-l1"><a class="reference internal" href="variance_in_DD.html">variance_in_DD module</a></li>
<li class="toctree-l1"><a class="reference internal" href="within_person_discursive_range.html">within_person_discursive_range module</a></li>
<li class="toctree-l1"><a class="reference internal" href="turn_taking_features.html">turn_taking_features module</a></li>
<li class="toctree-l1"><a class="reference internal" href="lsm.html">lsm module</a></li>
</ul>
</div>
</section>
Expand Down
1 change: 1 addition & 0 deletions docs/build/html/features/information_diversity.html
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@
<li class="toctree-l3"><a class="reference internal" href="variance_in_DD.html">variance_in_DD module</a></li>
<li class="toctree-l3"><a class="reference internal" href="within_person_discursive_range.html">within_person_discursive_range module</a></li>
<li class="toctree-l3"><a class="reference internal" href="turn_taking_features.html">turn_taking_features module</a></li>
<li class="toctree-l3"><a class="reference internal" href="lsm.html">lsm module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="index.html#speaker-user-level-features">Speaker- (User) Level Features</a></li>
Expand Down
Loading

0 comments on commit 01e6472

Please sign in to comment.