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

render_graph() has hidden dependencies

Aperta
#189 1 commento 3 reazioni 0 assegnatari Vedi su GitHub
bug
Lingua principale
Python
Stelle
299
Fork
84
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia dalla documentazione di Workflow.render_graph() e dalle sezioni del README collegate nell’issue, poi esamina WorkflowGraphWidget e il suo metodo show(). Determina quali limitazioni relative a IPython, notebook, JavaScript, CSS e portabilità debbano essere documentate o affrontate; il lavoro è completato quando gli ambienti supportati e le dipendenze sono esplicitati, oppure quando è stato concordato e implementato un approccio concreto al rendering.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
aws, jupyter, jupyter-notebook, python
Ambito
cloud, developer-experience, documentation
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
28/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.