Crate annatto

Introduction to using annatto

Command line

The main usage of annatto is through the command line interface. Run

annatto --help

to get more help on the sub-commands. The most important command is annatto run <workflow-file>, which runs all the modules as defined in the given workflow file.

Modules

Annatto comes with a number of modules, which have different types:

Importer modules allow importing files from different formats. More than one importer can be used in a workflow, but then the corpus data needs to be merged using one of the merger manipulators. When running a workflow, the importers are executed first and in parallel.

Graph operation modules change the imported corpus data. They are executed one after another (non-parallel) and in the order they have been defined in the workflow.

Exporter modules export the data into different formats. More than one exporter can be used in a workflow. When running a workflow, the exporters are executed last and in parallel.

Modules

• error
• exporter
  Exporter modules export the data into different formats.
• importer
  Importer modules allow importing files from different formats.
• manipulator
  Graph operation modules change the imported corpus data.
• models
• progress
• runtime
• util
• workflow
  Creating a workflow file

Structs

• ExporterStep
• ImporterStep
• ManipulatorStep
• StepID
  Unique ID of a single step in the conversion pipeline.

Enums

• GraphOp
• ReadFrom
• WriteAs

Traits

• Module
  A module that can be used in the conversion pipeline.
• Step
  Represents a single step in a conversion pipeline.