Zeugma
📝 Natural language processing (NLP) utils: word embeddings (Word2Vec, GloVe, FastText, …) and preprocessing transformers, compatible with scikit-learn Pipelines. 🛠 Check the documentation for more information.
Installation
Install package with pip install zeugma.
Examples
Embedding transformers can be either be used with downloaded embeddings (they all come with a default embedding URL) or trained.
Pretrained embeddings
As an illustrative example the cosine similarity of the sentences what is zeugma and a figure of speech is computed using the GloVe pretrained embeddings.:
>>> from zeugma.embeddings import EmbeddingTransformer
>>> glove = EmbeddingTransformer('glove')
>>> embeddings = glove.transform(['what is zeugma', 'a figure of speech'])
>>> from sklearn.metrics.pairwise import cosine_similarity
>>> cosine_similarity(embeddings)[0, 1]
0.8721696
Training embeddings
To train your own Word2Vec embeddings use the Gensim sklearn API.
Fine-tuning embeddings
Embeddings fine tuning (training embeddings with preloaded values) will be implemented in the future.
Other examples
Usage examples are present in the examples folder.
Additional examples using Zeugma can be found in some posts of my blog.
Contribute
Feel free to fork this repo and submit a Pull Request.
Development
The development workflow for this repo is the following:
create a virtual environment: python -m venv venv && source venv/bin/activate
install required packages: pip install -r requirements.txt
install the pre-commit hooks: pre-commit install
install the package itself in editable mode: pip install -e .
run the test suite with: pytest from the root folder
Distribution via PyPI
To upload a new version to PyPI, simply:
tag your new version on git: git tag -a x.x -m "my tag message"
update the download_url field in the setup.py file
commit, push the code and the tag (git push origin x.x), and make a PR
Make sure you have a .pypirc file structured like this in your home folder (you can use https://upload.pypi.org/legacy/ for the URL field)
once the updated code is present in master run python setup.py sdist && twine upload dist/* from the root of the package to distribute it.
Building documentation
To build the documentation locally simply run make html from the docs folder.
Bonus: what’s a zeugma?
It’s a figure of speech: “The act of using a word, particularly an adjective or verb, to apply to more than one noun when its sense is appropriate to only one.” (from Wiktionary).
For example, “He lost his wallet and his mind.” is a zeugma.
1 maintainer
Metadata
1 maintainer
Release files for zeugma 0.49
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| zeugma-0.49.tar.gz | 9.9 kB | Details |
Release files / zeugma-0.49.tar.gz
| Download URL | zeugma-0.49.tar.gz |
|---|---|
| Size | 9.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
833f98cd22275be30e17bc415d08478b2156ae610d07ead4f811196a8635a149
|
|
BLAKE2b-256 checksum How to use checksums |
01081a1f56e5ab0c860fbafa39a3fd31b3ebeadbf9cbdecdd32df7934e61cfda
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.8.10
|
