https://github.com/dcavar/nlqk
Natural Language Qu Kit (NLQK)
https://github.com/dcavar/nlqk
artificial-intelligence natural-language-processing quantum-ai quantum-artificial-intelligence quantum-computing quantum-machine-learning quantum-nlp
Last synced: 6 months ago
JSON representation
Natural Language Qu Kit (NLQK)
- Host: GitHub
- URL: https://github.com/dcavar/nlqk
- Owner: dcavar
- License: mit
- Created: 2024-08-16T21:23:44.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-17T14:21:53.000Z (over 1 year ago)
- Last Synced: 2025-04-08T16:05:37.467Z (12 months ago)
- Topics: artificial-intelligence, natural-language-processing, quantum-ai, quantum-artificial-intelligence, quantum-computing, quantum-machine-learning, quantum-nlp
- Language: Python
- Homepage: https://nlqk.ai/
- Size: 10.7 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Natural Language Qu Kit (NLQK)
(C) 2024-2025 by [Damir Cavar], [NLP-Lab]
Natural Language Qu Kit (NLQK) is a toolkit for Quantum AI (QAI) and Natural Language Processing (Q-NLP).
This is an [Natural Language Processing Lab] ([NLP-Lab]) project.
## Contributors
- [Dr. Damir Cavar] (main author, maintainer, project lead)
- [Billy Dickson]
- [James Bryan Graves]
- [Koushik Reddy Parukola]
- [Shane A. Sparks]
## Introduction
What is the goal of this project?
The goals are to provide a library and programming environment for Natural Language Processing using a hybrid environment of classical and quantum computers. NLP tools and libraries are excellent environments for education and deployed business NLP applications:
- [Natural Language Processing Toolkit](https://www.nltk.org/)
- [spaCy](https://spacy.io/)
There are some excellent Q-NLP libraries and tools as for example:
- [lambeq](https://github.com/CQCL/lambeq)
We aim at expanding these development environments (classical and quantum) to facilitate Quantum NLP engineering.
## Links
- [NLQK.ai](http://nlqk.ai/)
- [NLQK PyPi page](https://pypi.org/project/nlqk/)
- [NLP-Lab]
- [NLP-Lab Quantum NLP](https://nlp-lab.org/quantumnlp/)
## Install
Use PyPi
pip install nlqk
## Building
Install the required modules:
pip install -r requirements.txt
## Test
Run all tests:
pytest tests
Run specific test categories:
pytest tests/embeddings # Embeddings and Vector-related tests
pytest tests/test_nlqk # Core NLQK tests
pytest tests/test_nlqk_corpus # Corpus tests
### Documentation
Run this command to regenerate the library and API documentation:
pdoc -o docs/documentation/ nlqk/
Run the shell script (e.g., using bash):
./create_doc.sh
[Damir Cavar]: http://damir.cavar.me/ "Damir Cavar"
[NLP-Lab]: https://nlp-lab.org/ "NLP Lab"
[Billy Dickson]: https://www.linkedin.com/in/billy-dickson/ "Billy Dickson"
[Koushik Reddy Parukola]: https://www.linkedin.com/in/koushik-reddy-parukola/ "Koushik Reddy Parukola"
[Dr. Damir Cavar]: https://luddy.indiana.edu/contact/profile/?Damir_Cavar "Damir Cavar"
[James Bryan Graves]: https://jamesbryangraves.com/ "James Bryan Graves"
[Shane A. Sparks]: https://www.linkedin.com/in/shane-sparks-a37832249/ "Shane A. Sparks"
[NLP-Lab]: https://nlp-lab.org/ "Natural Language Processing Lab"
[Natural Language Processing Lab]: https://nlp-lab.org/ "Natural Language Processing Lab"
[NLQK.ai]: http://nlqk.ai/ "NLQK.ai"