Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Bert Embeddings

Build Status PyPI version Documentation Status

BERT, published by Google, is new way to obtain pre-trained language model word representation. Many NLP tasks are benefit from BERT to get the SOTA.

The goal of this project is to obtain the token embedding from BERT's pre-trained model. In this way, instead of building and do fine-tuning for an end-to-end NLP model, you can build your model by just utilizing or token embedding.

This project is implemented with @MXNet. Special thanks to @gluon-nlp team.

Install

pip install bert-embedding
pip install https://github.com/dmlc/gluon-nlp/tarball/master
# If you want to run on GPU machine, please install `mxnet-cu92`.
pip install mxnet-cu92

This project use API from gluonnlp==0.5.1, which hasn't been released yet. Once 0.5.1 is released, it is not necessary to install gluonnlp from source.

Usage

from bert_embedding import BertEmbedding

bert_abstract = """We introduce a new language representation model called BERT, which stands for Bidirectional Encoder Representations from Transformers.
 Unlike recent language representation models, BERT is designed to pre-train deep bidirectional representations by jointly conditioning on both left and right context in all layers.
 As a result, the pre-trained BERT representations can be fine-tuned with just one additional output layer to create state-of-the-art models for a wide range of tasks, such as question answering and language inference, without substantial task-specific architecture modifications. 
BERT is conceptually simple and empirically powerful. 
It obtains new state-of-the-art results on eleven natural language processing tasks, including pushing the GLUE benchmark to 80.4% (7.6% absolute improvement), MultiNLI accuracy to 86.7 (5.6% absolute improvement) and the SQuAD v1.1 question answering Test F1 to 93.2 (1.5% absolute improvement), outperforming human performance by 2.0%."""
sentences = bert_abstract.split('\n')
bert_embedding = BertEmbedding()
result = bert_embedding(sentences)

If you want to use GPU, please import mxnet and set context

import mxnet as mx
from bert_embedding import BertEmbedding

...

ctx = mx.gpu(0)
bert = BertEmbedding(ctx=ctx)

This result is a list of a tuple containing (tokens, tokens embedding)

For example:

first_sentence = result[0]

first_sentence[0]
# ['we', 'introduce', 'a', 'new', 'language', 'representation', 'model', 'called', 'bert', ',', 'which', 'stands', 'for', 'bidirectional', 'encoder', 'representations', 'from', 'transformers']
len(first_sentence[0])
# 18


len(first_sentence[1])
# 18
first_token_in_first_sentence = first_sentence[1]
first_token_in_first_sentence[1]
# array([ 0.4805648 ,  0.18369392, -0.28554988, ..., -0.01961522,
#        1.0207764 , -0.67167974], dtype=float32)
first_token_in_first_sentence[1].shape
# (768,)

OOV

There are three ways to handle oov, avg (default), sum, and last. This can be specified in encoding.

...
bert_embedding = BertEmbedding()
bert_embedding(sentences, 'sum')
...

Available pre-trained BERT models

book_corpus_wiki_en_uncased book_corpus_wiki_en_cased wiki_multilingual wiki_multilingual_cased wiki_cn
bert_12_768_12 ✓ ✓ ✓ ✓ ✓
bert_24_1024_16 x ✓ x x x

Example of using the large pre-trained BERT model from Google

from bert_embedding import BertEmbedding

bert_embedding = BertEmbedding(model='bert_24_1024_16', dataset_name='book_corpus_wiki_en_cased')

Source: gluonnlp

Metadata

Release files for bert-embedding 0.1.5.dev1552065837

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for bert-embedding 0.1.5.dev1552065837
File Size Uploaded Provenance Actions
bert_embedding-0.1.5.dev1552065837.tar.gz 7.2 kB Without provenance Details for bert_embedding-0.1.5.dev1552065837.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for bert-embedding 0.1.5.dev1552065837
File Interpreter ABI Platform Actions
bert_embedding-0.1.5.dev1552065837-py3-none-any.whl Python 3 none any Details for bert_embedding-0.1.5.dev1552065837-py3-none-any.whl

Total release size: 19.1 kB

Release files / bert_embedding-0.1.5.dev1552065837.tar.gz

Download URL bert_embedding-0.1.5.dev1552065837.tar.gz
Size 7.2 kB
Tags Source
SHA-256 checksum
How to use checksums
34d9db95ea76bb83a1d5bfadcea4c0f63206483a9e1a98090baaa718b7c05a3a
BLAKE2b-256 checksum
How to use checksums
a4aa0275485df7db21c4e00da434d38d6dea770c400b05023436b822ae12cdd4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.5.6

Release files / bert_embedding-0.1.5.dev1552065837-py3-none-any.whl

Download URL bert_embedding-0.1.5.dev1552065837-py3-none-any.whl
Size 11.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
94c6d5442c803db55095c3a2a05528c0fe845b862bffe1ab50e62c32ad4d19df
BLAKE2b-256 checksum
How to use checksums
4ae3da6370a6865fe03ae79687eccfbec4ee44ba84d6ab8559b68c2073f9bad5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.5.6

Security for bert-embedding 0.1.5.dev1552065837

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page