simvue-io / simvue-io/python-api
Creating new grid breaks if axes labels not provided
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 4
- Fork
- 1
- Merge medio
- 5g 8h
- PR unite (30g)
- 4
Descrizione
Description of Bug
If I use assign_metrics_to_grid to make a new grid, and I don't provide a list of axes labels, it will crash and give a misleading error message:
File "/home/wk9874/Documents/simvue/python-api/simvue/run.py", line 1434, in assign_metric_to_grid
self._error(f"Grid '{grid_name}' is not defined.")
File "/home/wk9874/Documents/simvue/python-api/simvue/run.py", line 606, in _error
raise SimvueRunError(message)
simvue.exception.SimvueRunError: Grid 'test_metric_2d' is not defined.
I dont think axes labels should be required, it should probably default to 'x' for 2D metrics of ['x', 'y'] for 3D metrics. Although if you would prefer to be explicit and require axes labels, it should provide a more informative message
Steps To Reproduce
Code to reproduce the behavior:
import simvue
import numpy
with simvue.Run() as run:
run.init("test")
run.assign_metric_to_grid(metric_name="test_metric_2d", axes_ticks=numpy.arange(100))
for i in range(10):
run.log_metrics({"test_metric_2d": numpy.random.rand(10)}, time=i, step=i)
Expected behavior
Should create a grid and log a metric
Actual Behaviour
Error thrown
Screenshots
If applicable, add screenshots to help explain your problem.
Setup
- OS: Ubuntu 22.04
- Python version 3.10
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Ispeziona simvue/run.py intorno a assign_metric_to_grid alla riga 1434, quindi esegui la riproduzione usando numpy ed etichette degli assi mancanti. Conferma se il comportamento previsto consiste nel creare la griglia con i valori predefiniti o nel segnalare un errore di convalida più chiaro, e verifica che il comportamento risultante corrisponda alla griglia prevista e al flusso di registrazione delle metriche.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- numpy, python
- Ambito
- api, data
- Tipo di issue
- Bug
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100