cade 1.2.0
Compass-aligned Distributional Embeddings
License: MIT license
Requires Python: >=3.5
Keywords: cade

=========================================
Compass-aligned Distributional Embeddings
=========================================


.. image:: https://img.shields.io/pypi/v/cade.svg
        :target: https://pypi.python.org/pypi/cade

.. image:: https://travis-ci.com/vinid/cade.svg
        :target: https://travis-ci.com/vinid/cade


This package contains Python code to generate compass aligned distributional embeddings (CADE).
Comparing word vectors in different corpora requires alignment.
We propose a method to aligned distributional representation based on word2vec.
This method is efficient and it is based on a simple heuristic: we train a general word embedding, **the compass**
and we use this embedding to freeze one of the layers of the CBOW architecture.

See the `AAAI
<https://aaai.org/ojs/index.php/AAAI/article/view/4594>`_ and  `Arxiv pre-print
<https://arxiv.org/abs/2004.06519>`_ papers for more details.

.. image:: https://raw.githubusercontent.com/vinid/cade/master/img/CADE.png
   :width: 400pt

CADE is easy to use!

.. image:: https://raw.githubusercontent.com/vinid/cade/master/img/render1587824614545.gif
   :width: 400pt

Reference
---------

This work is based on the following papers: `AAAI
<https://aaai.org/ojs/index.php/AAAI/article/view/4594>`_ and `Arxiv-preprint
<https://arxiv.org/abs/2004.06519>`_

+ Bianchi, F., Di Carlo, V., Nicoli, P., & Palmonari, M. (2020). **Compass-aligned Distributional Embeddings for Studying Semantic Differences across Corpora**. Arxiv. https://arxiv.org/abs/2004.06519
+ Di Carlo, V., Bianchi, F., & Palmonari, M. (2019). **Training Temporal Word Embeddings with a Compass**. Proceedings of the AAAI Conference on Artificial Intelligence, 33(01), 6326-6334. https://doi.org/10.1609/aaai.v33i01.33016326


Abstract
--------

Word2vec is one of the most used algorithms to generate word embeddings because of a good mix of efficiency, quality of the generated representations and cognitive grounding. However, word meaning is not static and depends on the context in which words are used. Differences in word meaning that depends on time, location, topic, and other factors, can be studied by analyzing embeddings generated from different corpora in collections that are representative of these factors. For example, language evolution can be studied using a collection of news articles published in different time periods. In this paper, we present a general framework to support cross-corpora language studies with word embeddings, where embeddings generated from different corpora can be compared to find correspondences and differences in meaning across the corpora. CADE is the core component of our framework and solves the key problem of aligning the embeddings generated from different corpora. In particular, we focus on providing solid evidence about the effectiveness, generality, and robustness of CADE. To this end, we conduct quantitative and qualitative experiments in different domains, from temporal word embeddings to language localization and topical analysis. The results of our experiments suggest that CADE achieves state-of-the-art or superior performance on tasks where several competing approaches are available, yet providing a general method that can be used in a variety of domains. Finally, our experiments shed light on the conditions under which the alignment is reliable, which substantially depends on the degree of cross-corpora vocabulary overlap.

What's this About?
------------------

Different words assume different meaning in different contexts. Think for example of how people once used the word `amazon` to mainly
refer to the forest. Or think about the differences between American and British English. This is what we usually call meaning shift.
See some examples of meaning shifts:

.. image:: https://raw.githubusercontent.com/vinid/cade/master/img/shift_meaning.png
   :width: 400pt

Why not using standard word embeddings? Well, long story short, different embeddings generated from different
corpora are not comparable: they need to be aligned!

With CADE we provide a method to align different corpora (in the same language) and to compare them.
Alignment allow us to compare different word embeddings in different corpora using cosine similarity!


Here are some example of mappings between text about Pokemons (from the Reddit board) and text about
Scientific stuff (again, Reddit) that you can learn with CADE.

For example, you can take the vector of the word Arceus, from the Pokemon corpus and find that it is very similar to the
word `god` in the Science corpus. You wonder why? Arceus is the good of Pokemons! See some examples of mapping like this in the table, where we show
the top-5 nearest neighbors of the mapped space!

.. image:: https://raw.githubusercontent.com/vinid/cade/master/img/mappings.png
   :width: 400pt

Installing
----------

We use a custom/edited implementation of gensim, this **WILL** clash with your gensim installation, consider installing this inside a virtual environment

.. code-block::  bash

    pip install -U cade

**REMEMBER TO USE A VIRTUAL ENVIRONMENT**

.. code-block::  bash

    pip install git+https://github.com/valedica/gensim.git

Guide
-----

* **Remember**: when you call the training method of :code:`CADE` the class creates a "model/" folder where it is going to save the trained objects. The compass will be trained as first element and it will be saved in that folder. If you want to overwrite it remember to set the parameter :code:`overwrite=True`, **otherwise** it will reload the already trained compass.

* **What do you need**: Different corpora you want to compare (i.e., text from 1991, text from 1992 / text from the New York Times, text from The Guardian ... etc...) and the concatenation of those text slices (the compass).

* **The compass** should be the concatenation of the slice you want to align. In the next code section you will see that we are going to use arxiv papers text from two different years. The "compass.txt" file contains the concatenation of both slices.

How To Use
----------

* Training

Suppose you have corpora you want to compare text "arxiv_14.txt" and "arxiv_9.txt". First of all, create the concatenation
of these two and create a "compass.txt" file. Now you can train the compass.

.. code-block:: bash

    cat arxiv_14.txt arxiv_9.txt > compass.txt

Once you have the compass, you can run the tool

.. code-block:: python

    from cade.cade import CADE
    from gensim.models.word2vec import Word2Vec
    aligner = CADE(size=30)

    # train the compass: the text should be the concatenation of the text from the slices
    aligner.train_compass("examples/training/compass.txt", overwrite=False) # keep an eye on the overwrite behaviour
..

You can see that the class covers the same parameters the Gensim word2vec library has. After this first training you can train the slices:

.. code-block:: python

    # now you can train slices and they will be already aligned
    # these are gensim word2vec objects
    slice_one = aligner.train_slice("examples/training/arxiv_14.txt", save=True)
    slice_two = aligner.train_slice("examples/training/arxiv_9.txt", save=True)
..

These two slices are now aligned and can be compared!

* Load Data

You can load data has you do with gensim.

.. code-block:: python

    model1 = Word2Vec.load("model/arxiv_14.model")
    model2 = Word2Vec.load("model/arxiv_9.model")
..

and you can start comparing it with standard methods

.. code-block:: python

    from scipy.spatial.distance import cosine
    print(1 - cosine(model1["like"], model2["sign"]))
..

People
------
+ `Federico Bianchi <http://twitter.com/fb_vinid>`_ - Bocconi University -  (f.bianchi@unibocconi.it)
+ Valerio Di Carlo -  BUP Solutions
+ Paolo Nicoli -  University of Milano-Bicocca
+ Federico Belotti - University of Milano-Bicocca
+ Matteo Palmonari - University of Milano-Bicocca - (matteo.palmonari@unimib.it)

Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage


=======
History
=======

1.2.0 (2029-11-07)
------------------

* Introducing comparison metrics
* Added website
* Fixing Readme guide

0.1.0 (2019-09-11)
------------------

* First release on PyPI.