| Name | phonemeRecognizerWrapper JSON |
| Version |
0.1.4
JSON |
| download |
| home_page | https://github.com/PetrKryze/phonemeRecognizerWrapper |
| Summary | Package containing one wrapper script over the Allosaurus phoneme recognition library, designed for passing the Allosaurus output data to MATLAB scripts for further analysis. |
| upload_time | 2023-04-07 12:52:30 |
| maintainer | |
| docs_url | None |
| author | Petr Krýže |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2023 Petr Krýže Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
phoneme
transcript
allosaurus
matlab
wrapper
recognizer
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# phonemeRecognizerWrapper
Package containing one wrapper script over the Allosaurus phoneme recognition library, designed for passing the Allosaurus output data to MATLAB scripts for further analysis.
## Installation
1. [Install Python 3](https://www.python.org/downloads/)
- To see if Python is installed, use `py --version` in command line
- `pip` is automatically included in the Python installation, but to check or update the pip version use: `py -m ensurepip --upgrade`
2. [Install this package](https://pypi.org/project/phonemeRecognizerWrapper)
- From command line (assuming user has already installed python and pip):
`pip install phonemeRecognizerWrapper`
- This should also automatically install all dependent packages.
## Usage
This script uses the [Allosaurus](https://github.com/xinjli/allosaurus) phoneme recognition package to extract phonemic content from audio files of human speech. This script acts as a wrapper over the allosaurus package for improved formatting and piping of data to MATLAB scripts for analysis (e.g. vowel formant extraction).
### Command structure
`py -m phonemeRecognizerWrapper.recognize LANGUAGE_CODE FILES EMIT_PROB`
### Required Arguments:
1. `LANGUAGE_CODE`
- Three characters long language code supported by the Allosaurus library. For the list of available languages, use command:
`py -m allosaurus.bin.list_lang`
- To display the phonetic inventory (list of phonemes) for a specific language, use:
`py -m allosaurus.bin.list_phone [--lang <language name>]`
- See [here](https://github.com/xinjli/allosaurus) for more info.
- **Example options:**
- `"ipa"` - uses the whole available phonetic inventory for recognition (less accurate)
- `"deu"` - german
- `"gsw"` - swiss german
- `"fra"` - french
- `"eng"` - english
2. `FILES`
- Absolute path to a temp .txt file containing semicolon delimited text string of absolute paths to all files meant for recognition. Surround the string with apostrophes ("") if any of the paths contains spaces.
- Temp file contents example:
`"C:\sounds\sound1.wav;C:\sounds\sound2.wav"`
### Optional Arguments:
3. `EMIT_PROB`
- Allosaurus setting that determines the phoneme emission rate of the underlying model. Higher number tells the model to produce more phonemes, smaller number vice versa.
Center is at `1.0`, and optimal range that produces comprehensive outputs is `0.8 - 1.5`. **If omitted, default value of 1.5 is used.**
### Examples
- Example usage from command line:
`py -m phonemeRecognizerWrapper.recognize eng "C:\sounds\sound.wav;C:\sounds\sound2.wav" 1.0`
- Example usage from MATLAB via the `[status, result] = system(command)` function:
`command = 'py -m phonemeRecognizerWrapper.recognize eng "C:\sounds\sound.wav;C:\sounds\sound2.wav" 1.0';`
- It is also recommended to use `set PYTHONIOENCODING=utf8` before the python command to ensure proper text formantting via the standard output pipe.
## Contacts
> For any questions, please email: *petr.kryze@gmail.com*
> Authors: Petr Krýže @PetrKryze based on code from Vojtěch Illner
> CTU Prague, FEE 2023
Raw data
{
"_id": null,
"home_page": "https://github.com/PetrKryze/phonemeRecognizerWrapper",
"name": "phonemeRecognizerWrapper",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "phoneme,transcript,allosaurus,MATLAB,wrapper,recognizer",
"author": "Petr Kr\u00fd\u017ee",
"author_email": "Petr Kr\u00fd\u017ee <petr.kryze@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/4a/4d/0545e8f597d6dcfc36ffc11f53067b7c2dda355c88dc85a0b16b7b0c5cc2/phonemeRecognizerWrapper-0.1.4.tar.gz",
"platform": null,
"description": "# phonemeRecognizerWrapper\r\nPackage containing one wrapper script over the Allosaurus phoneme recognition library, designed for passing the Allosaurus output data to MATLAB scripts for further analysis.\r\n\r\n## Installation\r\n1. [Install Python 3](https://www.python.org/downloads/)\r\n - To see if Python is installed, use `py --version` in command line\r\n - `pip` is automatically included in the Python installation, but to check or update the pip version use: `py -m ensurepip --upgrade`\r\n2. [Install this package](https://pypi.org/project/phonemeRecognizerWrapper)\r\n - From command line (assuming user has already installed python and pip): \r\n `pip install phonemeRecognizerWrapper`\r\n - This should also automatically install all dependent packages. \r\n\r\n## Usage\r\nThis script uses the [Allosaurus](https://github.com/xinjli/allosaurus) phoneme recognition package to extract phonemic content from audio files of human speech. This script acts as a wrapper over the allosaurus package for improved formatting and piping of data to MATLAB scripts for analysis (e.g. vowel formant extraction).\r\n\r\n### Command structure\r\n`py -m phonemeRecognizerWrapper.recognize LANGUAGE_CODE FILES EMIT_PROB`\r\n\r\n### Required Arguments:\r\n1. `LANGUAGE_CODE`\r\n - Three characters long language code supported by the Allosaurus library. For the list of available languages, use command: \r\n `py -m allosaurus.bin.list_lang` \r\n - To display the phonetic inventory (list of phonemes) for a specific language, use: \r\n `py -m allosaurus.bin.list_phone [--lang <language name>]` \r\n - See [here](https://github.com/xinjli/allosaurus) for more info.\r\n - **Example options:**\r\n - `\"ipa\"` - uses the whole available phonetic inventory for recognition (less accurate)\r\n - `\"deu\"` - german\r\n - `\"gsw\"` - swiss german\r\n - `\"fra\"` - french\r\n - `\"eng\"` - english\r\n2. `FILES`\r\n - Absolute path to a temp .txt file containing semicolon delimited text string of absolute paths to all files meant for recognition. Surround the string with apostrophes (\"\") if any of the paths contains spaces.\r\n - Temp file contents example: \r\n `\"C:\\sounds\\sound1.wav;C:\\sounds\\sound2.wav\"`\r\n\r\n### Optional Arguments:\r\n3. `EMIT_PROB`\r\n - Allosaurus setting that determines the phoneme emission rate of the underlying model. Higher number tells the model to produce more phonemes, smaller number vice versa. \r\n Center is at `1.0`, and optimal range that produces comprehensive outputs is `0.8 - 1.5`. **If omitted, default value of 1.5 is used.**\r\n\r\n### Examples\r\n- Example usage from command line:\r\n `py -m phonemeRecognizerWrapper.recognize eng \"C:\\sounds\\sound.wav;C:\\sounds\\sound2.wav\" 1.0`\r\n\r\n- Example usage from MATLAB via the `[status, result] = system(command)` function: \r\n `command = 'py -m phonemeRecognizerWrapper.recognize eng \"C:\\sounds\\sound.wav;C:\\sounds\\sound2.wav\" 1.0';`\r\n - It is also recommended to use `set PYTHONIOENCODING=utf8` before the python command to ensure proper text formantting via the standard output pipe.\r\n\r\n## Contacts\r\n> For any questions, please email: *petr.kryze@gmail.com* \r\n> Authors: Petr Kr\u00fd\u017ee @PetrKryze based on code from Vojt\u011bch Illner \r\n> CTU Prague, FEE 2023\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Petr Kr\u00fd\u017ee Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Package containing one wrapper script over the Allosaurus phoneme recognition library, designed for passing the Allosaurus output data to MATLAB scripts for further analysis.",
"version": "0.1.4",
"split_keywords": [
"phoneme",
"transcript",
"allosaurus",
"matlab",
"wrapper",
"recognizer"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "627254a0b9bfe64a2fc5b138ba084d0d9415cc4e25ce07aec0523f59b1d5d038",
"md5": "0f27ff6982162be937fe482c32c1ffd5",
"sha256": "53e5fb16b24ba0bd44795cb6ef15cb8ba79ef98b00d562bf84acd6f22d189ad4"
},
"downloads": -1,
"filename": "phonemeRecognizerWrapper-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0f27ff6982162be937fe482c32c1ffd5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 7567,
"upload_time": "2023-04-07T12:52:27",
"upload_time_iso_8601": "2023-04-07T12:52:27.035976Z",
"url": "https://files.pythonhosted.org/packages/62/72/54a0b9bfe64a2fc5b138ba084d0d9415cc4e25ce07aec0523f59b1d5d038/phonemeRecognizerWrapper-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4a4d0545e8f597d6dcfc36ffc11f53067b7c2dda355c88dc85a0b16b7b0c5cc2",
"md5": "44d2682a64769c49323d0181d53674c2",
"sha256": "5302d421ce41b3d29984bc37b1d2e47df5129a0109404c4f0b44600adb5a9f4b"
},
"downloads": -1,
"filename": "phonemeRecognizerWrapper-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "44d2682a64769c49323d0181d53674c2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 6212,
"upload_time": "2023-04-07T12:52:30",
"upload_time_iso_8601": "2023-04-07T12:52:30.995199Z",
"url": "https://files.pythonhosted.org/packages/4a/4d/0545e8f597d6dcfc36ffc11f53067b7c2dda355c88dc85a0b16b7b0c5cc2/phonemeRecognizerWrapper-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-07 12:52:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "PetrKryze",
"github_project": "phonemeRecognizerWrapper",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "phonemerecognizerwrapper"
}
