Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Specify more precise names for similarities in RDKit

Đang mở
#8,317 15 bình luận 0 reaction 0 người được giao Xem trên GitHub

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

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
45/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Lĩnh vực
documentation

Hướng nghiên cứu

Start by locating the documentation and API definitions for the Kulczynski, Sokal, AllBit, and Asymmetric similarities, then compare their current labels with the cited literature. Done means the similarity variants are explicitly identified in the documentation and any renames or aliases follow the project's deprecation policy.

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

Mô tả

documentation enhancement stale

Is your feature request related to a problem? Please describe.
There are 2 different Kulczynski similarity measures and at least 7 similarities with "Sokal" in the name. I spent over a week to understand that it uses Kulczynski 2 similarity and Sokal-Sneath 2 similarity. Formulas in the code are not particularly straightforward to translate to the standard literature ones (but I eventually got the proofs right).

Furthermore:

  • "AllBit" similarity is the Rand similarity, also known as Sokal-Michener simple matching
  • "Asymmetric" similarity is the Simpson similarity, also known as overlap similarity

As far as I can tell, only RDKit uses the former names. I think that common literature names should be used

References:

Describe the solution you'd like
Specify similarity types explicitly in the documentation for Kulczynski and Sokal. Change names of AllBit and Asymmetric to Rand and Simpson similarity, respectively.

Describe alternatives you've considered
If names for AllBit and Asymmetric are not easily changeable with deprecation schedule (though I think they are), more common names should at least be mentioned in the docs.

Ngôn ngữ chính
HTML
Star
3.6k
Fork
1.1k
Merge trung bình
3 ngày 8 giờ
Pull request đã merge (30 ngày)
44

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

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 rdkit/rdkit

Tất cả issue của rdkit/rdkit

Issue tương tự

Thêm issue về Documentation

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.