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

オープン
#305 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
66/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
python

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
Python
スター
5
フォーク
4
PR マージ指標
30日以内にマージされた PR はありません

環境構築

  • Dockerfile または Docker Compose ファイルあり
  • プルリクエストのテンプレートなし
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

NCATSTranslator/NameResolution のほかの issue

NCATSTranslator/NameResolution の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。