The convergence summary points at a test file that a pip install does not have

Abierto Apto para principiantes
#1,340 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

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

Línea de trabajo

Lee faircode/benchmark.py en convergence_summary y la sección del README sobre la convergencia del benchmark. Añade una frase que explique qué significa que un ajuste se haya detenido y cuáles son los casos conocidos; después, actualiza la línea de resumen para que apunte a un ancla existente del README. Confirma el ancla con la prueba de enlaces rotos o una prueba unitaria.

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

Descripción

enhancement good first issue reproducibility

Where: faircode/benchmark.py (convergence_summary).

Current gap: Each summary line ends with see tests/test_benchmark_convergence.py, which exists in a checkout but not for someone who installed the package, for whom it names a file they cannot open.

Suggested approach: Point at the README section on benchmark convergence (add one sentence there saying what a stopped fit means and the known cases) instead of a test path.

Done when: the line names a README anchor that exists, checked by the broken-link test or a unit test.

Lenguaje dominante
HTML
Estrellas
47
Forks
45
Merge medio
2 h 39 min
PR fusionados (30 d)
57

Preparar el entorno

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 yakew7/Fair-Code

Todos los issues de yakew7/Fair-Code

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.