Minor
Browse files
README.md
CHANGED
|
@@ -51,19 +51,20 @@ for score in results:
|
|
| 51 |
|
| 52 |
Sem-F1 also accepts multiple optional arguments:
|
| 53 |
|
| 54 |
-
`model_type (str)`: Model to use for encoding sentences. Options: ['pv1', 'stsb', 'use']
|
| 55 |
-
* `pv1` - [paraphrase-distilroberta-base-v1](https://huggingface.co/sentence-transformers/paraphrase-distilroberta-base-v1)
|
| 56 |
-
* `stsb` - [stsb-roberta-large](https://huggingface.co/sentence-transformers/stsb-roberta-large)
|
| 57 |
-
* `use` - [Universal Sentence Encoder](https://huggingface.co/sentence-transformers/use-cmlm-multilingual) (Default)
|
| 58 |
|
| 59 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 60 |
such as `all-mpnet-base-v2` or `roberta-base`
|
| 61 |
|
| 62 |
-
`tokenize_sentences (bool)`: Flag to indicate whether to tokenize the sentences in the input documents. Default: True.
|
| 63 |
-
`multi_references (bool)`: Flag to indicate whether multiple references are provided. Default: False.
|
| 64 |
-
`gpu (Union[bool, str, int, List[Union[str, int]]])`: Whether to use GPU, CPU or multiple-processes for computation.
|
| 65 |
-
`batch_size (int)`: Batch size for encoding. Default: 32.
|
| 66 |
-
`verbose (bool)`: Flag to indicate verbose output. Default: False.
|
| 67 |
|
| 68 |
Refer to the inputs descriptions for more detailed usage as follows:
|
| 69 |
|
|
|
|
| 51 |
|
| 52 |
Sem-F1 also accepts multiple optional arguments:
|
| 53 |
|
| 54 |
+
- `model_type (str)`: Model to use for encoding sentences. Options: ['pv1', 'stsb', 'use']
|
|
|
|
|
|
|
|
|
|
| 55 |
|
| 56 |
+
- `pv1` - [paraphrase-distilroberta-base-v1](https://huggingface.co/sentence-transformers/paraphrase-distilroberta-base-v1)
|
| 57 |
+
- `stsb` - [stsb-roberta-large](https://huggingface.co/sentence-transformers/stsb-roberta-large)
|
| 58 |
+
- `use` - [Universal Sentence Encoder](https://huggingface.co/sentence-transformers/use-cmlm-multilingual) (Default)
|
| 59 |
+
|
| 60 |
+
Furthermore, you can use any model on Huggingface/SentenceTransformer that is supported by SentenceTransformer
|
| 61 |
such as `all-mpnet-base-v2` or `roberta-base`
|
| 62 |
|
| 63 |
+
- `tokenize_sentences (bool)`: Flag to indicate whether to tokenize the sentences in the input documents. Default: True.
|
| 64 |
+
- `multi_references (bool)`: Flag to indicate whether multiple references are provided. Default: False.
|
| 65 |
+
- `gpu (Union[bool, str, int, List[Union[str, int]]])`: Whether to use GPU, CPU or multiple-processes for computation.
|
| 66 |
+
- `batch_size (int)`: Batch size for encoding. Default: 32.
|
| 67 |
+
- `verbose (bool)`: Flag to indicate verbose output. Default: False.
|
| 68 |
|
| 69 |
Refer to the inputs descriptions for more detailed usage as follows:
|
| 70 |
|