Skip to content

Commit ab5e259

Browse files
committed
finished doc for tools except gramtools
1 parent d3db3d4 commit ab5e259

File tree

6 files changed

+124
-112
lines changed

6 files changed

+124
-112
lines changed
File renamed without changes.

.vscode/manual.code-snippets

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
2-
// Place your global snippets here. Each snippet is defined under a snippet name and has a scope, prefix, body and
3-
// description. Add comma separated ids of the languages where the snippet is applicable in the scope field. If scope
4-
// is left empty or omitted, the snippet gets applied to all languages. The prefix is what is
5-
// used to trigger the snippet and the body will be expanded and inserted. Possible variables are:
6-
// $1, $2 for tab stops, $0 for the final cursor position, and ${1:label}, ${2:another} for placeholders.
2+
// Place your global snippets here. Each snippet is defined under a snippet name and has a scope, prefix, body and
3+
// description. Add comma separated ids of the languages where the snippet is applicable in the scope field. If scope
4+
// is left empty or omitted, the snippet gets applied to all languages. The prefix is what is
5+
// used to trigger the snippet and the body will be expanded and inserted. Possible variables are:
6+
// $1, $2 for tab stops, $0 for the final cursor position, and ${1:label}, ${2:another} for placeholders.
77
// Placeholders with the same ids are connected.
88
// Example:
99
// "Print to console": {
@@ -25,7 +25,9 @@
2525
"",
2626
"# ${1:Title}",
2727
"",
28-
"## Synopsys",
28+
"Short description",
29+
"",
30+
"## Synopsis",
2931
"",
3032
"```shell",
3133
"% ${1:Title} [options]",
@@ -72,4 +74,4 @@
7274
],
7375
"description": "README option"
7476
}
75-
}
77+
}

mkgshmm/00readme.txt

Lines changed: 0 additions & 50 deletions
This file was deleted.

mkgshmm/README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# mkgshmm
2+
3+
make mixture PDF definition file from monophone HMM for Gaussian mixture
4+
selection
5+
6+
## Synopsis
7+
8+
```shell
9+
% mkgshmm monophoneHmmdefs > outputFile
10+
```
11+
12+
## Description
13+
14+
`mkgshmm` extracts mixture pdf from the given monophone HMM definition, to be
15+
used for Gaussian mixture selection in Julius.
16+
17+
### Prerequisites
18+
19+
Gaussian mixture selection mode in Julius applied the monophone HMM mixture pdf
20+
scores as fallback value of outlier triphone. Thus the monophone and triphone
21+
should have the same base phone.
22+
23+
### Installing
24+
25+
This tools will be installed together with Julius.
26+
27+
## Usage
28+
29+
```shell
30+
% mkgshmm monophone.hmmdefs > outputFile
31+
% julius ... -gshmm outputFile
32+
```
33+
34+
## License
35+
36+
This tool is licensed under the same license with Julius. See the license term
37+
of Julius for details.

mkss/00readme.txt

Lines changed: 0 additions & 55 deletions
This file was deleted.

mkss/README.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# mkss
2+
3+
calculate average spectrum of microphone input and save to file for spectral
4+
subtraction
5+
6+
## Synopsis
7+
8+
```shell
9+
% mkss [options...] fileName
10+
```
11+
12+
## Description
13+
14+
`mkss` is a tool to estimate average spectrum of microphone input. The output
15+
file can be used for spectral subtraction on Julius.
16+
17+
It reads 3 seconds (the length can be changed by option) of audio data from
18+
microphone input, calculate its average spectrum and save it to a file. The
19+
output file can be used as (initial) noise spectrum data in Julius (option
20+
"-ssload").
21+
22+
The recording will start immediately after startup. Sampling format is 16bit,
23+
monaural. If output file already exist, it will be overridden.
24+
25+
### Prerequisites
26+
27+
You need one audio capture device on your machine. If several devices are
28+
available, the default one will be used.
29+
30+
### Installing
31+
32+
This tool will be installed together with Julius.
33+
34+
## Usage
35+
36+
Record 3 seconds of audio data from microphone, save average spectrum to
37+
`noise.ss`, and use it in Julius
38+
39+
```shell
40+
% mkss noise.ss
41+
% julius ... -ssload noise.ss
42+
```
43+
44+
Change recording length to 5 seconds
45+
46+
```shell
47+
% mkss -len 5000 noise.ss
48+
```
49+
50+
When the Julius uses non-default frame size or frame shift, you should also
51+
specify the same parameter to `mkss`:
52+
53+
```shell
54+
% mkss -fsize 450 -fshift 80 noise.ss
55+
```
56+
57+
## Options
58+
59+
### `-freq Hz`
60+
61+
Sampling frequency in Hz (default: 16,000)
62+
63+
### `-len msec`
64+
65+
Capture length in milliseconds (default: 3000)
66+
67+
### `-fsize sampleNum`
68+
69+
Frame size in number of samples (default: 400)
70+
71+
### `-fshift sampleNum`
72+
73+
Frame shift in number of samples (default: 160)
74+
75+
## License
76+
77+
This tool is licensed under the same license with Julius. See the license term
78+
of Julius for details.

0 commit comments

Comments
 (0)