Document how NameRes relates to Babel and NodeNorm, and whether it reports a version

Đang mở
#305 0 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ó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
66/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
python

Hướng nghiên cứu

Start with the NameRes README sections on Node Normalization and conflation, then trace how the index is built and how lookup requests are handled to establish the relationship and whether conflation can vary per query. Check the service routes for a status or version endpoint. Document the verified answers, including whether NameRes exposes a version; answering how its data relates to Babel and NodeNorm is enough to complete the issue.

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

Mô tả

Companion to NCATSTranslator/Babel#1077 and NCATSTranslator/NodeNormalization#412, which ask the same of those two repositories.

babel-explorer is a debugging tool for Babel cliques. It does not use NameRes today, but two open PRs add NameRes-backed frontends — a lookup tool (#23) and an autocomplete playground (#24) — so it is about to. Writing the agent documentation for that repository turned up questions about NameRes that the README does not answer.

This is a smaller ask than the other two: mostly about provenance, so a consumer can tell which Babel release a given answer reflects.

What we could not find

1. How NameRes relates to Babel and NodeNorm. The README says results are normalized through Node Normalization and "conflated using both GeneProtein and DrugChemical conflation", linking to Babel's conflation documentation — but not whether the NameRes index is built from Babel output, built from NodeNorm, or built independently and normalized afterwards. That difference determines whether a NameRes answer can be stale relative to a NodeNorm answer, which is exactly what a tool showing both side by side needs to know.

2. Whether there is a version or status endpoint. NodeNorm exposes babel_version via /status, and babel-explorer uses it to refuse to mix a NodeNorm built from one Babel release with Parquet files from another. If NameRes has an equivalent, it is not documented; if it does not have one, that is worth knowing too, because a UI showing NameRes and NodeNorm results together has no way to warn that they disagree about the world.

3. Whether conflation is fixed or per-query. The README states results are conflated both ways. Is that a property of the index, or a request parameter a caller can vary? A lookup tool would want to expose the choice if there is one.

Documents in babel-explorer worth reading

Answering point 1 alone would be enough to make the other two easy to reason about.

Ngôn ngữ chính
Python
Star
5
Fork
4
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

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

  • Có Dockerfile hoặc tệp Docker Compose
  • Không có mẫu pull request
  • Không có 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 NCATSTranslator/NameResolution

Tất cả issue của NCATSTranslator/NameResolution

Issue tương tự

Thêm issue về Python

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.