Skip to content

Commit

Permalink
Gensim Support for 4.0.0 (#69)
Browse files Browse the repository at this point in the history
* Added dockerfile for tests

* Added test files

* Updated for v2

* Fixed average tests

* Removed test embeddings

* Fixed base s2v

* Fixed base s2v arguments

* Added docs

* Updated readme

* updated readme
  • Loading branch information
Oliver Borchers authored Apr 10, 2022
1 parent 672e2c5 commit eb885d4
Show file tree
Hide file tree
Showing 35 changed files with 11,700 additions and 1,277 deletions.
4 changes: 4 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
build
dist
*.c
*.so
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,8 @@ fse*.egg-info
*.old
*.model
*_out.txt
*.html
vectors
*.vectors
*.joblib

test_emb*
21 changes: 21 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
FROM python:3.6.0

RUN pip install -U pip

RUN pip install scipy \
smart_open \
scikit-learn \
wordfreq \
huggingface-hub \
psutil

ARG gensim==4.0.0
RUN pip install -U "gensim==$gensim" pytest coverage

ADD . /home
WORKDIR /home
RUN rm -rf build dist

RUN pip install -e .

CMD [ "pytest", "-vv" ]
69 changes: 37 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ gensim.models.keyedvectors.BaseKeyedVectors class, for example *Word2Vec* or *Fa
```
from gensim.models import FastText
sentences = [["cat", "say", "meow"], ["dog", "say", "woof"]]
ft = FastText(sentences, min_count=1, size=10)
ft = FastText(sentences, min_count=1, vector_size=10)
from fse import Average, IndexedList
model = Average(ft)
Expand Down Expand Up @@ -196,38 +196,38 @@ Results
Model | Vectors | params | [STS Benchmark](http://ixa2.si.ehu.es/stswiki/index.php/STSbenchmark#Results)
:---: | :---: | :---: | :---:
`CBOW` | `paranmt-300` | | 79.82
`uSIF` | `paranmt-300` | length=11 | 79.02
`SIF-10` | `paranmt-300` | components=10 | 76.76
`SIF-10` | `paragram-300-sl999` | components=10 | 74.27
`SIF-10` | `paragram-300-ws353` | components=10 | 74.08
`SIF-10` | `fasttext-crawl-subwords-300` | components=10 | 73.54
`uSIF` | `paragram-300-sl999` | length=11 | 73.09
`SIF-10` | `fasttext-wiki-news-subwords-300` | components=10 | 72.24
`uSIF` | `paragram-300-ws353` | length=11 | 71.90
`SIF-10` | `glove-twitter-200` | components=10 | 71.67
`SIF-10` | `glove-wiki-gigaword-300` | components=10 | 71.43
`SIF-10` | `word2vec-google-news-300` | components=10 | 71.17
`SIF-10` | `glove-wiki-gigaword-200` | components=10 | 70.73
`SIF-10` | `glove-twitter-100` | components=10 | 69.70
`uSIF` | `fasttext-crawl-subwords-300` | length=11 | 69.55
`uSIF` | `fasttext-wiki-news-subwords-300` | length=11 | 69.05
`SIF-10` | `glove-wiki-gigaword-100` | components=10 | 68.43
`uSIF` | `glove-wiki-gigaword-300` | length=11 | 67.73
`uSIF` | `glove-wiki-gigaword-200` | length=11 | 67.26
`uSIF` | `word2vec-google-news-300` | length=11 | 67.15
`uSIF` | `glove-twitter-200` | length=11 | 66.73
`SIF-10` | `glove-twitter-50` | components=10 | 65.57
`uSIF` | `glove-wiki-gigaword-100` | length=11 | 65.48
`uSIF` | `paragram-25` | length=11 | 64.31
`uSIF` | `glove-twitter-100` | length=11 | 64.22
`SIF-10` | `glove-wiki-gigaword-50` | components=10 | 64.20
`uSIF` | `glove-wiki-gigaword-50` | length=11 | 62.22
`uSIF` | `paranmt-300` | length=11 | 79.00
`SIF-10` | `paranmt-300` | components=10 | 76.72
`SIF-10` | `paragram-300-sl999` | components=10 | 74.21
`SIF-10` | `paragram-300-ws353` | components=10 | 74.03
`SIF-10` | `fasttext-crawl-subwords-300` | components=10 | 73.38
`uSIF` | `paragram-300-sl999` | length=11 | 73.04
`SIF-10` | `fasttext-wiki-news-subwords-300` | components=10 | 72.29
`uSIF` | `paragram-300-ws353` | length=11 | 71.84
`SIF-10` | `glove-twitter-200` | components=10 | 71.62
`SIF-10` | `glove-wiki-gigaword-300` | components=10 | 71.35
`SIF-10` | `word2vec-google-news-300` | components=10 | 71.12
`SIF-10` | `glove-wiki-gigaword-200` | components=10 | 70.62
`SIF-10` | `glove-twitter-100` | components=10 | 69.65
`uSIF` | `fasttext-crawl-subwords-300` | length=11 | 69.40
`uSIF` | `fasttext-wiki-news-subwords-300` | length=11 | 68.63
`SIF-10` | `glove-wiki-gigaword-100` | components=10 | 68.34
`uSIF` | `glove-wiki-gigaword-300` | length=11 | 67.60
`uSIF` | `glove-wiki-gigaword-200` | length=11 | 67.11
`uSIF` | `word2vec-google-news-300` | length=11 | 66.99
`uSIF` | `glove-twitter-200` | length=11 | 66.67
`SIF-10` | `glove-twitter-50` | components=10 | 65.52
`uSIF` | `glove-wiki-gigaword-100` | length=11 | 65.33
`uSIF` | `paragram-25` | length=11 | 64.22
`uSIF` | `glove-twitter-100` | length=11 | 64.13
`SIF-10` | `glove-wiki-gigaword-50` | components=10 | 64.11
`uSIF` | `glove-wiki-gigaword-50` | length=11 | 62.06
`CBOW` | `word2vec-google-news-300` | | 61.54
`uSIF` | `glove-twitter-50` | length=11 | 60.50
`SIF-10` | `paragram-25` | components=10 | 59.22
`uSIF` | `glove-twitter-25` | length=11 | 55.17
`uSIF` | `glove-twitter-50` | length=11 | 60.41
`SIF-10` | `paragram-25` | components=10 | 59.07
`uSIF` | `glove-twitter-25` | length=11 | 55.06
`CBOW` | `paragram-300-ws353` | | 54.72
`SIF-10` | `glove-twitter-25` | components=10 | 54.42
`SIF-10` | `glove-twitter-25` | components=10 | 54.16
`CBOW` | `paragram-300-sl999` | | 51.46
`CBOW` | `fasttext-crawl-subwords-300` | | 48.49
`CBOW` | `glove-wiki-gigaword-300` | | 44.46
Expand All @@ -244,6 +244,11 @@ Model | Vectors | params | [STS Benchmark](http://ixa2.si.ehu.es/stswiki/index.
Changelog
-------------

1.0.0:
- Added support for gensim>=4. This library is no longer compatible with gensim<4. For migration, see the [README](https://github.com/RaRe-Technologies/gensim/wiki/Migrating-from-Gensim-3.x-to-4).
- `size` argument is now `vector_size`
- Added docs

0.2.0:
- Added `Vectors` and `FTVectors` class and hub support by `from_pretrained`
- Extended benchmark
Expand Down Expand Up @@ -291,7 +296,7 @@ I am looking for active contributors to keep this package alive. Please feel fre

Author: Oliver Borchers

Copyright (C) 2021 Oliver Borchers
Copyright (C) 2022 Oliver Borchers

Citation
-------------
Expand Down
161 changes: 161 additions & 0 deletions docs/fse/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>fse API documentation</title>
<meta name="description" content="" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Package <code>fse</code></h1>
</header>
<section id="section-intro">
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">import logging

from fse import models
from fse.models import SIF, Average, SentenceVectors, uSIF
from fse.vectors import FTVectors, Vectors

from .inputs import (
BaseIndexedList,
CIndexedList,
CSplitCIndexedList,
CSplitIndexedList,
IndexedLineDocument,
IndexedList,
SplitCIndexedList,
SplitIndexedList,
)


class NullHandler(logging.Handler):
def emit(self, record):
pass


logger = logging.getLogger(&#34;fse&#34;)
if len(logger.handlers) == 0: # To ensure reload() doesn&#39;t add another one
logger.addHandler(NullHandler())


__version__ = &#34;0.2.0&#34;</code></pre>
</details>
</section>
<section>
<h2 class="section-title" id="header-submodules">Sub-modules</h2>
<dl>
<dt><code class="name"><a title="fse.inputs" href="inputs.html">fse.inputs</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt><code class="name"><a title="fse.models" href="models/index.html">fse.models</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt><code class="name"><a title="fse.vectors" href="vectors.html">fse.vectors</a></code></dt>
<dd>
<div class="desc"><p>Class to obtain BaseKeyedVector from.</p></div>
</dd>
</dl>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="fse.NullHandler"><code class="flex name class">
<span>class <span class="ident">NullHandler</span></span>
<span>(</span><span>level=0)</span>
</code></dt>
<dd>
<div class="desc"><p>Handler instances dispatch logging events to specific destinations.</p>
<p>The base handler class. Acts as a placeholder which defines the Handler
interface. Handlers can optionally use Formatter instances to format
records as desired. By default, no formatter is specified; in this case,
the 'raw' message as determined by record.message is logged.</p>
<p>Initializes the instance - basically setting the formatter to None
and the filter list to empty.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class NullHandler(logging.Handler):
def emit(self, record):
pass</code></pre>
</details>
<h3>Ancestors</h3>
<ul class="hlist">
<li>logging.Handler</li>
<li>logging.Filterer</li>
</ul>
<h3>Methods</h3>
<dl>
<dt id="fse.NullHandler.emit"><code class="name flex">
<span>def <span class="ident">emit</span></span>(<span>self, record)</span>
</code></dt>
<dd>
<div class="desc"><p>Do whatever it takes to actually log the specified logging record.</p>
<p>This version is intended to be implemented by subclasses and so
raises a NotImplementedError.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def emit(self, record):
pass</code></pre>
</details>
</dd>
</dl>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3><a href="#header-submodules">Sub-modules</a></h3>
<ul>
<li><code><a title="fse.inputs" href="inputs.html">fse.inputs</a></code></li>
<li><code><a title="fse.models" href="models/index.html">fse.models</a></code></li>
<li><code><a title="fse.vectors" href="vectors.html">fse.vectors</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="fse.NullHandler" href="#fse.NullHandler">NullHandler</a></code></h4>
<ul class="">
<li><code><a title="fse.NullHandler.emit" href="#fse.NullHandler.emit">emit</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
</footer>
</body>
</html>
Loading

0 comments on commit eb885d4

Please sign in to comment.