aws / aws/aws-step-functions-data-science-sdk-python

render_graph() has hidden dependencies

Abierto
#189 1 comentario 3 reacciones 0 asignados Ver en GitHub
bug
Lenguaje dominante
Python
Estrellas
299
Forks
84
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

render_graph() is improperly documented and is not portable

### Use Case

Better support for render_graph() allows not just exploration through notebooks, it enables real production software projects. It provides feedback that doesn't require deployment in the AWS Console or through an automated deployment pipeline. It helps with documentation and code reviews.

It's a highly valuable tool in the SDK that only works in a notebook.

### Proposed Solution

Update the docs:

- https://aws-step-functions-data-science-sdk.readthedocs.io/en/stable/workflow.html#stepfunctions.workflow.Workflow.render_graph
- https://aws-step-functions-data-science-sdk.readthedocs.io/en/stable/readmelink.html#visualizing-a-workflow

The second link says it doesn't work in JupyterLab but it doesn't explicitly say that it only works in Jupyter Notebooks. I believe SageMaker and EMR Notebooks both use JupyterLab at this point.

If nothing is going to be done, this implementation should at least be deprecated because it's so selectively useful and is a red herring for people looking for this functionality.

### Other

The current render_graph() method provides very unclear documentation. There is no mention of the Ipython requirement and the logs warning the user can easily be silenced without them ever knowing.

If you try to dig into the render_graph() method, you'll find the WorkflowGraphWidget and the show() method that generates some HTML object for IPython. In order to get something potentially useful, I checked out the "data" attribute of the HTML that was generated and found a CSS link and a JS script tag and a div with an svg tag. It appears that the widget generates the html containing javascript to generate the definition.

This could be much better. For one, the docs need to be updated to reflect the dependencies.

For actual rendering, you could:
- Use an explicitly imported Python library
- Generate HTML that works outside of IPython
- Add a function in Boto3 to fetch the image URL or bytes
- Add a publicly accessible endpoint that accepts the definition JSON

* [ ] :wave: I may be able to implement this feature request
* [ ] :warning: This feature might incur a breaking change

---

This is a :rocket: Feature Request

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comienza con la documentación de Workflow.render_graph() y las secciones del README enlazadas en el issue; después, inspecciona WorkflowGraphWidget y su método show(). Determina qué limitaciones de IPython, notebooks, JavaScript, CSS y portabilidad deben documentarse o abordarse; se considera terminado cuando los entornos y las dependencias compatibles están especificados explícitamente, o cuando se ha acordado e implementado un enfoque concreto para el renderizado.

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

Evaluación

Stack tecnológico
aws, jupyter, jupyter-notebook, python
Área
cloud, developer-experience, documentation
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
28/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.