Feat added bk tree benchmark and docs

[pablocael]

No description provided.

[Dobatymo]

The scaling behaviour of the Faiss index looks a bit strange. Maybe can you run the benchmark again and regenerate the plot?

[pablocael]

The scaling behaviour of the Faiss index looks a bit strange. Maybe can you run the benchmark again and regenerate the plot?

Yes, its a bit weird. Btw it seems bktree tests failed:

         indices, distances, keys = tree.find_threshold(data, 0)
  >       assert indices == [[i] for i in range(num_points)]
  E       assert [[0, 1], [0, 1]] == [[0], [1]]
  E         At index 0 diff: [0, 1] != [0]
  E         Use -v to get more diff
  
  bktree_cls = <class '_pynear.BKTreeBinaryIndex'>
  data       = array([[233],
         [233]], dtype=uint8)
  dimensions = 1
  distances  = [[0, 0], [0, 0]]
  indices    = [[0, 1], [0, 1]]
  keys       = [[[233], [233]], [[233], [233]]]
  num_points = 2
  tree       = <_pynear.BKTreeBinaryIndex object at 0x7f7c2b26d230>

Only under ubuntu. But it is probably because I had removed fixed seeds?

[Dobatymo]

Retrying fixed it... although I am not sure why it failed before... again...