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.2.8.tar.gz (5.8 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.2.8-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for sentence_generalized_pooling-0.2.8.tar.gz
Algorithm Hash digest
SHA256 ee2e448f840806b488b1e14930ea375db3858e3d0fd2350f0996f59e4d2bc048
MD5 f14c600025736f0a3c6aa493097e800b
BLAKE2b-256 cea296ea35c18df2155d1d934d8e0478834da36f29a5f28320f8d26d4aea31fa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentence_generalized_pooling-0.2.8-py3-none-any.whl
Algorithm Hash digest
SHA256 fac920bd6d1b1c26da78b9757d611137fef12c1db22085d58be60b607970bf05
MD5 64ce02b4dfca6548fb7625e644642657
BLAKE2b-256 4b4f88ea13a4013e4669e7d4d4294ba21563f7a9cfb507f65f7c453508002246

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