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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for sentence_generalized_pooling-0.6.0.tar.gz
Algorithm Hash digest
SHA256 faa8661daa938147d39609fe740bd2b0d7c3d687a746603463a2955e05cf2217
MD5 9f1fc86c94e355137990597229dbd69a
BLAKE2b-256 1f1e99a72515b5ec2695880d2db36092a8a0cfe1178580128400f13283ee585a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentence_generalized_pooling-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0cbd9ec7710236d15f473074ab6ff28535594710c1707075ce167ea544337513
MD5 d2217ff08ac68c2b47a557f2e0013563
BLAKE2b-256 378334811786ba44caaa7d17b5fecfb89c898913ddd1eb5216a7b0e1967e43b2

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