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.8.0.tar.gz (6.6 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.8.0-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for sentence_generalized_pooling-0.8.0.tar.gz
Algorithm Hash digest
SHA256 482d789110cf465337e53bd3542af613054ec5b7039a4948002fcf72c077b494
MD5 341750b1c5e0cc2dbcca25ac91a7c7b0
BLAKE2b-256 1d82a59c99e0b8fd68828168b3dff37cf3d3c68b33d53523c3589461b355aa08

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentence_generalized_pooling-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7c5f4406eb889bab911ee802f58236b9444e593851ae1972765eabd5bcc5e461
MD5 e264e80e263073575d52c2ee9185e5e0
BLAKE2b-256 e4e832ff2bab53e559a2eae60633a25f6047d11235bf935cf3f09b2291e21138

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