holylovenia commited on
Commit
eb81709
1 Parent(s): 7a877e3

Update README.md

Browse files

Change `checkpoint` parameter in the examples to `config_name` so the checkpoint can be changed.

Files changed (1) hide show
  1. README.md +2 -2
README.md CHANGED
@@ -44,7 +44,7 @@ This metric takes as input lists of predicted sentences and reference sentences:
44
  ### Inputs
45
  - **predictions** (`list` of `str`s): List of generated sentences to score.
46
  - **references** (`list` of `str`s): List of references to compare to.
47
- - **checkpoint** (`str`): BLEURT checkpoint. Will default to `BLEURT-tiny` if not specified. Other models that can be chosen are: `"bleurt-tiny-128"`, `"bleurt-tiny-512"`, `"bleurt-base-128"`, `"bleurt-base-512"`, `"bleurt-large-128"`, `"bleurt-large-512"`, `"BLEURT-20-D3"`, `"BLEURT-20-D6"`, `"BLEURT-20-D12"` and `"BLEURT-20"`.
48
 
49
  ### Output Values
50
  - **scores** : a `list` of scores, one per prediction.
@@ -79,7 +79,7 @@ Example with the `"bleurt-base-128"` model checkpoint:
79
  ```python
80
  >>> predictions = ["hello there", "general kenobi"]
81
  >>> references = ["hello there", "general kenobi"]
82
- >>> bleurt = load("bleurt", module_type="metric", checkpoint="bleurt-base-128")
83
  >>> results = bleurt.compute(predictions=predictions, references=references)
84
  >>> print(results)
85
  {'scores': [1.0295498371124268, 1.0445425510406494]}
 
44
  ### Inputs
45
  - **predictions** (`list` of `str`s): List of generated sentences to score.
46
  - **references** (`list` of `str`s): List of references to compare to.
47
+ - **config_name** (`str`): BLEURT checkpoint. Will default to `BLEURT-tiny` if not specified. Other models that can be chosen are: `"bleurt-tiny-128"`, `"bleurt-tiny-512"`, `"bleurt-base-128"`, `"bleurt-base-512"`, `"bleurt-large-128"`, `"bleurt-large-512"`, `"BLEURT-20-D3"`, `"BLEURT-20-D6"`, `"BLEURT-20-D12"` and `"BLEURT-20"`.
48
 
49
  ### Output Values
50
  - **scores** : a `list` of scores, one per prediction.
 
79
  ```python
80
  >>> predictions = ["hello there", "general kenobi"]
81
  >>> references = ["hello there", "general kenobi"]
82
+ >>> bleurt = load("bleurt", module_type="metric", config\_name="bleurt-base-128")
83
  >>> results = bleurt.compute(predictions=predictions, references=references)
84
  >>> print(results)
85
  {'scores': [1.0295498371124268, 1.0445425510406494]}