SudharsanSundar commited on
Commit
728c06a
1 Parent(s): cfaf14b

Made more readable

Browse files
Files changed (1) hide show
  1. README.md +14 -10
README.md CHANGED
@@ -11,17 +11,21 @@ pinned: true
11
 
12
  **Token Edit Distance**
13
  This is an NLP evaluation metric that records the minimum number of token edits (insertions, deletions, and replacements, all weighted equally) to the prediction string in order to make it exactly match the reference string. Uses identical logic to Levenshtein Edit Distance, except applied to tokens (i.e. individual ints in a list) as opposed to individual characters in a string.
14
-
15
  *Args*:
16
- * predictions: List[List[Int]], list of predictions to score.
17
- ** Each prediction should be tokenized into a list of tokens.
18
- * references: List[List[Int]], list of references/ground truth output to score against.
19
- ** Each reference should be tokenized into a list of tokens.
20
-
21
- *Returns*:
22
- * "avg_token_edit_distance": Float, average Token Edit Distance for all inputted predictions and references
23
- * "token_edit_distances": List[Int], the Token Edit Distance for each inputted prediction and reference
24
-
 
 
 
 
25
  *Examples*:
26
  ```
27
  >>> token_edit_distance_metric = datasets.load_metric('Token Edit Distance')
 
11
 
12
  **Token Edit Distance**
13
  This is an NLP evaluation metric that records the minimum number of token edits (insertions, deletions, and replacements, all weighted equally) to the prediction string in order to make it exactly match the reference string. Uses identical logic to Levenshtein Edit Distance, except applied to tokens (i.e. individual ints in a list) as opposed to individual characters in a string.
14
+ <br/><br/>
15
  *Args*:
16
+ * predictions: ```List[List[Int]]```, list of predictions to score.
17
+ * Each prediction should be tokenized into a list of tokens.
18
+ * references: ```List[List[Int]]```, list of references/ground truth output to score against.
19
+ * Each reference should be tokenized into a list of tokens.
20
+
21
+ <br/><br/>
22
+
23
+ *Returns*:
24
+ * "avg_token_edit_distance": ```Float```, average Token Edit Distance for all inputted predictions and references
25
+ * "token_edit_distances": ```List[Int]```, the Token Edit Distance for each inputted prediction and reference
26
+
27
+ <br/><br/>
28
+
29
  *Examples*:
30
  ```
31
  >>> token_edit_distance_metric = datasets.load_metric('Token Edit Distance')