voxel51/fiftyone

[FR] Add helpful error message when using the App in a remote notebook without appropriate port forwarding

Open

#1128 aperta il 16 lug 2021

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)Python (400 fork)batch import
appenhancementgood first issuenotebook

Metriche repository

Star
 (4021 star)
Metriche merge PR
 (Merge medio 3g 11h) (161 PR mergiate in 30 g)

Descrizione

When using the FiftyOne App in a remote Jupyter notebook, you need to forward the port used by the App (say YYYY):

# On local machine
ssh -N -L 5151:localhost:YYYY [<username>@]<hostname>

so that when you launch the App in a notebook cell:

# Launch the App in a notebook cell
session = fo.launch_app(dataset, port=YYYY)

you will see the App as expected.

However, if you don't forward the port, you'll see this when launching the App:

It would be helpful to the user if we detected this case and printed a helpful error message instructing the user how to forward the port and pointing them to documentation on the subject.

Guida contributor

Direzione di ricerca
Implementare il rilevamento della mancanza di port forwarding quando si avvia l'App in un notebook Jupyter remoto e visualizzare un messaggio di errore utile con le istruzioni per il port forwarding.
Tech stack
python
Dominio
backend
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Python
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80