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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for sentence_generalized_pooling-0.4.0.tar.gz
Algorithm Hash digest
SHA256 f31fda7a182dfb18472d079d1fe6c4876243f513291988bf2fdf9c8550f8997d
MD5 4c0a4dcac090de13ff4deee1009d39da
BLAKE2b-256 3ee898ae0378450cce4f44cc556661acef9fc8fb35258f76d553f300e25feb85

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentence_generalized_pooling-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 54d8d7fb15136b37e3cef2cbb47fbde301b0f931f549385b87125f3539205e50
MD5 b3f8c3defbc7c70adedea0f4c94f4d5d
BLAKE2b-256 a1e93615303694c6b219f36f37fdd60a945afa8c75f6b34c94e5d9e589668016

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