Skip to main content

A library implementing generalized pooling for sentence transformers

Project description

Sentence Generalized Pooling

This library implements generalized pooling methods for sentence embeddings, based on the research paper "Enhancing Sentence Embedding with Generalized Pooling" by Qian Chen, Zhen-Hua Ling, and Xiaodan Zhu (COLING 2018).

Installation

pip install sentence-generalized-pooling

Usage

from sentence_transformers import SentenceTransformer
from sentence_generalized_pooling import GeneralizedSentenceTransformerMaker

# Load a base model
base_model = SentenceTransformer('all-MiniLM-L6-v2')

# Create a model with generalized pooling
maker = GeneralizedSentenceTransformerMaker(
    model_name=base_model,
    pooling_type=0,  # ADDITIVE pooling
    initalize=0,     # MEAN initialization
    device='cpu'
)

# Get the modified model
model = maker.get_model()

# Use the model
embeddings = model.encode(['Your sentence here'])

Features

  • Supports both additive and dot-product pooling mechanisms
  • Multiple initialization strategies: mean, noised, and random
  • Multi-head attention mechanism
  • Compatible with all sentence-transformer models

Citation

If you use this library in your research, please cite:

@inproceedings{chen-etal-2018-enhancing,
    title = "Enhancing Sentence Embedding with Generalized Pooling",
    author = "Chen, Qian  and
      Ling, Zhen-Hua  and
      Zhu, Xiaodan",
    booktitle = "Proceedings of the 27th International Conference on Computational Linguistics",
    year = "2018",
    url = "https://aclanthology.org/C18-1154",
    pages = "1815--1826",
}

License

This project is licensed under the MIT License - see the LICENSE file for details.

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

sentence_generalized_pooling-0.5.0.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

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

sentence_generalized_pooling-0.5.0-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

Details for the file sentence_generalized_pooling-0.5.0.tar.gz.

File metadata

File hashes

Hashes for sentence_generalized_pooling-0.5.0.tar.gz
Algorithm Hash digest
SHA256 56858762989204d38a6dea53f8391a5fb4ac9240b280c241c3be49ce4099e8f1
MD5 f6ccfcf5b132cbcf03a3e315f9811262
BLAKE2b-256 dbdf59f647737ba70d189b52c886ab98d9d21f42c4f5a17dafecbe5dd0e72045

See more details on using hashes here.

File details

Details for the file sentence_generalized_pooling-0.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for sentence_generalized_pooling-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 486dfd89761b993d969fcb16703193904e9a08a9fa3999004d2e3762b52ef63c
MD5 98c7713eabad5b9e9c778624796320f2
BLAKE2b-256 32d70858ec1485a6bd566cc6dda8420a4c893fd311264b7765bfe8e917dde2dd

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