mirror of
https://github.com/wassname/pysle.git
synced 2026-06-27 16:10:05 +08:00
Tim Mahrt
156 lines
4.2 KiB
ReStructuredText
156 lines
4.2 KiB
ReStructuredText
|
|
---------
|
|
pysle
|
|
---------
|
|
|
|
.. image:: https://img.shields.io/badge/license-MIT-blue.svg?
|
|
:target: http://opensource.org/licenses/MIT
|
|
|
|
Pronounced like 'p' + 'isle'.
|
|
|
|
An interface for the ILSEX (international speech lexicon) dictionary,
|
|
along with some tools for working with comparing and aligning
|
|
pronunciations (e.g. a list of phones someone said versus a standard or
|
|
canonical dictionary pronunciation).
|
|
|
|
|
|
.. sectnum::
|
|
.. contents::
|
|
|
|
|
|
Common Use Cases
|
|
================
|
|
|
|
What can you do with this library?
|
|
|
|
- look up the list of phones and syllables for canonical pronunciations
|
|
of a word::
|
|
|
|
pysle.isletool.LexicalTool.lookup('cat')
|
|
|
|
- map an actual pronunciation to a dictionary pronunciation (can be used
|
|
to automatically find speech errors)::
|
|
|
|
pysle.pronunciationtools.findClosestPronunciation(isleDict, 'cat', ['kh', 'ae',])
|
|
|
|
- automatically syllabify a praat textgrid containing words and phones
|
|
(e.g. force-aligned text) -- requires my
|
|
`praatIO <https://github.com/timmahrt/praatIO>`_ library::
|
|
|
|
pysle.syllabifyTextgrid(isleDict, praatioTextgrid, "words", "phones")
|
|
|
|
- search for words based on pronunciation::
|
|
|
|
e.g. Words that start with a sound, or have a sound word medially, or
|
|
in stressed vowel position, etc.
|
|
|
|
see /tests/dictionary_search.py
|
|
|
|
Major revisions
|
|
================
|
|
|
|
Ver 1.4 (July 9, 2016)
|
|
|
|
- added search functionality
|
|
|
|
Ver 1.3 (March 15, 2016)
|
|
|
|
- added indicies for stressed vowels
|
|
|
|
Ver 1.2 (June 20, 2015)
|
|
|
|
- Python 3.x support
|
|
|
|
Ver 1.1 (January 30, 2015)
|
|
|
|
- word lookup ~65 times faster
|
|
|
|
Ver 1.0 (October 23, 2014)
|
|
|
|
- first public release.
|
|
|
|
|
|
Requirements
|
|
================
|
|
|
|
- Before you use this library (before or after installing it) you will need
|
|
to download the ILSEX dictionary. It can be downloaded here:
|
|
|
|
`ISLEX project page <http://www.isle.illinois.edu/sst/data/dict/>`_
|
|
|
|
`Direct link to the ISLEX file used in this project
|
|
<http://www.isle.illinois.edu/sst/data/dict/islex/islev2.txt>`_ (islev2.txt)
|
|
|
|
- ``Python 2.7.*`` or above
|
|
|
|
- ``Python 3.3.*`` or above
|
|
|
|
- The `praatIO <https://github.com/timmahrt/praatIO>`_ library is required IF
|
|
you want to use the textgrid functionality. It is not required
|
|
for normal use.
|
|
|
|
|
|
Installation
|
|
================
|
|
|
|
If you on Windows, you can use the installer found here (check that it is up to date though)
|
|
`Windows installer <http://www.timmahrt.com/python_installers>`_
|
|
|
|
Otherwise, to manually install, after downloading the source from github, from a command-line shell, navigate to the directory containing setup.py and type::
|
|
|
|
python setup.py install
|
|
|
|
If python is not in your path, you'll need to enter the full path e.g.::
|
|
|
|
C:\Python27\python.exe setup.py install
|
|
|
|
|
|
Example usage
|
|
================
|
|
|
|
Here is a typical common usage::
|
|
|
|
from pysle import isle
|
|
isleDict = isle.LexicalTool('C:\islev2.dict')
|
|
print isleDict.lookup('catatonic')[0] # Get the first pronunciation
|
|
>> [['kh', '@,'], ['t_(', '&'], ['th', "A'"], ['n', 'I', 'kh']] [2]
|
|
|
|
and another::
|
|
|
|
from pysle import isle
|
|
from psyle import pronunciationTools
|
|
|
|
searchWord = 'another'
|
|
anotherPhoneList = ['n', '@', 'th', 'r'] # Actually produced
|
|
|
|
returnList = pronunciationTools.findBestSyllabification(isleDict,
|
|
searchWord,
|
|
anotherPhoneList)
|
|
print syllableList
|
|
>> [["''"], ['n', '@'], ['th', 'r']]
|
|
|
|
|
|
Please see \\examples for example usage
|
|
|
|
|
|
Citing pysle
|
|
===============
|
|
|
|
Pysle is general purpose coding and doesn't need to be cited
|
|
(you should cite the
|
|
`ISLEX project <http://www.isle.illinois.edu/sst/data/dict/islex/index.shtml>`_
|
|
instead) but if you would like to, it can be cited like so:
|
|
|
|
Tim Mahrt. Pysle. https://github.com/timmahrt/pysle, 2016.
|
|
|
|
|
|
Acknowledgements
|
|
================
|
|
|
|
Development of Pysle was possible thanks to NSF grant **IIS 07-03624**
|
|
to Jennifer Cole and Mark Hasegawa-Johnson, NSF grant **BCS 12-51343**
|
|
to Jennifer Cole, José Hualde, and Caroline Smith, and
|
|
to the A*MIDEX project (n° **ANR-11-IDEX-0001-02**) to James Sneed German
|
|
funded by the Investissements d'Avenir French Government program, managed
|
|
by the French National Research Agency (ANR).
|