Commit
•
44eb404
1
Parent(s):
1a31085
Several small spelling errors in README (#48)
Browse files- Several small spelling errors in README (2f3b461246cd6b756de7c85150aabebbb2c36905)
Co-authored-by: Joel Wigton <joelwigton@users.noreply.huggingface.co>
README.md
CHANGED
@@ -104,14 +104,14 @@ The project aims to train sentence embedding models on very large sentence level
|
|
104 |
contrastive learning objective. We used the pretrained [`nreimers/MiniLM-L6-H384-uncased`](https://huggingface.co/nreimers/MiniLM-L6-H384-uncased) model and fine-tuned in on a
|
105 |
1B sentence pairs dataset. We use a contrastive learning objective: given a sentence from the pair, the model should predict which out of a set of randomly sampled other sentences, was actually paired with it in our dataset.
|
106 |
|
107 |
-
We
|
108 |
[Community week using JAX/Flax for NLP & CV](https://discuss.huggingface.co/t/open-to-the-community-community-week-using-jax-flax-for-nlp-cv/7104),
|
109 |
-
organized by Hugging Face. We
|
110 |
[Train the Best Sentence Embedding Model Ever with 1B Training Pairs](https://discuss.huggingface.co/t/train-the-best-sentence-embedding-model-ever-with-1b-training-pairs/7354). We benefited from efficient hardware infrastructure to run the project: 7 TPUs v3-8, as well as intervention from Googles Flax, JAX, and Cloud team member about efficient deep learning frameworks.
|
111 |
|
112 |
## Intended uses
|
113 |
|
114 |
-
Our model is
|
115 |
the semantic information. The sentence vector may be used for information retrieval, clustering or sentence similarity tasks.
|
116 |
|
117 |
By default, input text longer than 256 word pieces is truncated.
|
@@ -130,7 +130,7 @@ We then apply the cross entropy loss by comparing with true pairs.
|
|
130 |
|
131 |
#### Hyper parameters
|
132 |
|
133 |
-
We trained
|
134 |
We use a learning rate warm up of 500. The sequence length was limited to 128 tokens. We used the AdamW optimizer with
|
135 |
a 2e-5 learning rate. The full training script is accessible in this current repository: `train_script.py`.
|
136 |
|
|
|
104 |
contrastive learning objective. We used the pretrained [`nreimers/MiniLM-L6-H384-uncased`](https://huggingface.co/nreimers/MiniLM-L6-H384-uncased) model and fine-tuned in on a
|
105 |
1B sentence pairs dataset. We use a contrastive learning objective: given a sentence from the pair, the model should predict which out of a set of randomly sampled other sentences, was actually paired with it in our dataset.
|
106 |
|
107 |
+
We developed this model during the
|
108 |
[Community week using JAX/Flax for NLP & CV](https://discuss.huggingface.co/t/open-to-the-community-community-week-using-jax-flax-for-nlp-cv/7104),
|
109 |
+
organized by Hugging Face. We developed this model as part of the project:
|
110 |
[Train the Best Sentence Embedding Model Ever with 1B Training Pairs](https://discuss.huggingface.co/t/train-the-best-sentence-embedding-model-ever-with-1b-training-pairs/7354). We benefited from efficient hardware infrastructure to run the project: 7 TPUs v3-8, as well as intervention from Googles Flax, JAX, and Cloud team member about efficient deep learning frameworks.
|
111 |
|
112 |
## Intended uses
|
113 |
|
114 |
+
Our model is intended to be used as a sentence and short paragraph encoder. Given an input text, it outputs a vector which captures
|
115 |
the semantic information. The sentence vector may be used for information retrieval, clustering or sentence similarity tasks.
|
116 |
|
117 |
By default, input text longer than 256 word pieces is truncated.
|
|
|
130 |
|
131 |
#### Hyper parameters
|
132 |
|
133 |
+
We trained our model on a TPU v3-8. We train the model during 100k steps using a batch size of 1024 (128 per TPU core).
|
134 |
We use a learning rate warm up of 500. The sequence length was limited to 128 tokens. We used the AdamW optimizer with
|
135 |
a 2e-5 learning rate. The full training script is accessible in this current repository: `train_script.py`.
|
136 |
|