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

Aperta
#305 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
66/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
python

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
Python
Stelle
5
Fork
4
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

  • Include un Dockerfile o un file Docker Compose
  • Nessun modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di NCATSTranslator/NameResolution

Tutte le issue di NCATSTranslator/NameResolution

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.