@@ -108,13 +108,13 @@ Restrict the list of algorithms by name or metric and/or unit.
108
108
109
109
``` elixir
110
110
iex> opts = [algorithms: [" bag_distance" , " jaccard" , " jaro_winkler" ]]
111
- iex> Akin .compare (" weird" , " wierd" , opts] )
111
+ iex> Akin .compare (" weird" , " wierd" , opts)
112
112
%{
113
113
bag_distance: 1.0 ,
114
114
jaccard: 0.14 ,
115
115
jaro_winkler: 0.94
116
116
}
117
- iex> opts = [metric: " phonetic" , unit: “ whole” ]
117
+ iex> opts = [algorithms: [ metric: " phonetic" , unit: " whole" ] ]
118
118
iex > Akin .compare (" weird" , " wierd" , opts)
119
119
%{
120
120
double_metaphone: 1.0 ,
@@ -169,13 +169,20 @@ iex> Akin.compare("write", "writing", [algorithms: ["bag_distance", "double_meta
169
169
##### Additional Examples
170
170
171
171
``` elixir
172
- iex> Akin .compare (" weird" , " wierd" , [ algorithms: " bag_distance" , " jaro_winkler" , " jaccard" ])
172
+ iex> Akin .compare (" weird" , " wierd" , algorithms: [ " bag_distance" , " jaro_winkler" , " jaccard" ])
173
173
%{bag_distance: 1.0 , jaccard: 0.14 , jaro_winkler: 0.94 }
174
174
```
175
175
176
176
``` elixir
177
- iex> Akin .compare (" weird" , " wierd" , [ngram_size: 1 , metric: " string" , unit: " whole" ])
178
- %{jaccard: 0.67 }
177
+ iex> Akin .compare (" weird" , " wierd" , algorithms: [metric: " string" , unit: " whole" ], ngram_size: 1 )
178
+ %{
179
+ bag_distance: 1.0 ,
180
+ jaccard: 0.67 ,
181
+ jaro_winkler: 0.94 ,
182
+ levenshtein: 0.6 ,
183
+ sorensen_dice: 0.8 ,
184
+ tversky: 1.0
185
+ }
179
186
```
180
187
181
188
### Preprocessing
0 commit comments