update README
Browse files
README.md
CHANGED
@@ -43,9 +43,9 @@ Downloading builder script: 100%|βββββββββββββββ
|
|
43 |
### Inputs
|
44 |
*List all input arguments in the format below*
|
45 |
- **predictions** *(list of strings): list of sentences to test diversity. Each prediction should be a string.*
|
46 |
-
- **mode** *(string): 'Expectation-Adjusted-Distinct' or 'Distinct' for diversity
|
47 |
-
- **vocab_size** *(int):
|
48 |
-
- **dataForVocabCal** *(list of string): dataForVocabCal for calculating the vocab_size for 'Expectation-Adjusted-Distinct'. Typically, it should be a list of sentences consisting the task dataset.
|
49 |
- **tokenizer** *(string or tokenizer class): tokenizer for splitting sentences into words. Default value is "white_space". NLTK tokenizer is available.*
|
50 |
|
51 |
### Output Values
|
|
|
43 |
### Inputs
|
44 |
*List all input arguments in the format below*
|
45 |
- **predictions** *(list of strings): list of sentences to test diversity. Each prediction should be a string.*
|
46 |
+
- **mode** *(string): 'Expectation-Adjusted-Distinct' or 'Distinct' for diversity calculation. If 'Expectation-Adjusted-Distinct', the scores for both modes will be returned. The default value is 'Expectation-Adjusted-Distinct'*
|
47 |
+
- **vocab_size** *(int): For calculating 'Expectation-Adjusted-Distinct', either vocab_size or dataForVocabCal should not be None. Default value is None*
|
48 |
+
- **dataForVocabCal** *(list of string): dataForVocabCal for calculating the vocab_size for 'Expectation-Adjusted-Distinct'. Typically, it should be a list of sentences consisting the task dataset. For calculating 'Expectation-Adjusted-Distinct', either vocab_size or dataForVocabCal should not be None. Default value is None*
|
49 |
- **tokenizer** *(string or tokenizer class): tokenizer for splitting sentences into words. Default value is "white_space". NLTK tokenizer is available.*
|
50 |
|
51 |
### Output Values
|