Update doc

convokit/talktimesharing/talktimesharing.py

@@ -73,7 +73,8 @@ class TalkTimeSharing(Transformer):
 
     It assigns each conversation a primary speaker group (more talkative), a secondary
     speaker group (less talkative), and a scalar imbalance score. It also computes a
-    list of windowed imbalance scores over a sliding windows of the conversation.
+    list of windowed imbalance scores over a sliding windows of the conversation to capture how talk-time 
+    sharing distribution unfolds over time.
 
     Each utterance is expected to have a speaker group label under `utt.meta['utt_group']`,
     which can be precomputed or inferred from `convo.meta['speaker_groups']`.
@@ -114,10 +115,11 @@ def transform(
         self, corpus: Corpus, selector: Callable[[Conversation], bool] = lambda convo: True
     ):
         """
-        Computes talk-time balance metrics for each conversation in the corpus.
+        Computes and annotate talk-time sharing information for each conversation in the corpus.
 
         Annotates the corpus with speaker group labels and if utterances `utt_group` metadata is missing, the data
         is assumed to be labeled in `convo.meta['speaker_groups']`.
+
         Each conversation is then annotated with its primary and secondary speaker groups, an overall conversation level
         imbalance score, and a list of windowed imbalance score computed via sliding window analysis.
 
@@ -141,8 +143,8 @@ def transform(
                     for utt in convo.iter_utterances():
                         utt.meta["utt_group"] = speaker_groups_dict[utt.speaker.id]
 
-        ### Annotate conversations with Balance information
-        for convo in tqdm(corpus.iter_conversations(), desc="Annotating conversation balance"):
+        ### Annotate conversations with talk-time sharing information
+        for convo in tqdm(corpus.iter_conversations(), desc="Annotating conversation talk-time sharing"):
             if selector(convo):
                 convo.meta["primary_speaker"] = _get_ps(
                     corpus,