voxel51/fiftyone

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

Open

#1.128 aberto em 16 de jul. de 2021

Ver no GitHub
 (2 comments) (0 reactions) (0 assignees)Python (400 forks)batch import
appenhancementgood first issuenotebook

Métricas do repositório

Stars
 (4.021 stars)
Métricas de merge de PR
 (Mesclagem média 3d 11h) (161 fundiu PRs em 30d)

Description

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.

Guia do colaborador

Direção de pesquisa
Implementar a detecção de falta de encaminhamento de porta ao iniciar o aplicativo em um notebook Jupyter remoto e exibir uma mensagem de erro útil com instruções de encaminhamento de porta.
Pilha de tecnologia
python
Domain
backend
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Python
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80