Home

Welcome to the Eidos wiki! Below is a roadmap to Eidos documentation with brief descriptions and links to other wiki pages, source code files, and a minimal Eidos website.

Table of Contents

• Top-level description

  Brief Description of World Modelers Readers describes Eidos and other readers from a high level.

  README is part of the source code and provides significant background information. You may have to scroll down to see the contents of the document.

• Mid-level description

  JSON-LD describes in detail the main output format that is used for import by modelers.

  Anatomy of Mentions explains the class hierarchy and fields of Mentions and how they are converted into the JSON-LD representation.

  Extraction flow gives an overview of the extraction processes.

  Grounding flow documents the two places where mentions get grounded.

  Attachment handling explains what attachments are and how they work.

  API output examples shows output from the code snippets that are part of the README.

• Low-level description

  Finders details the modular components used for extraction.

  Expanders explains how mentions are expanded to include the full meaning of a cause and effect.

  Exporters documents some of the many ways of generating output.

  Stateful mentions details the specific attachments for state.

  Grounders tells about the different grounders that are available.

  Scaladoc includes a link to the automatically generated Scala/Java documentation for the system.

• Behind the scenes

  Unit-Test-Protocol details the testing procedure for Eidos developers.

  How to run Eidos on the Arizona HPC cluster does what it says.

  Using brat annotation tool is similarly to the point.

  Season normalization describes briefly the behavior of SeasonFinder and how to update the season database.

  Generating scaladocs includes instructions on how to generate the Scala documentation.

• Other

  FAQ addresses frequently asked questions.