Skip to content

Commit

Permalink
DOC: fix formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
mmcauliffe committed May 29, 2021
1 parent c882f67 commit 206c731
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 10 deletions.
7 changes: 4 additions & 3 deletions docs/source/configuration_align.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,17 @@ or longer stretches of audio).

.. csv-table::
:header: "Parameter", "Default value", "Notes"
:escape: '

"beam", 10, "Initial beam width to use for alignment"
"retry_beam", 40, "Beam width to use if initial alignment fails"
"transition_scale", 1.0, "Multiplier to scale transition costs"
"acoustic_scale", 0.1, "Multiplier to scale acoustic costs"
"self_loop_scale", 0.1, "Multiplier to scale self loop costs"
"boost_silence", 1.0, "1.0 is the value that does not affect probabilities"
"punctuation", '、。।,@<>"(),.:;¿?¡!\\&%#*~【】,…‥「」『』〝〟″⟨⟩♪・‹›«»~′$+=', "Characters to treat as punctuation and strip from around words"
"clitic_markers", "'’", "Characters to treat as clitic markers, will be collapsed to the first character in the string"
"compound_markers", "-", "Characters to treat as marker in compound words (i.e., doesn't need to be preserved like for clitics)"
"punctuation", "、。।,@<>'"'(),.:;¿?¡!\\&%#*~【】,…‥「」『』〝〟″⟨⟩♪・‹›«»~′$+=", "Characters to treat as punctuation and strip from around words"
"clitic_markers", "'''’", "Characters to treat as clitic markers, will be collapsed to the first character in the string"
"compound_markers", "\-", "Characters to treat as marker in compound words (i.e., doesn't need to be preserved like for clitics)"


.. _feature_config:
Expand Down
11 changes: 6 additions & 5 deletions docs/source/configuration_g2p.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,11 @@ Global options

.. csv-table::
:header: "Parameter", "Default value", "Notes"
:escape: '

"punctuation", '、。।,@<>"(),.:;¿?¡!\\&%#*~【】,…‥「」『』〝〟″⟨⟩♪・‹›«»~′$+=', "Characters to treat as punctuation and strip from around words"
"clitic_markers", "'’", "Characters to treat as clitic markers, will be collapsed to the first character in the string"
"compound_markers", "-", "Characters to treat as marker in compound words (i.e., doesn't need to be preserved like for clitics)"
"punctuation", "、。।,@<>'"'(),.:;¿?¡!\\&%#*~【】,…‥「」『』〝〟″⟨⟩♪・‹›«»~′$+=", "Characters to treat as punctuation and strip from around words"
"clitic_markers", "'''’", "Characters to treat as clitic markers, will be collapsed to the first character in the string"
"compound_markers", "\-", "Characters to treat as marker in compound words (i.e., doesn't need to be preserved like for clitics)"
"num_pronunciations", 1, "Number of pronunciations to generate"
"use_mp", True, "Flag for whether to use multiprocessing"

Expand Down Expand Up @@ -48,7 +49,7 @@ Default G2P training config file

.. code-block:: yaml
punctuation: '、。।,@<>"(),.:;¿?¡!\\&%#*~【】,…‥「」『』〝〟″⟨⟩♪・‹›«»~′$+='
punctuation: "、。।,@<>\"(),.:;¿?¡!\\&%#*~【】,…‥「」『』〝〟″⟨⟩♪・‹›«»~′$+="
clitic_markers: "'’"
compound_markers: "-"
num_pronunciations: 1 # Used if running in validation mode
Expand All @@ -73,7 +74,7 @@ G2P generation configuration file

.. code-block:: yaml
punctuation: '、。।,@<>"(),.:;¿?¡!\\&%#*~【】,…‥「」『』〝〟″⟨⟩♪・‹›«»~′$+='
punctuation: "、。।,@<>\"(),.:;¿?¡!\\&%#*~【】,…‥「」『』〝〟″⟨⟩♪・‹›«»~′$+="
clitic_markers: "'’"
compound_markers: "-"
num_pronunciations: 1
Expand Down
2 changes: 1 addition & 1 deletion tests/data/configs/g2p_config.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
punctuation: '、。।,@<>"(),.:;¿?¡!\\&%#*~【】,…‥「」『』〝〟″⟨⟩♪・‹›«»~′$+='
punctuation: "、。।,@<>\"(),.:;¿?¡!\\&%#*~【】,…‥「」『』〝〟″⟨⟩♪・‹›«»~′$+="
clitic_markers: "'’"
compound_markers: "-"
num_pronunciations: 1
Expand Down
2 changes: 1 addition & 1 deletion tests/data/configs/train_g2p_config.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
punctuation: '、。।,@<>"(),.:;¿?¡!\\&%#*~【】,…‥「」『』〝〟″⟨⟩♪・‹›«»~′$+='
punctuation: "、。।,@<>\"(),.:;¿?¡!\\&%#*~【】,…‥「」『』〝〟″⟨⟩♪・‹›«»~′$+="
clitic_markers: "'’"
compound_markers: "-"
num_pronunciations: 1 # Used if running in validation mode
Expand Down

0 comments on commit 206c731

Please sign in to comment.