Improve docs on `n_neighbors` relation with `search_window_size`

Offen
  • Stimmt etwas nicht?
#74 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 5 Tagen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
55/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Veraltet
Tech-Stack
cpp
Bereich
documentation

Rechercherichtung

Beginne mit der im Issue verlinkten Dokumentation zu C++ Vamana search und set_search_window_size und sieh dir anschließend die Abschnitte zum Durchsuchen des Index in python/vamana.html, start.html und start_cpp.html an. Aktualisiere die Hinweise, sodass alle Stellen konsistent die vorübergehende Anpassung beschreiben, wenn das Suchfenster kleiner als die angeforderte Nachbaranzahl ist, und überprüfe die generierten Dokumentationslinks sowie die Formulierung.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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

Vorherrschende Sprache
C++
Sterne
241
Forks
48
Ø Merge
4 T. 21 Std.
Gemergte PRs (30 T.)
11

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus intel/ScalableVectorSearch

Alle Issues in intel/ScalableVectorSearch

Ähnliche Issues

Weitere Issues zu C++

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.