Permalink
Browse files

finished doc for tools except gramtools

  • Loading branch information...
nitslp-ri committed Jan 22, 2019
1 parent d3db3d4 commit ab5e2591933eabe93bf2fb3d6690aa56f09c8f61
Showing with 124 additions and 112 deletions.
  1. 0 .editconfig → .editorconfig
  2. +9 −7 .vscode/manual.code-snippets
  3. +0 −50 mkgshmm/00readme.txt
  4. +37 −0 mkgshmm/README.md
  5. +0 −55 mkss/00readme.txt
  6. +78 −0 mkss/README.md
File renamed without changes.
@@ -1,9 +1,9 @@
{
// Place your global snippets here. Each snippet is defined under a snippet name and has a scope, prefix, body and
// description. Add comma separated ids of the languages where the snippet is applicable in the scope field. If scope
// is left empty or omitted, the snippet gets applied to all languages. The prefix is what is
// used to trigger the snippet and the body will be expanded and inserted. Possible variables are:
// $1, $2 for tab stops, $0 for the final cursor position, and ${1:label}, ${2:another} for placeholders.
// Place your global snippets here. Each snippet is defined under a snippet name and has a scope, prefix, body and
// description. Add comma separated ids of the languages where the snippet is applicable in the scope field. If scope
// is left empty or omitted, the snippet gets applied to all languages. The prefix is what is
// used to trigger the snippet and the body will be expanded and inserted. Possible variables are:
// $1, $2 for tab stops, $0 for the final cursor position, and ${1:label}, ${2:another} for placeholders.
// Placeholders with the same ids are connected.
// Example:
// "Print to console": {
@@ -25,7 +25,9 @@
"",
"# ${1:Title}",
"",
"## Synopsys",
"Short description",
"",
"## Synopsis",
"",
"```shell",
"% ${1:Title} [options]",
@@ -72,4 +74,4 @@
],
"description": "README option"
}
}
}

This file was deleted.

Oops, something went wrong.
@@ -0,0 +1,37 @@
# mkgshmm

make mixture PDF definition file from monophone HMM for Gaussian mixture
selection

## Synopsis

```shell
% mkgshmm monophoneHmmdefs > outputFile
```

## Description

`mkgshmm` extracts mixture pdf from the given monophone HMM definition, to be
used for Gaussian mixture selection in Julius.

### Prerequisites

Gaussian mixture selection mode in Julius applied the monophone HMM mixture pdf
scores as fallback value of outlier triphone. Thus the monophone and triphone
should have the same base phone.

### Installing

This tools will be installed together with Julius.

## Usage

```shell
% mkgshmm monophone.hmmdefs > outputFile
% julius ... -gshmm outputFile
```

## License

This tool is licensed under the same license with Julius. See the license term
of Julius for details.

This file was deleted.

Oops, something went wrong.
@@ -0,0 +1,78 @@
# mkss

calculate average spectrum of microphone input and save to file for spectral
subtraction

## Synopsis

```shell
% mkss [options...] fileName
```

## Description

`mkss` is a tool to estimate average spectrum of microphone input. The output
file can be used for spectral subtraction on Julius.

It reads 3 seconds (the length can be changed by option) of audio data from
microphone input, calculate its average spectrum and save it to a file. The
output file can be used as (initial) noise spectrum data in Julius (option
"-ssload").

The recording will start immediately after startup. Sampling format is 16bit,
monaural. If output file already exist, it will be overridden.

### Prerequisites

You need one audio capture device on your machine. If several devices are
available, the default one will be used.

### Installing

This tool will be installed together with Julius.

## Usage

Record 3 seconds of audio data from microphone, save average spectrum to
`noise.ss`, and use it in Julius

```shell
% mkss noise.ss
% julius ... -ssload noise.ss
```

Change recording length to 5 seconds

```shell
% mkss -len 5000 noise.ss
```

When the Julius uses non-default frame size or frame shift, you should also
specify the same parameter to `mkss`:

```shell
% mkss -fsize 450 -fshift 80 noise.ss
```

## Options

### `-freq Hz`

Sampling frequency in Hz (default: 16,000)

### `-len msec`

Capture length in milliseconds (default: 3000)

### `-fsize sampleNum`

Frame size in number of samples (default: 400)

### `-fshift sampleNum`

Frame shift in number of samples (default: 160)

## License

This tool is licensed under the same license with Julius. See the license term
of Julius for details.

0 comments on commit ab5e259

Please sign in to comment.