.. convokit documentation master file, created by
   sphinx-quickstart on Sun Nov 20 01:52:04 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Cornell Conversational Analysis Toolkit (ConvoKit) Documentation
================================================================

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 <https://github.com/CornellNLP/ConvoKit#datasets>`_ are included together with scripts exemplifying the use of the toolkit on these datasets.

More information can be found at our `website <https://convokit.cornell.edu>`_. The latest version is `3.1.0 <https://github.com/CornellNLP/ConvoKit/releases/tag/v3.1.0>`_ (released December 30, 2024).

Contents
--------

.. toctree::
   :maxdepth: 1
   :caption: Getting Started

   Installing ConvoKit <install.rst>
   Introductory tutorial <tutorial.rst>
   Core Concepts <architecture.rst>
   Data Format <data_format.rst>
   Configurations <config.rst>
   Troubleshooting <troubleshooting.rst>

.. toctree::
   :maxdepth: 2
   :caption: API Reference

   The Corpus model <model.rst>
   Transformers <transformers.rst>
   Utilities <utilities.rst>

.. toctree::
   :maxdepth: 2
   :caption: Datasets and Examples

   Datasets <datasets.rst>
   Examples <examples.rst>
