Improve docs on `n_neighbors` relation with `search_window_size`

Aberta
  • Algo errado?
#74 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 5 dias

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
55/100
Tipo de issue
Documentação
Clareza
Claramente especificada
Status de atividade
Estagnada
Stack de tecnologia
cpp
Domínio
documentation

Direção de pesquisa

Comece pela documentação de C++ Vamana search e set_search_window_size vinculada na issue e, em seguida, revise as seções sobre a pesquisa no índice em python/vamana.html, start.html e start_cpp.html. Atualize as notas para que todos os locais descrevam de forma consistente o ajuste temporário quando a janela de pesquisa for menor que a quantidade de vizinhos solicitada e verifique os links da documentação gerada e a redação.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

documentation enhancement good first issue

The C++ docs describe the relationship well:

If the current value of get_search_window_size() is less than num_neighbors, it will temporarily be set to num_neighbors.
https://intel.github.io/ScalableVectorSearch/cpp/internal/index_impl/vamana.html#_CPPv4I0_N4data22ImmutableMemoryDatasetEEN3svs5index6vamana11VamanaIndex6searchEv15QueryResultViewI1IERK7QueriesRK22search_parameters_typeRKN3lib16DefaultPredicateE

We should use that description in the other places where num_neighbors and search_window_size are discussed, e.g., set_search_window_size:
https://intel.github.io/ScalableVectorSearch/cpp/index/dynamic_vamana.html#_CPPv4N3svs13DynamicVamana22set_search_window_sizeE6size_t

In particular, we should change the following note in the examples:

Note that search_window_size must be at least as large as the desired number of neighbors.
https://intel.github.io/ScalableVectorSearch/python/vamana.html#searching-the-index
https://intel.github.io/ScalableVectorSearch/start.html#searching-the-index
https://intel.github.io/ScalableVectorSearch/start_cpp.html#searching-the-index

Linguagem predominante
C++
Estrelas
241
Forks
48
Merge médio
4d 21h
PRs com merge (30d)
11

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de intel/ScalableVectorSearch

Todas as issues de intel/ScalableVectorSearch

Issues semelhantes

Mais issues de C++

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.