-
Notifications
You must be signed in to change notification settings - Fork 0
/
quality_eval.go
1255 lines (1152 loc) · 38.6 KB
/
quality_eval.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package search
import (
"bytes"
"database/sql"
"encoding/csv"
"encoding/json"
"fmt"
"io"
"io/ioutil"
"math"
"net/http"
"net/url"
"os"
"path"
"sort"
"strconv"
"strings"
"sync"
"time"
"github.com/spf13/viper"
log "github.com/Sirupsen/logrus"
"github.com/pkg/errors"
"gopkg.in/olivere/elastic.v6"
"github.com/Bnei-Baruch/archive-backend/consts"
"github.com/Bnei-Baruch/archive-backend/mdb"
"github.com/Bnei-Baruch/archive-backend/utils"
"github.com/Bnei-Baruch/sqlboiler/queries"
)
const (
EVAL_SET_EXPECTATION_FIRST_COLUMN = 4
EVAL_SET_EXPECTATION_LAST_COLUMN = 8
)
// Search quality enum. Order important, the lower (higher integer) the better.
const (
SQ_SERVER_ERROR = iota
SQ_NO_EXPECTATION = iota
SQ_BAD_STRUCTURE = iota
SQ_UNKNOWN = iota
SQ_REGULAR = iota
SQ_GOOD = iota
)
var SEARCH_QUALITY_NAME = map[int]string{
SQ_GOOD: "Good",
SQ_REGULAR: "Regular",
SQ_UNKNOWN: "Unknown",
SQ_BAD_STRUCTURE: "BadStructure",
SQ_NO_EXPECTATION: "NoExpectation",
SQ_SERVER_ERROR: "ServerError",
}
var SEARCH_QUALITY_BY_NAME = map[string]int{
"Good": SQ_GOOD,
"Regular": SQ_REGULAR,
"Unknown": SQ_UNKNOWN,
"BadStructure": SQ_BAD_STRUCTURE,
"NoExpectation": SQ_NO_EXPECTATION,
"ServerError": SQ_SERVER_ERROR,
}
// Compare results classification.
const (
CR_WIN = iota
CR_LOSS = iota
CR_SAME = iota
CR_NO_EXPECTATION = iota
CR_ERROR = iota
)
var COMPARE_RESULTS_NAME = map[int]string{
CR_WIN: "Win",
CR_LOSS: "Loss",
CR_SAME: "Same",
CR_ERROR: "Error",
}
const (
ET_NOT_SET = -1
ET_CONTENT_UNITS = iota
ET_COLLECTIONS = iota
ET_LESSONS = iota
ET_PROGRAMS = iota
ET_SOURCES = iota
ET_EVENTS = iota
ET_LANDING_PAGE = iota
ET_EMPTY = iota
ET_FAILED_PARSE = iota
ET_BAD_STRUCTURE = iota
ET_FAILED_SQL = iota
)
var EXPECTATIONS_FOR_EVALUATION = map[int]bool{
ET_CONTENT_UNITS: true,
ET_COLLECTIONS: true,
ET_LESSONS: true,
ET_PROGRAMS: true,
ET_SOURCES: true,
ET_LANDING_PAGE: true,
ET_EMPTY: false,
ET_FAILED_PARSE: false,
ET_BAD_STRUCTURE: true,
ET_FAILED_SQL: true,
}
var EXPECTATION_TO_NAME = map[int]string{
ET_CONTENT_UNITS: "et_content_units",
ET_COLLECTIONS: "et_collections",
ET_LESSONS: "et_lessons",
ET_PROGRAMS: "et_programs",
ET_SOURCES: "et_sources",
ET_LANDING_PAGE: "et_landing_page",
ET_EMPTY: "et_empty",
ET_FAILED_PARSE: "et_failed_parse",
ET_BAD_STRUCTURE: "et_bad_structure",
ET_FAILED_SQL: "et_failed_sql",
}
var EXPECTATION_URL_PATH = map[int]string{
ET_CONTENT_UNITS: "cu",
ET_COLLECTIONS: "c",
ET_LESSONS: "lessons",
ET_PROGRAMS: "programs",
ET_SOURCES: "sources",
ET_EVENTS: "events",
}
var EXPECTATION_HIT_TYPE = map[int]string{
ET_CONTENT_UNITS: consts.ES_RESULT_TYPE_UNITS,
ET_COLLECTIONS: consts.ES_RESULT_TYPE_COLLECTIONS,
ET_LESSONS: consts.INTENT_HIT_TYPE_LESSONS,
ET_PROGRAMS: consts.INTENT_HIT_TYPE_PROGRAMS,
ET_SOURCES: consts.ES_RESULT_TYPE_SOURCES,
ET_LANDING_PAGE: consts.GRAMMAR_TYPE_LANDING_PAGE,
}
var LANDING_PAGES = map[string]string{
"lessons": consts.GRAMMAR_INTENT_LANDING_PAGE_LESSONS,
"lessons/daily": consts.GRAMMAR_INTENT_LANDING_PAGE_LESSONS,
"lessons/virtual": consts.GRAMMAR_INTENT_LANDING_PAGE_VIRTUAL_LESSONS,
"lessons/lectures": consts.GRAMMAR_INTENT_LANDING_PAGE_LECTURES,
"lessons/women": consts.GRAMMAR_INTENT_LANDING_PAGE_WOMEN_LESSONS,
"lessons/rabash": consts.GRAMMAR_INTENT_LANDING_PAGE_RABASH_LESSONS,
"lessons/series": consts.GRAMMAR_INTENT_LANDING_PAGE_LESSON_SERIES,
"programs/main": consts.GRAMMAR_INTENT_LANDING_PAGE_PRORGRAMS,
"programs/clips": consts.GRAMMAR_INTENT_LANDING_PAGE_CLIPS,
"sources": consts.GRAMMAR_INTENT_LANDING_PAGE_LIBRARY,
"events": consts.GRAMMAR_INTENT_LANDING_PAGE_CONVENTIONS,
"events/conventions": consts.GRAMMAR_INTENT_LANDING_PAGE_CONVENTIONS,
"events/holidays": consts.GRAMMAR_INTENT_LANDING_PAGE_HOLIDAYS,
"events/unity-days": consts.GRAMMAR_INTENT_LANDING_PAGE_UNITY_DAYS,
"events/friends-gatherings": consts.GRAMMAR_INTENT_LANDING_PAGE_FRIENDS_GATHERINGS,
"events/meals": consts.GRAMMAR_INTENT_LANDING_PAGE_MEALS,
"topics": consts.GRAMMAR_INTENT_LANDING_PAGE_TOPICS,
"publications/blog": consts.GRAMMAR_INTENT_LANDING_PAGE_BLOG,
"publications/twitter": consts.GRAMMAR_INTENT_LANDING_PAGE_TWITTER,
"publications/articles": consts.GRAMMAR_INTENT_LANDING_PAGE_ARTICLES,
"simple-mode": consts.GRAMMAR_INTENT_LANDING_PAGE_DOWNLOADS,
"help": consts.GRAMMAR_INTENT_LANDING_PAGE_HELP,
}
const (
FILTER_NAME_SOURCE = "source"
FILTER_NAME_TOPIC = "topic"
FILTER_NAME_CONTENT_TYPE = "contentType"
PREFIX_LATEST = "[latest]"
)
var FLAT_REPORT_HEADERS = []string{
"Language", "Query", "Weight", "Bucket", "Comment",
"Expectation", "Parsed", "SearchQuality", "Rank"}
type Filter struct {
Name string `json:"name"`
Value string `json:"value"`
}
type Expectation struct {
Type int `json:"type"`
Uid string `json:"uid,omitempty"`
Filters []Filter `json:"filters,omitempty"`
Source string `json:"source"`
}
type Loss struct {
Expectation Expectation `json:"expectation,omitempty"`
Query EvalQuery `json:"query,omitempty"`
Unique float64 `json:"unique,omitempty"`
Weighted float64 `json:"weighted,omitempty"`
}
type EvalQuery struct {
Language string `json:"language"`
Query string `json:"query"`
Weight float64 `json:"weight,omitempty"`
Bucket string `json:"bucket,omitempty"`
Expectations []Expectation `json:"expectations"`
Comment string `json:"comment,omitempty"`
}
type EvalResults struct {
Results []EvalResult `json:"results"`
TotalUnique uint64 `json:"total_unique"`
TotalWeighted float64 `json:"total_weighted"`
TotalErrors uint64 `json:"total_errors"`
UniqueMap map[int]float64 `json:"unique_map"`
WeightedMap map[int]float64 `json:"weighted_map"`
}
type EvalResult struct {
SearchQuality []int `json:"search_quality"`
Rank []int `json:"rank"`
err error `json:"error"`
}
// Returns compare results classification constant.
func CompareResults(base int, exp int) int {
if base == SQ_NO_EXPECTATION || exp == SQ_NO_EXPECTATION {
return CR_NO_EXPECTATION
} else if base == SQ_SERVER_ERROR || exp == SQ_SERVER_ERROR {
return CR_ERROR
} else if base == exp {
return CR_SAME
} else if base < exp {
return CR_WIN // Experiment is better
} else {
return CR_LOSS // Base is better
}
}
func GoodExpectations(expectations []Expectation) int {
ret := 0
for i := range expectations {
if EXPECTATIONS_FOR_EVALUATION[expectations[i].Type] {
ret++
}
}
return ret
}
func InitAndReadEvalSet(evalSetPath string) ([]EvalQuery, error) {
db, err := sql.Open("postgres", viper.GetString("mdb.url"))
if err != nil {
return nil, errors.Wrap(err, "Unable to connect to DB.")
}
utils.Must(mdb.InitTypeRegistries(db))
f, err := os.Open(evalSetPath)
if err != nil {
return nil, err
}
defer f.Close()
return ReadEvalSet(f, db)
}
func ReadEvalSet(reader io.Reader, db *sql.DB) ([]EvalQuery, error) {
// Read File into a Variable
r := csv.NewReader(reader)
lines, err := r.ReadAll()
if err != nil {
return nil, err
}
expectationsCount := 0
queriesWithExpectationsCount := 0
var ret []EvalQuery
for _, line := range lines {
w, err := strconv.ParseFloat(strings.TrimSpace(line[2]), 64)
if err != nil {
log.Warnf("Failed parsing query [%s] weight [%s].", line[1], line[2])
continue
}
var expectations []Expectation
hasGoodExpectations := false
for i := EVAL_SET_EXPECTATION_FIRST_COLUMN; i <= EVAL_SET_EXPECTATION_LAST_COLUMN; i++ {
e := ParseExpectation(strings.TrimSpace(line[i]), db)
expectations = append(expectations, e)
if EXPECTATIONS_FOR_EVALUATION[e.Type] {
expectationsCount++
hasGoodExpectations = true
}
}
if hasGoodExpectations {
queriesWithExpectationsCount++
}
ret = append(ret, EvalQuery{
Language: strings.TrimSpace(line[0]),
Query: strings.TrimSpace(line[1]),
Weight: w,
Bucket: strings.TrimSpace(line[3]),
Expectations: expectations,
Comment: line[EVAL_SET_EXPECTATION_LAST_COLUMN+1],
})
}
log.Infof("Read %d queries, with total %d expectations. %d Queries had expectations.",
len(lines), expectationsCount, queriesWithExpectationsCount)
return ret, nil
}
type HitSource struct {
MdbUid string `json:"mdb_uid"`
ResultType string `json:"result_type"`
LandingPage string `json:"landing_page"`
}
// Parses expectation described by result URL and converts
// to type (collections or content_units) and uid.
// Examples:
// https://kabbalahmedia.info/he/programs/cu/AsNLozeK ==> (content_units, AsNLozeK)
// https://kabbalahmedia.info/he/programs/c/fLWpcUjQ ==> (collections , fLWpcUjQ)
// https://kabbalahmedia.info/he/lessons/series/c/XZoflItG ==> (collections , XZoflItG)
// https://kabbalahmedia.info/he/lessons?source=bs_L2jMWyce_kB3eD83I ==> (lessons, nil, source=bs_L2jMWyce_kB3eD83I)
// https://kabbalahmedia.info/he/programs?topic=g3ml0jum_1nyptSIo_RWqjxgkj ==> (programs, nil, topic=g3ml0jum_1nyptSIo_RWqjxgkj)
// https://kabbalahmedia.info/he/sources/kB3eD83I ==> (source, kB3eD83I)
// [latest]https://kabbalahmedia.info/he/lessons?source=bs_qMUUn22b_hFeGidcS ==> (content_units, SLQOALyt)
// [latest]https://kabbalahmedia.info/he/programs?topic=g3ml0jum_1nyptSIo_RWqjxgkj ==> (content_units, erZIsm86)
// [latest]https://kabbalahmedia.info/he/programs/c/zf4lLwyI ==> (content_units, orMKRcNk)
// All events sub pages and years:
// https://kabbalahmedia.info/he/events/meals
// https://kabbalahmedia.info/he/events/friends-gatherings
// https://kabbalahmedia.info/he/events?year=2013
func ParseExpectation(e string, db *sql.DB) Expectation {
originalE := e
if strings.Trim(e, " ") == "" {
return Expectation{ET_EMPTY, "", nil, originalE}
}
takeLatest := strings.HasPrefix(strings.ToLower(e), PREFIX_LATEST)
if takeLatest {
e = e[len(PREFIX_LATEST):]
}
u, err := url.Parse(e)
if err != nil {
return Expectation{ET_FAILED_PARSE, "", nil, originalE}
}
p := u.RequestURI()
idx := strings.Index(p, "?")
q := "" // The query part, i.e., .../he/lessons?source=bs_L2jMWyce_kB3eD83I => source=bs_L2jMWyce_kB3eD83I
if idx >= 0 {
q = p[idx+1:]
p = p[:idx]
}
// Last part .../he/programs/cu/AsNLozeK => AsNLozeK or /he/lessons => lessons
uidOrSection := path.Base(p)
// One before last part .../he/programs/cu/AsNLozeK => cu
contentUnitOrCollection := path.Base(path.Dir(p))
landingPage := path.Join(contentUnitOrCollection, uidOrSection)
subSection := ""
t := ET_NOT_SET
if _, ok := LANDING_PAGES[landingPage]; q == "" && !takeLatest && ok {
t = ET_LANDING_PAGE
uidOrSection = landingPage
} else if _, ok := LANDING_PAGES[uidOrSection]; q == "" && !takeLatest && ok {
t = ET_LANDING_PAGE
} else {
switch uidOrSection {
case EXPECTATION_URL_PATH[ET_LESSONS]:
t = ET_LESSONS
case EXPECTATION_URL_PATH[ET_PROGRAMS]:
t = ET_PROGRAMS
case EXPECTATION_URL_PATH[ET_EVENTS]:
t = ET_LANDING_PAGE
subSection = uidOrSection
}
}
if t != ET_NOT_SET {
var filters []Filter
if q != "" {
queryParts := strings.Split(q, "&")
filters = make([]Filter, len(queryParts))
for i, qp := range queryParts {
nameValue := strings.Split(qp, "=")
if len(nameValue) > 0 {
filters[i].Name = nameValue[0]
if len(nameValue) > 1 {
filters[i].Value = nameValue[1]
}
}
}
} else {
subSection = uidOrSection
t = ET_LANDING_PAGE
}
if takeLatest {
var err error
var entityType string
latestUID := ""
if subSection == "events" {
entityType = EXPECTATION_URL_PATH[ET_COLLECTIONS]
latestUID, err = getLatestUIDOfCollection(consts.CT_CONGRESS, db)
} else {
entityType = EXPECTATION_URL_PATH[ET_CONTENT_UNITS]
latestUID, err = getLatestUIDByFilters(filters, db)
}
if err != nil {
log.Warnf("Sql Error %+v", err)
return Expectation{ET_FAILED_SQL, "", filters, originalE}
}
newE := fmt.Sprintf("%s://%s%s/%s/%s", u.Scheme, u.Host, p, entityType, latestUID)
recExpectation := ParseExpectation(newE, db)
recExpectation.Source = originalE
return recExpectation
}
return Expectation{t, subSection, filters, originalE}
}
if t != ET_LANDING_PAGE {
switch contentUnitOrCollection {
case EXPECTATION_URL_PATH[ET_CONTENT_UNITS]:
t = ET_CONTENT_UNITS
case EXPECTATION_URL_PATH[ET_COLLECTIONS]:
t = ET_COLLECTIONS
if takeLatest {
latestUID, err := getLatestUIDByCollection(uidOrSection, db)
if err != nil {
log.Warnf("Sql Error %+v", err)
return Expectation{ET_FAILED_SQL, uidOrSection, nil, originalE}
}
uriParts := strings.Split(p, "/")
newE := fmt.Sprintf("%s://%s/%s/%s/%s/%s", u.Scheme, u.Host, uriParts[1], uriParts[2], EXPECTATION_URL_PATH[ET_CONTENT_UNITS], latestUID)
recExpectation := ParseExpectation(newE, db)
recExpectation.Source = originalE
return recExpectation
}
case EXPECTATION_URL_PATH[ET_SOURCES]:
t = ET_SOURCES
case EXPECTATION_URL_PATH[ET_EVENTS]:
t = ET_LANDING_PAGE
case EXPECTATION_URL_PATH[ET_LESSONS]:
t = ET_LANDING_PAGE
default:
if uidOrSection == EXPECTATION_URL_PATH[ET_SOURCES] {
return Expectation{ET_SOURCES, "", nil, originalE}
} else if uidOrSection == EXPECTATION_URL_PATH[ET_LESSONS] {
return Expectation{ET_LANDING_PAGE, "", nil, originalE}
} else {
return Expectation{ET_BAD_STRUCTURE, "", nil, originalE}
}
}
}
if t == ET_LANDING_PAGE && takeLatest {
var err error
latestUID := ""
switch uidOrSection {
case "women":
latestUID, err = getLatestUIDByContentType(consts.CT_WOMEN_LESSON, db)
case "meals":
latestUID, err = getLatestUIDByContentType(consts.CT_MEAL, db)
case "friends-gatherings":
latestUID, err = getLatestUIDByContentType(consts.CT_FRIENDS_GATHERING, db)
case "lectures":
latestUID, err = getLatestUIDByContentType(consts.CT_LECTURE, db)
case "virtual":
latestUID, err = getLatestUIDByContentType(consts.CT_VIRTUAL_LESSON, db)
}
if err != nil || latestUID == "" {
log.Warnf("Sql Error %+v", err)
return Expectation{ET_FAILED_SQL, uidOrSection, nil, originalE}
}
uriParts := strings.Split(p, "/")
newE := fmt.Sprintf("%s://%s/%s/%s/%s/%s", u.Scheme, u.Host, uriParts[1], uriParts[2], EXPECTATION_URL_PATH[ET_CONTENT_UNITS], latestUID)
recExpectation := ParseExpectation(newE, db)
recExpectation.Source = originalE
return recExpectation
}
if t == ET_NOT_SET {
panic(errors.New("Expectation not set."))
}
return Expectation{t, uidOrSection, nil, originalE}
}
func FilterValueToUid(value string) string {
sl := strings.Split(value, "_")
if len(sl) == 0 {
return ""
}
return sl[len(sl)-1]
}
func HitMatchesExpectation(hit *elastic.SearchHit, hitSource HitSource, e Expectation) bool {
hitType := hit.Type
if hitType == "result" {
hitType = hitSource.ResultType
}
if hitType != EXPECTATION_HIT_TYPE[e.Type] {
return false
}
if e.Type == ET_LESSONS || e.Type == ET_PROGRAMS {
// For now we support only one filter (zero also means not match).
if len(e.Filters) == 0 || len(e.Filters) > 1 {
return false
}
// Match all filters
filter := e.Filters[0]
return ((filter.Name == FILTER_NAME_TOPIC && hit.Index == consts.INTENT_INDEX_TAG) ||
(filter.Name == FILTER_NAME_SOURCE && hit.Index == consts.INTENT_INDEX_SOURCE)) &&
FilterValueToUid(filter.Value) == hitSource.MdbUid
} else if e.Type == ET_LANDING_PAGE {
return LANDING_PAGES[e.Uid] == hitSource.LandingPage
} else {
return hitSource.MdbUid == e.Uid
}
}
func EvaluateQuery(q EvalQuery, serverUrl string) EvalResult {
r := EvalResult{
SearchQuality: make([]int, len(q.Expectations)),
Rank: make([]int, len(q.Expectations)),
err: nil,
}
hasGoodExpectation := false
for i := range q.Expectations {
r.SearchQuality[i] = SQ_NO_EXPECTATION
r.Rank[i] = -1
if EXPECTATIONS_FOR_EVALUATION[q.Expectations[i].Type] {
hasGoodExpectation = true
}
}
// Optimization, don't fetch query if no good expectations.
if !hasGoodExpectation {
return r
}
urlTemplate := "%s/search?q=%s&language=%s&page_no=1&page_size=10&sort_by=relevance&deb=true"
url := fmt.Sprintf(urlTemplate, serverUrl, url.QueryEscape(q.Query), q.Language)
resp, err := http.Get(url)
if err != nil {
log.Warnf("Error %+v", err)
for i := range q.Expectations {
if EXPECTATIONS_FOR_EVALUATION[q.Expectations[i].Type] {
r.SearchQuality[i] = SQ_SERVER_ERROR
}
}
r.err = err
return r
}
if resp.StatusCode != http.StatusOK {
bodyBytes, err := ioutil.ReadAll(resp.Body)
if err != nil {
r.err = errors.Wrapf(err, "Status not ok (%d), failed reading body. Url: %s.", resp.StatusCode, url)
}
errMsg := fmt.Sprintf("Status not ok (%d), body: %s, url: %s.", resp.StatusCode, string(bodyBytes), url)
log.Warn(errMsg)
for i := range q.Expectations {
if EXPECTATIONS_FOR_EVALUATION[q.Expectations[i].Type] {
r.SearchQuality[i] = SQ_SERVER_ERROR
}
}
r.err = errors.New(errMsg)
return r
}
queryResult := QueryResult{}
defer resp.Body.Close()
if err := json.NewDecoder(resp.Body).Decode(&queryResult); err != nil {
log.Warnf("Error decoding %+v", err)
for i := range q.Expectations {
if EXPECTATIONS_FOR_EVALUATION[q.Expectations[i].Type] {
r.SearchQuality[i] = SQ_SERVER_ERROR
}
}
r.err = err
return r
}
for i := range q.Expectations {
if EXPECTATIONS_FOR_EVALUATION[q.Expectations[i].Type] {
sq := SQ_UNKNOWN
if q.Expectations[i].Type == ET_BAD_STRUCTURE {
sq = SQ_BAD_STRUCTURE
}
rank := -1
for j, hit := range queryResult.SearchResult.Hits.Hits {
hitSource := HitSource{}
if err := json.Unmarshal(*hit.Source, &hitSource); err != nil {
log.Warnf("Error unmarshling source %+v", err)
sq = SQ_SERVER_ERROR
rank = -1
r.err = err
break
}
if HitMatchesExpectation(hit, hitSource, q.Expectations[i]) {
rank = j + 1
if j <= 2 {
sq = SQ_GOOD
} else {
sq = SQ_REGULAR
}
break
}
}
r.SearchQuality[i] = sq
r.Rank[i] = rank
}
}
return r
}
func Eval(queries []EvalQuery, serverUrl string) (EvalResults, map[int][]Loss, error) {
log.Infof("Evaluating %d queries on %s.", len(queries), serverUrl)
ret := EvalResults{}
ret.UniqueMap = make(map[int]float64)
ret.WeightedMap = make(map[int]float64)
evalResults := make([]EvalResult, len(queries))
var doneWG sync.WaitGroup
paralellism := 5
c := make(chan bool, paralellism)
for i := 0; i < paralellism; i++ {
c <- true
}
log.Infof("C: %d", len(c))
rate := time.Second / 10
throttle := time.Tick(rate)
for i, q := range queries {
<-throttle // rate limit our Service.Method RPCs
<-c
doneWG.Add(1)
go func(i int, q EvalQuery) {
defer doneWG.Done()
defer func() { c <- true }()
evalResults[i] = EvaluateQuery(q, serverUrl)
log.Infof("Done %d / %d", i, len(queries))
}(i, q)
}
doneWG.Wait()
for i, r := range evalResults {
q := queries[i]
goodExpectations := GoodExpectations(q.Expectations)
if goodExpectations > 0 {
for i, sq := range r.SearchQuality {
if EXPECTATIONS_FOR_EVALUATION[q.Expectations[i].Type] {
ret.UniqueMap[sq] += 1 / float64(goodExpectations)
// Each expectation has equal weight for the query.
ret.WeightedMap[sq] += float64(q.Weight) / float64(goodExpectations)
}
}
} else {
// Meaning that the query has not any good expectation.
ret.UniqueMap[SQ_NO_EXPECTATION]++
ret.WeightedMap[SQ_NO_EXPECTATION] += float64(q.Weight)
}
ret.TotalUnique++
ret.TotalWeighted += q.Weight
if r.err != nil {
ret.TotalErrors++
}
ret.Results = append(ret.Results, r)
if len(ret.Results)%20 == 0 {
log.Infof("Done evaluating (%d/%d) queries.", len(ret.Results), len(queries))
}
}
for k, v := range ret.UniqueMap {
ret.UniqueMap[k] = v / float64(ret.TotalUnique)
}
for k, v := range ret.WeightedMap {
ret.WeightedMap[k] = v / float64(ret.TotalWeighted)
}
// Print detailed loss (Unknown) analysis
losses := make(map[int][]Loss)
for i, q := range queries {
for j, sq := range ret.Results[i].SearchQuality {
e := q.Expectations[j]
goodExpectationsLen := GoodExpectations(q.Expectations)
if sq == SQ_UNKNOWN || sq == SQ_SERVER_ERROR {
if _, ok := losses[e.Type]; !ok {
losses[e.Type] = make([]Loss, 0)
}
loss := Loss{e, q, 1 / float64(goodExpectationsLen), float64(q.Weight) / float64(goodExpectationsLen)}
losses[e.Type] = append(losses[e.Type], loss)
}
}
}
return ret, losses, nil
}
func ExpectationToString(e Expectation) string {
filters := make([]string, len(e.Filters))
for i, f := range e.Filters {
filters[i] = fmt.Sprintf("%s - %s", f.Name, f.Value)
}
return fmt.Sprintf("%s|%s|%s", EXPECTATION_TO_NAME[e.Type], e.Uid, strings.Join(filters, ":"))
}
func ResultsByExpectation(queries []EvalQuery, results EvalResults) [][]string {
records := [][]string{FLAT_REPORT_HEADERS}
for i, q := range queries {
goodExpectationsLen := GoodExpectations(q.Expectations)
for j, sq := range results.Results[i].SearchQuality {
if EXPECTATIONS_FOR_EVALUATION[q.Expectations[j].Type] {
record := []string{q.Language, q.Query, fmt.Sprintf("%.2f", float64(q.Weight)/float64(goodExpectationsLen)),
q.Bucket, q.Comment, q.Expectations[j].Source, ExpectationToString(q.Expectations[j]),
SEARCH_QUALITY_NAME[sq], fmt.Sprintf("%d", results.Results[i].Rank[j])}
records = append(records, record)
}
}
}
return records
}
func WriteResultsByExpectation(path string, queries []EvalQuery, results EvalResults) ([][]string, error) {
records := ResultsByExpectation(queries, results)
return records, WriteToCsv(path, records)
}
func updateVsGoldenDataFromRecords(data map[string]map[string][]float64, records [][]string, isGolden bool) error {
// Records: "Language", "Query", "Weight", "Bucket", "Comment", "Expectation", "Parsed", "SearchQuality", "Rank"
// Assuming records are already without headers.
for _, record := range records {
lang := record[0]
quality := record[7]
qualityMap, ok := data[lang]
if !ok {
data[lang] = make(map[string][]float64)
qualityMap = data[lang]
}
counters, ok := qualityMap[quality]
if !ok {
qualityMap[quality] = []float64{0.0, 0.0, 0.0, 0.0}
counters = qualityMap[quality]
}
queryWeight, err := strconv.ParseFloat(record[2], 64)
if err != nil {
return err
}
if isGolden {
counters[2]++
counters[3] += queryWeight
} else {
counters[0]++
counters[1] += queryWeight
}
}
return nil
}
func diffToHtml(diff float64, round bool, percentage bool) string {
if diff == float64(0.0) {
return ""
}
percentageStr := ""
if percentage {
percentageStr = "%"
}
diffStr := fmt.Sprintf("%.2f%s", math.Abs(diff), percentageStr)
if round {
diffStr = fmt.Sprintf("%d%s", (int)(math.Abs(diff)), percentageStr)
}
if diff > 0 {
return fmt.Sprintf("<span style='color: green'> (%s)</span>", diffStr)
}
return fmt.Sprintf("<span style='color: red'> (%s)</span>", diffStr)
}
func rankValue(rank string) int {
val, err := strconv.Atoi(rank)
if err != nil {
val = 0
}
if val == -1 {
val = 11
}
return val
}
func WriteVsGoldenHTML(vsGoldenHtml string, records [][]string, goldenRecords [][]string) error {
// Map from language => quality => (Unique, Weighted, Unique Golden, Weighted Golden)
data := make(map[string]map[string][]float64)
if err := updateVsGoldenDataFromRecords(data, records, false /*isGolden*/); err != nil {
return err
}
if err := updateVsGoldenDataFromRecords(data, goldenRecords, true /*isGolden*/); err != nil {
return err
}
style := `table {
border-collapse: collapse;
margin: 20px;
}
th {
background: #ccc;
}
th, td {
border: 1px solid #ccc;
padding: 8px;
}
tr:nth-child(even) {
background: #efefef;
}
tr:hover {
background: #d1d1d1;
}`
htmlParts := []string{fmt.Sprintf("<html><style>%s</style><body><table>", style)}
htmlParts = append(htmlParts, `
<tr>
<th>Language</th>
<th>Quality</th>
<th>Weighted%</th>
<th>Unique%</th>
<th>Unique</th>
</tr>`)
for _, language := range utils.StringMapOrderedKeys(data) {
qualityMap := data[language]
totalCounters := []float64{0.0, 0.0, 0.0, 0.0}
for _, counters := range qualityMap {
for i := 0; i < 4; i++ {
totalCounters[i] += counters[i]
}
}
firstColumn := true
qualityKeys := []string{}
for key := range qualityMap {
qualityKeys = append(qualityKeys, key)
}
sort.SliceStable(qualityKeys, func(i, j int) bool {
return SEARCH_QUALITY_BY_NAME[qualityKeys[i]] > SEARCH_QUALITY_BY_NAME[qualityKeys[j]]
})
for _, quality := range qualityKeys {
counters := qualityMap[quality]
if firstColumn {
htmlParts = append(htmlParts, fmt.Sprintf(
"<tr><td style='text-align: center; font-size: xx-large; font-weight: bold;' rowspan='%d'>%s</td>",
len(qualityMap), language))
} else {
htmlParts = append(htmlParts, "<tr>")
}
goodStyle := ""
if quality == "Good" {
goodStyle = "font-size: x-large; font-weight: bold;"
}
tdStyle := ""
if firstColumn {
tdStyle = "border-top: solid black 3px;border-bottom: solid black 3px;"
firstColumn = false
}
htmlParts = append(htmlParts, fmt.Sprintf(
` <td style='%s;%s'>%s</td>
<td style='%s;%s'><div style="display: flex; justify-content: space-evenly"><span>%.2f%%</span>%s</div></td>
<td style='%s'><div style="display: flex; justify-content: space-evenly"><span>%.2f%%</span>%s</div></td>
<td style='%s'><div style="display: flex; justify-content: space-evenly"><span>%d</span>%s</div></td>
</tr>`,
goodStyle, tdStyle, quality,
goodStyle, tdStyle,
100*counters[1]/totalCounters[1], // Weighted percentage.
diffToHtml(100*counters[1]/totalCounters[1]-100*counters[3]/totalCounters[3], false /*round*/, true /*%*/), // Weighted percentage diff.
tdStyle,
100*counters[0]/totalCounters[0], // Unique Percentage.
diffToHtml(100*counters[0]/totalCounters[0]-100*counters[2]/totalCounters[2], false /*round*/, true /*%*/), // Unique percentage diff.
tdStyle,
(int)(counters[0]), // Unique.
diffToHtml(counters[0]-counters[2], true /*round*/, false /*%*/), // Unique diff.
))
}
}
htmlParts = append(htmlParts, "</table>")
// Records: "Language", "Query", "Weight", "Bucket", "Comment", "Expectation", "Parsed", "SearchQuality", "Rank"
// Stores diffs between records and goldenRecords. Map from language to query to expectation to row.
recordsDiff := make(map[string]map[string]map[string][][]string)
for _, goldenRecord := range goldenRecords {
lang := goldenRecord[0]
query := goldenRecord[1]
expectation := goldenRecord[5]
if _, ok := recordsDiff[lang]; !ok {
recordsDiff[lang] = make(map[string]map[string][][]string)
}
byQueryDiff := recordsDiff[lang]
if _, ok := byQueryDiff[query]; !ok {
byQueryDiff[query] = make(map[string][][]string)
}
byExpectationDiff := byQueryDiff[query]
if _, ok := byExpectationDiff[expectation]; !ok {
byExpectationDiff[expectation] = [][]string{}
}
byExpectationDiff[expectation] = append(byExpectationDiff[expectation], goldenRecord)
}
for _, record := range records {
lang := record[0]
query := record[1]
expectation := record[5]
if _, ok := recordsDiff[lang]; !ok {
recordsDiff[lang] = make(map[string]map[string][][]string)
}
byQueryDiff := recordsDiff[lang]
if _, ok := byQueryDiff[query]; !ok {
byQueryDiff[query] = make(map[string][][]string)
}
byExpectationDiff := byQueryDiff[query]
if _, ok := byExpectationDiff[expectation]; !ok {
byExpectationDiff[expectation] = [][]string{}
}
if len(byExpectationDiff[expectation]) == 0 {
byExpectationDiff[expectation] = append(byExpectationDiff[expectation], nil)
}
byExpectationDiff[expectation] = append(byExpectationDiff[expectation], record)
}
for _, lang := range utils.StringMapOrderedKeys(recordsDiff) {
byQueryDiff := recordsDiff[lang]
recordsToSort := [][][]string{}
for _, byExpectationDiff := range byQueryDiff {
for _, records := range byExpectationDiff {
recordsToSort = append(recordsToSort, records)
}
}
// Calculatets score for diff to order them.
calcScore := func(p [][]string) float64 {
if p[0] != nil && p[1] == nil {
// 100K - weight for golden only (removed).
weight, err := strconv.ParseFloat(p[0][2], 64)
if err != nil {
weight = float64(0)
}
return float64(30000000) - weight
}
if p[0] == nil && p[1] != nil {
// 200K - Weight for new only (removed).
weight, err := strconv.ParseFloat(p[1][2], 64)
if err != nil {
weight = float64(0)
}
return float64(40000000) - weight
}
if p[0] != nil && p[1] != nil {
newQuality := float64(1000000) * float64(SQ_GOOD-SEARCH_QUALITY_BY_NAME[p[1][7]]+1)
goldenQuality := float64(1000000) * float64(SQ_GOOD-SEARCH_QUALITY_BY_NAME[p[0][7]]+1)
weight, err := strconv.ParseFloat(p[1][2], 64)
if err != nil {
weight = float64(0)
}
if newQuality == goldenQuality {
return 200000000 - weight
} else if newQuality < goldenQuality {
return newQuality - weight
} else {
return 100000000 + goldenQuality - weight
}
}
return 0
}
sort.SliceStable(recordsToSort, func(i, j int) bool {
return calcScore(recordsToSort[i]) < calcScore(recordsToSort[j])
})
htmlParts = append(htmlParts, "<table>")
htmlParts = append(htmlParts, "<tr><th>Language</th><th>Query</th><th>Weight</th><th>Expectation</th><th>Quality</th><th>Rank</th></tr>")
firstForLanguage := true
for _, records := range recordsToSort {
goldenRecord := records[0]
var newRecord []string
newRecord = nil
if len(records) > 1 {
newRecord = records[1]
}
onlyNew := goldenRecord == nil
onlyGolden := newRecord == nil
if newRecord == nil {
newRecord = goldenRecord
}
same := true
if !onlyNew {
if len(goldenRecord) != len(newRecord) {
return errors.New(fmt.Sprintf("Golden size %d is not new record size %d.", len(goldenRecord), len(newRecord)))
}
for i, newCell := range newRecord {
if newCell != goldenRecord[i] {
same = false
break
}
}
}
if !same || onlyNew || onlyGolden {
//log.Infof("Not same: %+v and %+v", newRecord, goldenRecord)
htmlParts = append(htmlParts, "<tr>")
for i, cell := range newRecord {
style := "text-overflow: ellipsis; max-width: 200; overflow: hidden;"
if onlyGolden {
style = fmt.Sprintf("%s; %s", style, "color: green")
} else if onlyNew {