.. DocEE documentation master file, created by
   sphinx-quickstart on Tue Jan  4 10:02:33 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to DocEE's documentation!
=================================

.. image:: https://github.com/Spico197/DocEE/workflows/DocEE/badge.svg?branch=main
   :target: https://github.com/Spico197/DocEE/actions/workflows/build.yml
   :alt: Building Status
.. image:: https://codecov.io/gh/Spico197/DocEE/branch/main/graph/badge.svg?token=4BQQN039YZ
   :target: https://codecov.io/gh/Spico197/DocEE
   :alt: Code Coverage Status
.. image:: https://readthedocs.org/projects/doc-ee/badge/?version=latest
   :target: https://doc-ee.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status

Hi, there 👋. Thanks for your stay in `this repo <https://github.com/Spico197/DocEE>`_.

This project aims at building a universal toolkit for extracting events
automatically from documents 📄 (long texts).

🔥 We have an online demo: http://hlt.suda.edu.cn/docee (available in 9:00-17:00 UTC+8).

Currently, this repo contains ``PTPCG``, ``Doc2EDAG`` and ``GIT`` models,
and these models are all designed for document-level event extraction without triggers.
Documents are under construction.
More models are planned to be added.

Issue, PR and document contributions are warmly welcomed to make this project nicer.


.. toctree::
   :maxdepth: 1
   :caption: Contents:

   terminology
   templates
   evaluation
   inference


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`