[skip ci] Add desc comments for CheckTrain (#9341)

Signed-off-by: dragondriver <jiquan.long@zilliz.com>
2021-10-06 19:34:05 +08:00 · 2021-10-06 19:34:05 +08:00 · 1fb02f87f0
parent 434c587c4e
commit 1fb02f87f0
1 changed files with 1 additions and 0 deletions
--- a/internal/util/indexparamcheck/conf_adapter.go
+++ b/internal/util/indexparamcheck/conf_adapter.go
@ -93,6 +93,7 @@ var supportDimPerSubQuantizer = []int{32, 28, 24, 20, 16, 12, 10, 8, 6, 4, 3, 2,
 var supportSubQuantizer = []int{96, 64, 56, 48, 40, 32, 28, 24, 20, 16, 12, 8, 4, 3, 2, 1} // const

 type ConfAdapter interface {
+    // CheckTrain returns true if the index can be built with the spcecific index parameters.
 	CheckTrain(map[string]string) bool
 }