tomaarsen HF staff commited on
Commit
5c8a84e
1 Parent(s): ac726a1

Remove newline issues

Browse files
Files changed (1) hide show
  1. README.md +46 -51
README.md CHANGED
@@ -1,51 +1,46 @@
1
- ---
2
- language: en
3
- license: apache-2.0
4
- library_name: sentence-transformers
5
- tags:
6
- - sentence-transformers
7
- - feature-extraction
8
- - sentence-similarity
9
- pipeline_tag: sentence-similarity
10
- ---
11
-
12
- # sentence-transformers/sentence-t5-xl
13
-
14
- This is a [sentence-transformers](https://www.SBERT.net) model: It maps sentences & paragraphs to a 768 dimensional dense vector space. The model works well for sentence similarity tasks, but doesn't perform that well for semantic search tasks.
15
-
16
- This model was converted from the Tensorflow model [st5-3b-1](https://tfhub.dev/google/sentence-t5/st5-3b/1) to PyTorch. When using this model, have a look at the publication: [Sentence-T5: Scalable sentence encoders from pre-trained text-to-text models](https://arxiv.org/abs/2108.08877). The tfhub model and this PyTorch model can produce slightly different embeddings, however, when run on the same benchmarks, they produce identical results.
17
-
18
- The model uses only the encoder from a T5-3B model. The weights are stored in FP16.
19
-
20
-
21
- ## Usage (Sentence-Transformers)
22
-
23
- Using this model becomes easy when you have [sentence-transformers](https://www.SBERT.net) installed:
24
-
25
- ```
26
- pip install -U sentence-transformers
27
- ```
28
-
29
- Then you can use the model like this:
30
-
31
- ```python
32
- from sentence_transformers import SentenceTransformer
33
- sentences = ["This is an example sentence", "Each sentence is converted"]
34
-
35
- model = SentenceTransformer('sentence-transformers/sentence-t5-xl')
36
- embeddings = model.encode(sentences)
37
- print(embeddings)
38
- ```
39
-
40
- The model requires sentence-transformers version 2.2.0 or newer.
41
-
42
- ## Evaluation Results
43
-
44
- For an automated evaluation of this model, see the *Sentence Embeddings Benchmark*: [https://seb.sbert.net](https://seb.sbert.net?model_name=sentence-transformers/sentence-t5-xl)
45
-
46
-
47
-
48
- ## Citing & Authors
49
-
50
- If you find this model helpful, please cite the respective publication:
51
- [Sentence-T5: Scalable sentence encoders from pre-trained text-to-text models](https://arxiv.org/abs/2108.08877)
1
+ ---
2
+ language: en
3
+ license: apache-2.0
4
+ library_name: sentence-transformers
5
+ tags:
6
+ - sentence-transformers
7
+ - feature-extraction
8
+ - sentence-similarity
9
+ pipeline_tag: sentence-similarity
10
+ ---
11
+
12
+ # sentence-transformers/sentence-t5-xl
13
+
14
+ This is a [sentence-transformers](https://www.SBERT.net) model: It maps sentences & paragraphs to a 768 dimensional dense vector space. The model works well for sentence similarity tasks, but doesn't perform that well for semantic search tasks.
15
+ This model was converted from the Tensorflow model [st5-3b-1](https://tfhub.dev/google/sentence-t5/st5-3b/1) to PyTorch. When using this model, have a look at the publication: [Sentence-T5: Scalable sentence encoders from pre-trained text-to-text models](https://arxiv.org/abs/2108.08877). The tfhub model and this PyTorch model can produce slightly different embeddings, however, when run on the same benchmarks, they produce identical results.
16
+ The model uses only the encoder from a T5-3B model. The weights are stored in FP16.
17
+
18
+ ## Usage (Sentence-Transformers)
19
+
20
+ Using this model becomes easy when you have [sentence-transformers](https://www.SBERT.net) installed:
21
+
22
+ ```
23
+ pip install -U sentence-transformers
24
+ ```
25
+
26
+ Then you can use the model like this:
27
+
28
+ ```python
29
+ from sentence_transformers import SentenceTransformer
30
+ sentences = ["This is an example sentence", "Each sentence is converted"]
31
+
32
+ model = SentenceTransformer('sentence-transformers/sentence-t5-xl')
33
+ embeddings = model.encode(sentences)
34
+ print(embeddings)
35
+ ```
36
+
37
+ The model requires sentence-transformers version 2.2.0 or newer.
38
+
39
+ ## Evaluation Results
40
+
41
+ For an automated evaluation of this model, see the *Sentence Embeddings Benchmark*: [https://seb.sbert.net](https://seb.sbert.net?model_name=sentence-transformers/sentence-t5-xl)
42
+
43
+ ## Citing & Authors
44
+
45
+ If you find this model helpful, please cite the respective publication:
46
+ [Sentence-T5: Scalable sentence encoders from pre-trained text-to-text models](https://arxiv.org/abs/2108.08877)