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

Abierto
#305 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
66/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
python

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Python
Estrellas
5
Forks
4
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

  • Incluye un Dockerfile o un archivo de Docker Compose
  • Sin plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de NCATSTranslator/NameResolution

Todos los issues de NCATSTranslator/NameResolution

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.