Process-Sanskrit is python library for automatic Sanskrit text annotation and inflected dictionary search
Project description
Process-Sanskrit
Process-Sanskrit is a light-computing library for Sanskrit text analysis, annotation and inflected dictionary search.
The library has two main use cases:
- Dictionary search: multi dictionary lookup with grammatical annotation for words exactly as they are written in texts: in any transliteration format, inflected, compounded and with sandhi.
- Automatic Text Annotation: generate automatically version of Sanskrit texts without sandhi and with split compounds, with grammatical annotations and dictionary entries for each word.
The architecture of the library is based on a cascading approach to Sanskrit text analysis, as described in our NAACL 2025 paper:Accessible Sanskrit: A Cascading System for Text Analysis and Dictionary
Access.
Demo:
The library can be employed live on the (Sanskrit Voyager website)[https://www.sanskritvoyager.com/].
Select a book or paste some text, click on the words and see the library in action!
Or search some inflected and sandhi-ed words in the search bar to get the dictionary entries.
The following is the Quickstart guide. For a more detailed documentation and advanced features refer to the documentation website.
Installation
To install the library use the standard pip install command, then call update-ps-database in the terminal to setup the database.
A venv, colab, environment or docker is highly recommended to use gensim. For the experimental BYT5 version
pip install process-sanskrit[gensim]
update-ps-database
or
pip install process-sanskrit[BYT5]
update-ps-database
The command downloads and setup the database with the dictionaries and the inflection tables in the resources folder (150 mb download, 583 mb uncompressed, (Creative Commons NC license)[https://creativecommons.org/licenses/by-nc/4.0/]):
## if inside jupyter or colab use:
!pip install process-sanskrit[gensim]
!update-ps-database
only transliterate works without the database!
Process Function:
The core of the library is the process function, that accepts text in Sanskrit as input and executes an entire text processing pipeline for the text.
import process-sanskrit as ps
ps.process("pratiprasave")
Process returns a list that contains for each word contained in the text or compounds:
- Word stem: ‘pratiprasava’
- Grammatical tagging: masculine noun/adjective ending in a
- Case (for nouns) or Inflection (for verbs): [('Loc', 'Sg')]
- Inflection table for the word as a list: ['pratiprasavaḥ', 'pratiprasavau', 'pratiprasavāḥ', 'pratiprasavam', 'pratiprasavau', 'pratiprasavān', 'pratiprasavena', 'pratiprasavābhyām', 'pratiprasavaiḥ', 'pratiprasavāya', 'pratiprasavābhyām', 'pratiprasavebhyaḥ', 'pratiprasavāt', 'pratiprasavābhyām', 'pratiprasavebhyaḥ', 'pratiprasavasya', 'pratiprasavayoḥ', 'pratiprasavānām', 'pratiprasave', 'pratiprasavayoḥ', 'pratiprasaveṣu', 'pratiprasava', 'pratiprasavau', 'pratiprasavāḥ']
- Original word: 'pratiprasave’
- Word Components according to the Monnier Williams: (in this case none) 'prati—prasava’
- Dictionary entries in XML format. In the form of a dictionary for all the selected dictionaries: {'mw': {'pratiprasava': ['prati—prasava a See under prati-pra- √ 1. sū.', 'prati-°prasava b m. counter-order, suspension of a general prohibition in a particular case, Śaṃkarācārya ; Kātyāyana-śrauta-sūtra , Scholiast or Commentator; Manvarthamuktāvalī, KullūkaBhaṭṭa's commentary on Manu-smṛti ', ' an exception to an exception, Taittirīya-prātiśākhya , Scholiast or Commentator', ' return to the original state, Yoga-sūtra ']}
Dictionary Selection:
By default, only the Monnier Williams dictionary is selected.
If there are words that are outside the MW (i.E. ‘dvandva’) the dictionaries that have the word are automatically selected. In this example the word is found in the Macdonnell dictionary.
## additional dictionaries can be returned in the output by adding them as
## arguments after the main text input.
import process-sanskrit as ps
ps.process('saṃskāra', 'ap90', 'cae', 'gra', 'bhs')
Available Dictionaries:
- 'mw': 'Monier-Williams Sanskrit-English Dictionary' ,
- 'ap90': 'Apte Practical Sanskrit-English Dictionary'
- ‘cae': 'Cappeller Sanskrit-English Dictionary'
- 'ddsa': 'Macdonell A Practical Sanskrit Dictionary'
- 'gra': 'Grassmann Wörterbuch zum Rig Veda'
- 'bhs': 'Edgerton Buddhist Hybrid Sanskrit Dictionary'
- 'cped': 'Concise Pali English Dictionary'
All the dictionaries are slightly modified version of the Cologne Digital Sanskrit Dictionaries, apart from the (The Concise Pali-English Dictionary By Buddhadatta Mahathera)[https://buddhistuniversity.net/content/reference/concise-pali-dictionary] The Pali dictionary was added in to handle words that appears in the late Buddhist authors.
Cologne Digital Sanskrit Dictionaries, version 2.7.286,
Cologne University, accessed on February 19, 2025,
https://www.sanskrit-lexicon.uni-koeln.de
Stemming:
To use the process function just for sandhi/compound split and stemming, use the process function with the flag: output=’roots’.
import process-sanskrit as ps
ps.process('yamaniyamāsanaprāṇāyāmapratyāhāradhāraṇādhyānasamādhayo', output='roots')
## output:
## ['yama', 'niyama', 'asana', 'prāṇāyāma', 'pratyāhāra', 'dhāraṇa', 'dhyāna', 'samādhi']
!it is to note that in case of ambiguity the process function does not select between the two (or three) possibilities, but returns all of them as a tuple.
Transliteration API:
The library offers a function to transliterate texts with auto-detection for the transliteration input format. This function is a slight adaptation from (Indic-Transliteration Detect)[”https://github.com/indic-transliteration/detect.py”].
import process_sanskrit as ps
# Transliteration
ps.transliterate("patañjali", "DEVANAGARI") ## IAST
ps.transliterate("pataJjali", "DEVANAGARI") ## HK format
## same output:
## पतञ्जलि
## In case you need to manually select the input scheme, you can force it using
## the input_scheme flag, it's not case sensitive:
ps.transliterate('pataYjali', 'tamil', input_scheme='slp1')
## output: பதஞ்ஜலி
Dictionary Search:
The library provides the dict_search function to retrieve dictionary entries.
Pass to the dict_search a list of strings to be searched on and (optionally) a list of dictionary tags.
import process_sanskrit as ps
## unlike the process function, the dict_search wants the input in IAST format.
# example usage for Dictionary lookup
ps.dict_search(['pratiprasava', 'saṃskāra'])
# after a list of entries, optionally add dictionary tags to search in multiple dictionaries.
# search in Edgerton Buddhist Hybrid Sanskrit Dictionary
# and Grassmann Wörterbuch zum Rig Veda:
ps.dict_search(['pratiprasava', 'saṃskāra'], 'gra', 'bhs')
The library automatically handles the fact that the Apte records nominatives instead of un-inflected stems (i.E. yogaḥ instead of yoga).
Sources:
CLS inflect for the inflection tables: https://github.com/sanskrit-lexicon/csl-inflect
The Sanskrit Parser library handles part of the Sandhi Splitting: https://github.com/kmadathil/sanskrit_parser?tab=readme-ov-file
The BYT5 model used in the experimental version of the process function is from the https://huggingface.co/buddhist-nlp/byt5-sanskrit discussed in the paper:
One Model is All You Need: ByT5-Sanskrit, a Unified Model for Sanskrit NLP Tasks
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file process_sanskrit-1.0.23.tar.gz.
File metadata
- Download URL: process_sanskrit-1.0.23.tar.gz
- Upload date:
- Size: 3.2 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3f05ad4ea4d67fd522d5e1b98b8f4b27977e5f4565b0b158823a665a33d0e671
|
|
| MD5 |
23e771be3554ebbc1f918de08d2a5577
|
|
| BLAKE2b-256 |
2d1d0de2c78edcd7a85cded4c9d65b0319c5391dd884af2c8528aea93471f836
|
File details
Details for the file process_sanskrit-1.0.23-py3-none-any.whl.
File metadata
- Download URL: process_sanskrit-1.0.23-py3-none-any.whl
- Upload date:
- Size: 3.2 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4b4a043007228fac0fc4f2161cd48ce6483ea85905ce2d06e2d2e9e5844b2585
|
|
| MD5 |
97c7933344b5c2a8d1d777d9ffdd2cd3
|
|
| BLAKE2b-256 |
19156068b04b349cf346958e3edc3e42b5a1e2d8304a0dc59bc5a25ca221a6ca
|