From 792b27c771a310d66ba7c295b75436a2dd58eff1 Mon Sep 17 00:00:00 2001 From: Mecoli1219 Date: Mon, 28 Oct 2024 00:07:57 -0700 Subject: [PATCH] Update readme Signed-off-by: Mecoli1219 --- examples/jupyter_notebook_basics/README.md | 24 +++++++++++++++++-- ...yter_notebook_basics.ipynb => basic.ipynb} | 2 +- 2 files changed, 23 insertions(+), 3 deletions(-) rename examples/jupyter_notebook_basics/jupyter_notebook_basics/{jupyter_notebook_basics.ipynb => basic.ipynb} (99%) diff --git a/examples/jupyter_notebook_basics/README.md b/examples/jupyter_notebook_basics/README.md index 10c222fa5..a164a5bbb 100644 --- a/examples/jupyter_notebook_basics/README.md +++ b/examples/jupyter_notebook_basics/README.md @@ -1,4 +1,24 @@ +(interactive-mode)= + # Jupyter Notebook Basic Development Guide -This guide will help you to understand the basics of how to develop Flyte tasks and workflows in Jupyter Notebook. -Please follow the instructions in the [Jupyter Notebook](jupyter_notebook_basics.ipynb) to understand the basics of Flyte development in Jupyter Notebook. +```{eval-rst} +.. tags:: Integration, Jupyter +``` + +```{image} https://img.shields.io/badge/Blog-Interactive-blue?style=for-the-badge +:target: https://hackmd.io/@1E0FEh2MS_OpXGUAjEFIOQ/ByTTT821Jl +:alt: Interactive Mode for Jupyter Notebook Blog Post +``` + +Jupyter Notebooks revolutionize workflow development by combining code execution, documentation, and visualization in one interactive environment. Through Flyte's integration, you can develop and test your workflows remotely while maintaining production-ready scalability—eliminating the gap between development and deployment. + +## How to Use the Interactive Mode? + +Interactive mode is a feature included in [FlyteRemote](https://docs.flyte.org/en/latest/api/flytekit/design/control_plane.html) aiming at supporting entities (tasks, workflows, launch plans, etc.) registration and execution within interactive environment like Jupyter Notebook. To use the interactive mode, you just need to create a FlyteRemote object with `interactive_mode_enabled=True` to interact with Flyte backend. Then you are free to go! + +For detailed examples and usage patterns, refer to the following guide: + +```{auto-examples-toc} +basic +``` diff --git a/examples/jupyter_notebook_basics/jupyter_notebook_basics/jupyter_notebook_basics.ipynb b/examples/jupyter_notebook_basics/jupyter_notebook_basics/basic.ipynb similarity index 99% rename from examples/jupyter_notebook_basics/jupyter_notebook_basics/jupyter_notebook_basics.ipynb rename to examples/jupyter_notebook_basics/jupyter_notebook_basics/basic.ipynb index 02097ea25..8a6d89e26 100644 --- a/examples/jupyter_notebook_basics/jupyter_notebook_basics/jupyter_notebook_basics.ipynb +++ b/examples/jupyter_notebook_basics/jupyter_notebook_basics/basic.ipynb @@ -4,7 +4,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "# How to Develop and Run the Tasks and Workflows Remotely via Jupiter Notebook" + "# Basic Interactive Mode Usage in Jupyter Notebook Environment" ] }, {