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.3.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.3.0-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for sentence_generalized_pooling-0.3.0.tar.gz
Algorithm Hash digest
SHA256 2ef966198076db644b49828fc73d7caadd2aae344b7fc135a3d23aaf1de82129
MD5 a99ced8044ce107e64972af59c1df2f5
BLAKE2b-256 d51a472f9b1a712494bd7f8d9e91a36212e46c2b0557b33eba1f834a19943c08

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentence_generalized_pooling-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c0ff448191d97f2dc43eb9314965f55a8904bf9bbf3aff26f003f892b2d5a0ff
MD5 0ef99e144a183bbfff84fa1709e4a18a
BLAKE2b-256 6052761fea11f699a6018c4648bfde491a47b797d3b72f9da727683e9c70d114

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