model_test.go 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149
  1. // Copyright 2021 gorse Project Authors
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. package ranking
  15. import (
  16. "bytes"
  17. "context"
  18. "math"
  19. "runtime"
  20. "testing"
  21. "github.com/stretchr/testify/assert"
  22. "github.com/zhenghaoz/gorse/base/floats"
  23. "github.com/zhenghaoz/gorse/base/task"
  24. "github.com/zhenghaoz/gorse/model"
  25. )
  26. const (
  27. benchDelta = 0.01
  28. incrDelta = 0.05
  29. )
  30. func newFitConfig(numEpoch int) *FitConfig {
  31. cfg := NewFitConfig().SetVerbose(1).SetJobsAllocator(task.NewConstantJobsAllocator(runtime.NumCPU()))
  32. return cfg
  33. }
  34. // He, Xiangnan, et al. "Neural collaborative filtering." Proceedings
  35. // of the 26th international conference on world wide web. 2017.
  36. func TestBPR_MovieLens(t *testing.T) {
  37. trainSet, testSet, err := LoadDataFromBuiltIn("ml-1m")
  38. assert.NoError(t, err)
  39. m := NewBPR(model.Params{
  40. model.NFactors: 8,
  41. model.Reg: 0.01,
  42. model.Lr: 0.05,
  43. model.NEpochs: 30,
  44. model.InitMean: 0,
  45. model.InitStdDev: 0.001,
  46. })
  47. fitConfig := newFitConfig(30)
  48. score := m.Fit(context.Background(), trainSet, testSet, fitConfig)
  49. assert.InDelta(t, 0.36, score.NDCG, benchDelta)
  50. assert.Equal(t, trainSet.UserIndex, m.GetUserIndex())
  51. assert.Equal(t, testSet.ItemIndex, m.GetItemIndex())
  52. // test predict
  53. assert.Equal(t, m.Predict("1", "1"), m.InternalPredict(1, 1))
  54. assert.Equal(t, m.InternalPredict(1, 1), floats.Dot(m.GetUserFactor(1), m.GetItemFactor(1)))
  55. assert.True(t, m.IsUserPredictable(1))
  56. assert.True(t, m.IsItemPredictable(1))
  57. assert.False(t, m.IsUserPredictable(math.MaxInt32))
  58. assert.False(t, m.IsItemPredictable(math.MaxInt32))
  59. // test encode/decode model and increment training
  60. buf := bytes.NewBuffer(nil)
  61. err = MarshalModel(buf, m)
  62. assert.NoError(t, err)
  63. tmp, err := UnmarshalModel(buf)
  64. assert.NoError(t, err)
  65. assert.True(t, tmp.IsUserPredictable(1))
  66. assert.True(t, tmp.IsItemPredictable(1))
  67. assert.False(t, tmp.IsUserPredictable(math.MaxInt32))
  68. assert.False(t, tmp.IsItemPredictable(math.MaxInt32))
  69. m = tmp.(*BPR)
  70. m.nEpochs = 1
  71. fitConfig = newFitConfig(1)
  72. scoreInc := m.Fit(context.Background(), trainSet, testSet, fitConfig)
  73. assert.InDelta(t, score.NDCG, scoreInc.NDCG, incrDelta)
  74. // test clear
  75. m.Clear()
  76. assert.True(t, m.Invalid())
  77. }
  78. //func TestBPR_Pinterest(t *testing.T) {
  79. // trainSet, testSet, err := LoadDataFromBuiltIn("pinterest-20")
  80. // assert.NoError(t, err)
  81. // m := NewBPR(model.Params{
  82. // model.NFactors: 8,
  83. // model.Reg: 0.005,
  84. // model.Lr: 0.05,
  85. // model.NEpochs: 50,
  86. // model.InitMean: 0,
  87. // model.InitStdDev: 0.001,
  88. // })
  89. // score := m.Fit(trainSet, testSet, fitConfig)
  90. // assertEpsilon(t, 0.53, score.NDCG, benchDelta)
  91. //}
  92. func TestCCD_MovieLens(t *testing.T) {
  93. trainSet, testSet, err := LoadDataFromBuiltIn("ml-1m")
  94. assert.NoError(t, err)
  95. m := NewCCD(model.Params{
  96. model.NFactors: 8,
  97. model.Reg: 0.015,
  98. model.NEpochs: 30,
  99. model.Alpha: 0.05,
  100. })
  101. fitConfig := newFitConfig(30)
  102. score := m.Fit(context.Background(), trainSet, testSet, fitConfig)
  103. assert.InDelta(t, 0.36, score.NDCG, benchDelta)
  104. // test predict
  105. assert.Equal(t, m.Predict("1", "1"), m.InternalPredict(1, 1))
  106. assert.Equal(t, m.InternalPredict(1, 1), floats.Dot(m.GetUserFactor(1), m.GetItemFactor(1)))
  107. // test encode/decode model and increment training
  108. buf := bytes.NewBuffer(nil)
  109. err = MarshalModel(buf, m)
  110. assert.NoError(t, err)
  111. tmp, err := UnmarshalModel(buf)
  112. assert.NoError(t, err)
  113. m = tmp.(*CCD)
  114. m.nEpochs = 1
  115. fitConfig = newFitConfig(1)
  116. scoreInc := m.Fit(context.Background(), trainSet, testSet, fitConfig)
  117. assert.InDelta(t, score.NDCG, scoreInc.NDCG, incrDelta)
  118. // test clear
  119. m.Clear()
  120. assert.True(t, m.Invalid())
  121. }
  122. //func TestCCD_Pinterest(t *testing.T) {
  123. // trainSet, testSet, err := LoadDataFromBuiltIn("pinterest-20")
  124. // assert.NoError(t, err)
  125. // m := NewCCD(model.Params{
  126. // model.NFactors: 8,
  127. // model.Reg: 0.01,
  128. // model.NEpochs: 20,
  129. // model.InitStdDev: 0.01,
  130. // model.Alpha: 0.001,
  131. // })
  132. // score := m.Fit(trainSet, testSet, fitConfig)
  133. // assertEpsilon(t, 0.52, score.NDCG, benchDelta)
  134. //}