JANUS 3 Documentation
Introduction
JANUS is a modular speech recognition system for research and development.
All the JANUS code, and this documentation are protected by our
copyright. Really, JANUS is a speech-to-speech
translation system, and JANUS-SR the speech recognition compontent. In this
documentation however, the term JANUS always only refers to the version 3
of the recognition component JANUS-SR.v3.
The documentation is split into a users manual, that also serves as an introduction
into JANUS, and a developers manual that has more in depth information. However,
the user manual may contain links into the developers manual where more detailed
information is required.
In this documentation the term user refers to a person who wants to:
- do recognition runs with an existing recognition setup
- run a training
- use existing scripts
- make minor modification to existing scripts (changing filenames, parameters ...)
- complain about missing documentation
In this documentation the term developer refers to a person who also has to:
- write new scripts
- make major modifications to existing scripts
- modify C code
- implement new training methods
- design new objects
- write documentation
User Manual
- Introduction to JANUS for Users
This section contains the most important things a user needs to know
about the general system before using the standard scripts.
- Basic things you can do
This section contains a list of problems and frequently performed tasks
together with links to pages where the solutions to these problems and
guiding information to the tasks are presented.
- Available Tcl scripts
This section contains brief descriptions of and pointers to the
tcl-scripts that are required to perform the standard JANUS tasks.
These scripts should be well documented and ideally be augmented
by html pointers.
Developers Manual
- Introduction to JANUS for Developers
This section contains information about the structure of JANUS,
how the modules interact and some more specific concepts used.
- Description of all Modules
Detailed description for each module,
starting with an introduction explaining what the module is good for and
it's place in JANUS and pointers to the following pages:
- a page with Tcl objects, methods etc for this module
- a page describing fileformats with short examples
- an optional page with C level source code hints
- an optional page with pointers to (html-augmented) example tcl scripts
- Index Page
The index page contains many links to other pages.
- How to write Documentation
This section explains the most important conventions that should help to
make this documentation a little more uniform, though written by many people.
Also it explains important things about using RCS to avoid several people
editing the same documentation file at one time.
What's new?
Maintainer: monika@ira.uka.de, rogina@ira.uka.de, finkem@cs.cmu.edu, maier@ira.uka.de