Skip to content

Commit e09ed9c

Browse files
authored
Fixed website download names and added About in nav (#343)
Co-authored-by: ex36 <96800594+Torchee@users.noreply.github.com>
1 parent eedbb5f commit e09ed9c

3 files changed

Lines changed: 98 additions & 8 deletions

File tree

website/docs/source/about.rst

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
ConvoKit: Conversational Analysis Toolkit
2+
=========================================
3+
4+
.. image:: https://img.shields.io/pypi/v/convokit.svg
5+
:target: https://pypi.org/pypi/convokit/
6+
:alt: PyPI version
7+
8+
.. image:: https://img.shields.io/badge/python-3.10%2B-blue
9+
:target: https://pypi.org/pypi/convokit/
10+
:alt: Python versions
11+
12+
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
13+
:target: https://github.com/psf/black
14+
:alt: Code style: black
15+
16+
.. image:: https://img.shields.io/badge/license-MIT-green
17+
:target: https://github.com/CornellNLP/ConvoKit/blob/master/LICENSE.md
18+
:alt: License
19+
20+
This toolkit contains tools to extract conversational features and analyze social phenomena in conversations, using a `single unified interface <https://convokit.cornell.edu/documentation/architecture.html>`_ inspired by (and compatible with) scikit-learn. Several large conversational datasets are included together with scripts exemplifying the use of the toolkit on these datasets. The latest version is `4.1.0 <https://github.com/CornellNLP/ConvoKit/releases/tag/v4.1.0>`_ (released Mar. 10, 2026); follow the project on GitHub to keep track of updates.
21+
22+
Quick Links
23+
-----------
24+
25+
* :doc:`installation` - Get started with ConvoKit
26+
* :doc:`datasets` - Browse available conversational datasets
27+
* :doc:`features` - Explore analysis features and APIs
28+
* `Documentation <https://convokit.cornell.edu/documentation/>`_
29+
* `GitHub Repository <https://github.com/CornellNLP/ConvoKit>`_
30+
* `Discord Community <https://discord.gg/WMFqMWgz6P>`_
31+
32+
Documentation
33+
-------------
34+
35+
Documentation is hosted `here <https://convokit.cornell.edu/documentation/>`_.
36+
37+
If you are new to ConvoKit, great places to get started are:
38+
39+
* The `Core Concepts tutorial <https://convokit.cornell.edu/documentation/architecture.html>`_ for an overview of ConvoKit's object model
40+
* The `High-level tutorial <https://convokit.cornell.edu/documentation/tutorial.html>`_ for a walkthrough of importing ConvoKit, loading a Corpus, and using its functions
41+
42+
For an overview, watch our SIGDIAL talk introducing the toolkit:
43+
44+
.. raw:: html
45+
46+
<div style="margin: 2rem 0;">
47+
<iframe width="560" height="315"
48+
src="https://www.youtube.com/embed/nofzyxM4h1k"
49+
title="SIGDIAL 2020: Introducing ConvoKit"
50+
frameborder="0"
51+
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
52+
allowfullscreen
53+
style="max-width: 100%;">
54+
</iframe>
55+
</div>
56+
57+
58+
Community & Support
59+
-------------------
60+
61+
Join our `Discord community <https://discord.gg/WMFqMWgz6P>`_ to:
62+
63+
* Get help with installation and usage
64+
* Stay updated on the latest releases
65+
* Discuss progress, features, and issues
66+
* Share your work and connect with others
67+
68+
Citation
69+
--------
70+
71+
If you use ConvoKit code or datasets, please acknowledge the respective components in addition to:
72+
73+
Jonathan P. Chang, Caleb Chiam, Liye Fu, Andrew Wang, Justine Zhang, Cristian Danescu-Niculescu-Mizil. 2020.
74+
"ConvoKit: A Toolkit for the Analysis of Conversations". *Proceedings of SIGDIAL*.
75+
76+
Funding
77+
-------
78+
79+
*ConvoKit is funded in part by the U.S. National Science Foundation under Grant No. IIS-1750615 (CAREER). Any opinions, findings, and conclusions in this work are those of the author(s) and do not necessarily reflect the views of Cornell University or the National Science Foundation.*

website/docs/source/datasets.rst

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ Three related corpora of conversations that derail into antisocial behavior.
2828

2929
* **Download name:** ``conversations-gone-awry-corpus``
3030
* **Tags:** Wikipedia, derailment, online, asynchronous, outcome labels, summaries, persuasion, online, medium size, debate, medium conversations, timestamps
31+
3132
**CGA-CMV:** ChangeMyView discussion threads that derail into rule-violating behavior.
3233

3334
* **Download name:** ``conversations-gone-awry-cmv-corpus``
@@ -334,7 +335,7 @@ A collection of 1,155 five-minute telephone conversations between two participan
334335
</div>
335336

336337
Stanford Politeness Corpus
337-
------------------------
338+
--------------------------
338339

339340
.. raw:: html
340341

@@ -466,7 +467,7 @@ Fora Corpus
466467

467468
<div class="dataset-card" data-tags="small size, speaker info, utterance labels, timestamps, group, in person, various topics">
468469

469-
Fora corpus is a dataset of 262 annotated transcripts of multi-person facilitated dialogues regarding issues like education, elections, and public health, primarily through the sharing of personal experience. The corpus is available by request from the authors (https://github.com/schropes/fora-corpus) and ConvoKit contains code for converting the transcripts into ConvoKit format, as detailed below.
470+
Fora corpus is a dataset of 262 annotated transcripts of multi-person facilitated dialogues regarding issues like education, elections, and public health, primarily through the sharing of personal experience. The corpus is available by request from the authors (https://github.com/schropes/fora-corpus) and ConvoKit contains code for converting the transcripts into ConvoKit format, as detailed in the documentation.
470471

471472
* **Tags:** small size, speaker info, utterance labels, timestamps, group, in person, various topics
472473
* `Documentation <https://convokit.cornell.edu/documentation/fora.html>`_
@@ -476,12 +477,13 @@ Fora corpus is a dataset of 262 annotated transcripts of multi-person facilitate
476477
</div>
477478

478479
Unintended Offense Corpus
479-
-------------
480+
-------------------------
480481

481482
.. raw:: html
482483

483484
<div class="dataset-card" data-tags="online, asynchronous, outcome, labels, utterance labels, timestamps, Twitter/X, medium size, short conversations, various topics, politeness">
484-
A collection of unintentionally offensive Tweets and replies in which a Tweet in the exchange was offensive to someone, followed by an indication that the poster meant no offense.
485+
486+
A collection of unintentionally offensive Tweets and replies in which a Tweet in the exchange was offensive to someone, followed by an indication that the poster meant no offense. ConvoKit contains code for converting the data into ConvoKit format, as detailed in the documentation.
485487

486488
* **Tags:** online, asynchronous, outcome, labels, utterance labels, timestamps, Twitter/X, medium size, short conversations, various topics, politeness
487489
* `Documentation <https://convokit.cornell.edu/documentation/unintended_offense.html>`_
@@ -491,14 +493,15 @@ A collection of unintentionally offensive Tweets and replies in which a Tweet in
491493
</div>
492494

493495
Ubuntu Chat Logs
494-
-------------
496+
----------------
495497

496498
.. raw:: html
497499

498500
<div class="dataset-card" data-tags="online, dyadic, asymmetric, synchronous, outcome, labels, utterance labels, speaker info, timestamps, small size, medium conversations, customer support, problem solving, derailment">
499501

500502
A collection of conversations featuring pairs of speakers where one speaker is assisting the other through Ubuntu chat logs to help them solve their problem.
501503

504+
* **Download name:** ``ubuntu-chat-logs``
502505
* **Tags:** online, dyadic, asymmetric, synchronous, outcome, labels, utterance labels, speaker info, timestamps, small size, medium conversations, customer support, problem solving, derailment
503506
* `Documentation <https://convokit.cornell.edu/documentation/chatlogs.html>`_
504507

@@ -507,14 +510,15 @@ A collection of conversations featuring pairs of speakers where one speaker is a
507510
</div>
508511

509512
Contextual Abuse Corpus
510-
-------------
513+
-----------------------
511514

512515
.. raw:: html
513516

514517
<div class="dataset-card" data-tags="online, asynchronous, utterance, labels, timestamps, Reddit, medium size, short conversations, various topics">
515518

516519
A dataset of annotated Reddit entries labeled into one or more of six primary categories of abuse. Secondary categories, labels annotated in the context of the conversation thread, and rationales are also included as part of the dataset.
517520

521+
* **Download name:** ``contextual-abuse``
518522
* **Tags:** online, asynchronous, utterance, labels, timestamps, Reddit, medium size, short conversations, various topics
519523
* `Documentation <https://convokit.cornell.edu/documentation/cad.html>`_
520524

@@ -523,14 +527,15 @@ A dataset of annotated Reddit entries labeled into one or more of six primary ca
523527
</div>
524528

525529
NewsInterview Corpus
526-
-------------
530+
--------------------
527531

528532
.. raw:: html
529533

530534
<div class="dataset-card" data-tags="dyadic, asymmetric, synchronous, speaker info, summaries, timestamps, media, medium size, medium conversations, various topics, interviews, Q&A">
531535

532536
A collection of two-person informational interviews from National Public Radio (NPR) and Cable News Network (CNN), focusing on journalistic interviews between interviewers and sources from 2000 to 2020.
533537

538+
* **Download name:** ``news-interview``
534539
* **Tags:** dyadic, asymmetric, synchronous, speaker info, summaries, timestamps, media, medium size, medium conversations, various topics, interviews, Q&A
535540
* `Documentation <https://convokit.cornell.edu/documentation/interview.html>`_
536541

@@ -539,14 +544,15 @@ A collection of two-person informational interviews from National Public Radio (
539544
</div>
540545

541546
Emotional Support Conversation Corpus
542-
-------------
547+
-------------------------------------
543548

544549
.. raw:: html
545550

546551
<div class="dataset-card" data-tags="online, dyadic, asymmetric, synchronous, outcome, labels, utterance labels, speaker info, medium size, medium conversations, various topics, support">
547552

548553
This dataset contains approximately 1,300 conversations collected between emotional support seekers and supporters.
549554

555+
* **Download name:** ``emotional-support``
550556
* **Tags:** online, dyadic, asymmetric, synchronous, outcome, labels, utterance labels, speaker info, medium size, medium conversations, various topics, support
551557
* `Documentation <https://convokit.cornell.edu/documentation/support.html>`_
552558

website/docs/source/index.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ ConvoKit: Conversational Analysis Toolkit
99
:target: https://pypi.org/pypi/convokit/
1010
:alt: Python versions
1111

12+
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
13+
:target: https://github.com/psf/black
14+
:alt: Code style: black
15+
1216
.. image:: https://img.shields.io/badge/license-MIT-green
1317
:target: https://github.com/CornellNLP/ConvoKit/blob/master/LICENSE.md
1418
:alt: License
@@ -56,6 +60,7 @@ For an overview, watch our SIGDIAL talk introducing the toolkit:
5660
:caption: Contents:
5761
:hidden:
5862

63+
About <about>
5964
installation
6065
datasets
6166
features

0 commit comments

Comments
 (0)