Permalink
Browse files

Markdown doc moved to doc/

  • Loading branch information...
nitslp-ri committed Feb 3, 2019
1 parent e40c37d commit 8150dae5f168f95ba249565c3313189723e943be
@@ -1,14 +1,14 @@
(Moved from julius.osdn.jp since 2015/09, this is official)
(Moved from julius.osdn.jp since 2015/09, this is official)
(Since 2019/1/2, master has UTF-8-purified codes. We are still keeping the snap of old encoding at 4.5 release at branch "master-4.5-legacy".)

Julius: Open-Source Large Vocabulary Continuous Speech Recognition Engine
==========================================================================
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.2530396.svg)](https://doi.org/10.5281/zenodo.2530396)

Copyright (c) 1991-2019 [Kawahara Lab., Kyoto University](http://sap.ist.i.kyoto-u.ac.jp/)
Copyright (c) 2005-2019 [Julius project team, Lee Lab., Nagoya Institute of Technology](http://www.slp.nitech.ac.jp/)
Copyright (c) 1997-2000 Information-technology Promotion Agency, Japan
Copyright (c) 2000-2005 Shikano Lab., Nara Institute of Science and Technology
Copyright (c) 1991-2019 [Kawahara Lab., Kyoto University](http://sap.ist.i.kyoto-u.ac.jp/)
Copyright (c) 2005-2019 [Julius project team, Lee Lab., Nagoya Institute of Technology](http://www.slp.nitech.ac.jp/)
Copyright (c) 1997-2000 Information-technology Promotion Agency, Japan
Copyright (c) 2000-2005 Shikano Lab., Nara Institute of Science and Technology

# About Julius

@@ -107,15 +107,21 @@ If you have any language or acoustic model that can be distributed as a freeware

Recent documents:

- Current version's Julius command reference is kept up-to-date at [README.md in Julius folder](https://github.com/julius-speech/julius/blob/master/julius/)
- Up-to-date document is now provided in markdown at [doc/](https://github.com/julius-speech/julius/blob/master/doc/).
- Updating all documents to recent version, work in progress.
- Finished Section:
[Options](https://github.com/julius-speech/julius/blob/master/doc/Options.md),
[Audio](https://github.com/julius-speech/julius/blob/master/doc/Audio.md),
[Feature](https://github.com/julius-speech/julius/blob/master/doc/Feature.md),
[Audio](https://github.com/julius-speech/julius/blob/master/doc/Audio.md)
[VAD](https://github.com/julius-speech/julius/blob/master/doc/VAD.md).
- All options are listed in [Sample.jconf](https://github.com/julius-speech/julius/blob/master/Sample.jconf) and also be output when invoked "julius --help".
- Full history and short descriptions are in [Release Notes](https://github.com/julius-speech/julius/blob/master/Release.txt) ([JP version](https://github.com/julius-speech/julius/blob/master/Release-ja.txt))
- For DNN-HMM, take a look at [00readme-DNN.txt](https://github.com/julius-speech/julius/blob/master/00readme-HNN.txt) for how-to and [Sample.dnnconf](https://github.com/julius-speech/julius/blob/master/Sample.dnnconf) as example.

Other, very old documents:
Other, old documents:

- [The Juliusbook 3 (English) - fully translated from Japanese for 3.x](http://julius.sourceforge.jp/book/Julius-3.2-book-e.pdf)
- [The Juliusbook 4 (English) - commands and options for 4.x](http://sourceforge.jp/projects/julius/downloads/47534/Juliusbook-4.1.5.pdf)
- [The Juliusbook 3 (English) - translated from Japanese for 3.x](http://julius.sourceforge.jp/book/Julius-3.2-book-e.pdf)
- [The Juliusbook 4 (Japanese) - full documentation in Japanese](http://julius.osdn.jp/juliusbook/ja/)
- [The grammar format of Julius](http://julius.sourceforge.jp/en_index.php?q=en_grammar.html)

File renamed without changes.
File renamed without changes.
@@ -102,7 +102,7 @@ $$
$$
-->

![MAP-CMN algorithm](doc-image/map-cmn.png)
![MAP-CMN algorithm](image/map-cmn.png)

The weight $w$ can be changed by option
[-cmnmapweight](https://github.com/julius-speech/julius/blob/master/julius/Options.md#-cmnmapweight-float).
File renamed without changes.
@@ -1,5 +1,5 @@

# Specifications
# JuliusDoc

(Updating WIP)

@@ -21,7 +21,7 @@ the static GMM detector and decoder-based detector runs after those, only
processing the audio samples that have been passed by the former two detectors.
The block diagram of detection modules are as follows:

![Block diagram of VAD modules](doc-image/vad-module.png)
![Block diagram of VAD modules](image/vad-module.png)

All VAD detector is disabled by default for buffered processing. For stream
processing, the level and zero cross threshold detector is enabled by default.
@@ -47,7 +47,7 @@ options. The
and
[-tailmargin](https://github.com/julius-speech/julius/blob/master/julius/Options.md#-tailmargin-msec)
options specifies the margin before / after the detected segment, as illustrated
below: ![VAD by level threshold](doc-image/vad_lvzc.png)
below: ![VAD by level threshold](image/vad_lvzc.png)

This detector is enabled by default for stream processing (live audio and
network input), and disabled for buffered processing (file input). Set
File renamed without changes.
File renamed without changes.
@@ -29,7 +29,7 @@ When using context dependent phones (triphones), inter-word contexts are taken
into consideration. For tied-mixture and phonetic tied-mixture models,
high-speed acoustic likelihood calculation is possible using gaussian pruning.

For more details, see the related documents.
For more details, see the documents in [doc/](https://github.com/julius-speech/julius/blob/master/doc/).

### Prerequisites

@@ -47,7 +47,6 @@ detailed instruction.

A brief summary of models to be used with Julius is described here. Standard
models for some languages are also provided as "dictation kit" on Julius site.
See the [Spec.md](Spec.md) for detailed specifications.

### Acoustic model

@@ -112,7 +111,7 @@ Start recognition with a config file:

## Options

See [Options.md](Options.md).
See [Options.md](../doc/Options.md).

## Environment Variables

0 comments on commit 8150dae

Please sign in to comment.