Improve docs on `n_neighbors` relation with `search_window_size`

Đang mở
  • Có gì không ổn?
#74 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 5 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
55/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
cpp
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với tài liệu về C++ Vamana search và set_search_window_size được liên kết trong issue, sau đó xem lại các phần về tìm kiếm trong chỉ mục ở python/vamana.html, start.html và start_cpp.html. Cập nhật các ghi chú để tất cả các vị trí đều mô tả nhất quán việc điều chỉnh tạm thời khi cửa sổ tìm kiếm nhỏ hơn số lượng láng giềng được yêu cầu, đồng thời kiểm tra các liên kết đến tài liệu được tạo và cách diễn đạt.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

Ngôn ngữ chính
C++
Star
241
Fork
48
Merge trung bình
4 ngày 21 giờ
Pull request đã merge (30 ngày)
11

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của intel/ScalableVectorSearch

Tất cả issue của intel/ScalableVectorSearch

Issue tương tự

Thêm issue về C++

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.