pierluigic commited on
Commit
71205ad
1 Parent(s): 2dfbb96

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +4 -48
README.md CHANGED
@@ -19,66 +19,22 @@ Using this model becomes easy when you have [sentence-transformers](https://www.
19
 
20
  ```
21
  pip install -U sentence-transformers
 
 
22
  ```
23
 
24
  Then you can use the model like this:
25
 
26
  ```python
27
- from sentence_transformers import SentenceTransformer
28
- sentences = ["This is an example sentence", "Each sentence is converted"]
29
 
30
- model = SentenceTransformer('pierluigic/xl-lexeme')
31
  embeddings = model.encode(sentences)
32
  print(embeddings)
33
  ```
34
 
35
 
36
 
37
- ## Usage (HuggingFace Transformers)
38
- Without [sentence-transformers](https://www.SBERT.net), you can use the model like this: First, you pass your input through the transformer model, then you have to apply the right pooling-operation on-top of the contextualized word embeddings.
39
-
40
- ```python
41
- from transformers import AutoTokenizer, AutoModel
42
- import torch
43
-
44
-
45
- #Mean Pooling - Take attention mask into account for correct averaging
46
- def mean_pooling(model_output, attention_mask):
47
- token_embeddings = model_output[0] #First element of model_output contains all token embeddings
48
- input_mask_expanded = attention_mask.unsqueeze(-1).expand(token_embeddings.size()).float()
49
- return torch.sum(token_embeddings * input_mask_expanded, 1) / torch.clamp(input_mask_expanded.sum(1), min=1e-9)
50
-
51
-
52
- # Sentences we want sentence embeddings for
53
- sentences = ['This is an example sentence', 'Each sentence is converted']
54
-
55
- # Load model from HuggingFace Hub
56
- tokenizer = AutoTokenizer.from_pretrained('pierluigic/xl-lexeme')
57
- model = AutoModel.from_pretrained('pierluigic/xl-lexeme')
58
-
59
- # Tokenize sentences
60
- encoded_input = tokenizer(sentences, padding=True, truncation=True, return_tensors='pt')
61
-
62
- # Compute token embeddings
63
- with torch.no_grad():
64
- model_output = model(**encoded_input)
65
-
66
- # Perform pooling. In this case, mean pooling.
67
- sentence_embeddings = mean_pooling(model_output, encoded_input['attention_mask'])
68
-
69
- print("Sentence embeddings:")
70
- print(sentence_embeddings)
71
- ```
72
-
73
-
74
-
75
- ## Evaluation Results
76
-
77
- <!--- Describe how your model was evaluated -->
78
-
79
- For an automated evaluation of this model, see the *Sentence Embeddings Benchmark*: [https://seb.sbert.net](https://seb.sbert.net?model_name=pierluigic/xl-lexeme)
80
-
81
-
82
  ## Training
83
  The model was trained with the parameters:
84
 
 
19
 
20
  ```
21
  pip install -U sentence-transformers
22
+ git clone https://github.com/pierluigic/xl-lexeme
23
+ cd xl-lexeme
24
  ```
25
 
26
  Then you can use the model like this:
27
 
28
  ```python
29
+ from WordTransformer import WordTransformer
 
30
 
31
+ model = WordTransformer('pierluigic/xl-lexeme')
32
  embeddings = model.encode(sentences)
33
  print(embeddings)
34
  ```
35
 
36
 
37
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
38
  ## Training
39
  The model was trained with the parameters:
40