G2P Mapping Configuration

defining mappings for Python-based grapheme-to-phoneme engine 'g2p'

Type object
File match config-g2p.yaml config-g2p.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/g2p-mapping-configuration/latest.json
Source https://raw.githubusercontent.com/roedoejet/g2p/main/g2p/mappings/.schema/g2p-config-schema-2.3.json

Versions

2.0 2.1 2.2 2.3

Validate with Lintel

npx @lintel/lintel check
Type: object

This is the format used by g2p for configuring mappings.

Properties

mappings Mapping[] required

Definitions

MAPPING_TYPE string
Mapping object

Class for lookup tables

processed boolean
Default: false
parent_dir string | null
Default: null
id string | null
Default: null
in_lang string
Default: "standalone"
out_lang string
Default: "standalone"
language_name string | null
Default: null
display_name string | null
Default: null
as_is boolean | null
Default: null
case_sensitive boolean
Default: true
case_equivalencies object
Default:
{}
preserve_case boolean
Default: false
escape_special boolean
Default: false
norm_form
Default: "NFD"
All of: NORM_FORM_ENUM string
out_delimiter string
Default: ""
reverse boolean
Default: false
rule_ordering
Default: "as-written"
All of: RULE_ORDERING_ENUM string
prevent_feeding boolean
Default: false
type MAPPING_TYPE | null
Default: null
alignments string[]
Default:
[]
alignments_path string | null
Default: null
authors string[] | null
Default: null
abbreviations Record<string, string[]>
Default:
{}
abbreviations_path string | null
Default: null
rules Rule[]
Default:
[]
rules_path string | null
Default: null
hf_model_identifier string | null
Default: null
hf_model_filepath string | null
Default: null
neural_model_handler NEURAL_MODEL_HANDLER | null
Default: null
neural_kwargs object | null
Default: null
NEURAL_MODEL_HANDLER string
NORM_FORM_ENUM string
RULE_ORDERING_ENUM string
Rule object
in string required
out string required
context_before string
Default: ""
context_after string
Default: ""
prevent_feeding boolean
Default: false
match_pattern string | null
Default: null
intermediate_form string | null
Default: null
comment string | null
Default: null