Skip to content

Commit

Permalink
[docs] Add some missing docs for include_prompt in Pooling (#3042)
Browse files Browse the repository at this point in the history
  • Loading branch information
tomaarsen authored Nov 7, 2024
1 parent 5bccba3 commit 15d3898
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions sentence_transformers/models/Pooling.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@ class Pooling(nn.Module):
<https://arxiv.org/abs/2202.08904>`_ and `Text and Code
Embeddings by Contrastive Pre-Training
<https://arxiv.org/abs/2201.10005>`_.
include_prompt: If set to false, the prompt tokens are not
included in the pooling. This is useful for reproducing
work that does not include the prompt tokens in the pooling
like INSTRUCTOR, but otherwise not recommended.
"""

POOLING_MODES = (
Expand Down

0 comments on commit 15d3898

Please sign in to comment.