Skip to main content

Tools to help uncover `whatlies` in word embeddings.

Project description

Downloads

whatlies

A library that tries help you to understand (note the pun).

"What lies in word embeddings?"

This small library offers tools to make visualisation easier of both word embeddings as well as operations on them.

Feedback is welcome.

Produced

This project was initiated at Rasa as a by-product of our efforts in the developer advocacy and research teams. It's an open source project and community contributions are very welcome!

Features

This library has tools to help you understand what lies in word embeddings. This includes:

  • simple tools to create (interactive) visualisations
  • an api for vector arithmetic that you can visualise
  • support for many dimensionality reduction techniques like pca, umap and tsne
  • support for many language backends including spaCy, fasttext, tfhub, huggingface and bpemb
  • lightweight scikit-learn featurizer support for all these backends

Getting Started

For a quick overview, check out our introductory video on youtube. More in depth getting started guides can be found on the documentation page.

Examples

The idea is that you can load embeddings from a language backend and use mathematical operations on it.

from whatlies import EmbeddingSet
from whatlies.language import SpacyLanguage

lang = SpacyLanguage("en_core_web_md")
words = ["cat", "dog", "fish", "kitten", "man", "woman",
         "king", "queen", "doctor", "nurse"]

emb = EmbeddingSet(*[lang[w] for w in words])
emb.plot_interactive(x_axis=emb["man"], y_axis=emb["woman"])

You can even do fancy operations. Like projecting onto and away from vector embeddings! You can perform these on embeddings as well as sets of embeddings. In the example below we attempt to filter away gender bias using linear algebra operations.

orig_chart = emb.plot_interactive('man', 'woman')

new_ts = emb | (emb['king'] - emb['queen'])
new_chart = new_ts.plot_interactive('man', 'woman')

There's also things like pca and umap.

from whatlies.transformers import Pca, Umap

orig_chart = emb.plot_interactive('man', 'woman')
pca_plot = emb.transform(Pca(2)).plot_interactive('pca_0', 'pca_1')
umap_plot = emb.transform(Umap(2)).plot_interactive('umap_0', 'umap_1')

pca_plot | umap_plot

We even allow for BERT-style embeddings. Just use the square brackets.

lang = SpacyLanguage("en_trf_robertabase_lg")
lang['programming in [python]']

You'll now get the embedding for the token "python" but in context of "programming in python".

Documentation

To learn more and for a getting started guide, check out the documentation.

Installation

To install the package as well as all the dependencies, simply run;

pip install whatlies

Similar Projects

There are some projects out there who are working on similar tools and we figured it fair to mention and compare them here.

Julia Bazińska & Piotr Migdal Web App

The original inspiration for this project came from this web app and this pydata talk. It is a web app that takes a while to slow but it is really fun to play with. The goal of this project is to make it easier to make similar charts from jupyter using different language backends.

Tensorflow Projector

From google there's the tensorflow projector project. It offers highly interactive 3d visualisations as well as some transformations via tensorboard.

  • The tensorflow projector will create projections in tensorboard, which you can also load into jupyter notebook but whatlies makes visualisations directly.
  • The tensorflow projector supports interactive 3d visuals, which whatlies currently doesn't.
  • Whatlies offers lego bricks that you can chain together to get a visualisation started. This also means that you're more flexible when it comes to transforming data before visualising it.
Parallax

From Uber AI Labs there's parallax which is described in a paper here. There's a common mindset in the two tools; the goal is to use arbitrary user defined projections to understand embedding spaces better. That said, some differences that are worth to mention.

  • It relies on bokeh as a visualisation backend and offers a lot of visualisation types (like radar plots). Whatlies uses altair and tries to stick to simple scatter charts. Altair can export interactive html/svg but it will not scale as well if you've drawing many points at the same time.
  • Parallax is meant to be run as a stand-alone app from the command line while Whatlies is meant to be run from the jupyter notebook.
  • Parallax gives a full user interface while Whatlies offers lego bricks that you can chain together to get a visualisation started.
  • Whatlies relies on language backends to fetch word embeddings. Parallax allows you to instead fetch raw files on disk.
  • Parallax has been around for a while, Whatlies is more new and therefore more experimental.

Local Development

If you want to develop locally you can start by running this command.

make develop

Documentation

This is generated via

make docs

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

whatlies-0.5.1.tar.gz (34.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

whatlies-0.5.1-py2.py3-none-any.whl (51.6 kB view details)

Uploaded Python 2Python 3

File details

Details for the file whatlies-0.5.1.tar.gz.

File metadata

  • Download URL: whatlies-0.5.1.tar.gz
  • Upload date:
  • Size: 34.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.7

File hashes

Hashes for whatlies-0.5.1.tar.gz
Algorithm Hash digest
SHA256 a431455c6ec9e653008c83597a3bd624443de7257cdf5c7bd286e3ea4c935088
MD5 04e7eeb20b06f967d847e2216a9a431d
BLAKE2b-256 eba8bcc398f994364e14f50c3a85dca951c5a851bb0fc0eaf3b196ae69630974

See more details on using hashes here.

File details

Details for the file whatlies-0.5.1-py2.py3-none-any.whl.

File metadata

  • Download URL: whatlies-0.5.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 51.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.7

File hashes

Hashes for whatlies-0.5.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1340e4cdf322782ca5801c68ee10229a838b56c69e75e29c9e3caab55eec09d8
MD5 210bf15e52114e776b0f7f252c5a77ae
BLAKE2b-256 0f119bb95c784f1a6c8654c04fd9f3451528bc1351481c47fbb2dd0e12a3f519

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page