Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
Signed-off-by: Mecoli1219 <[email protected]>
  • Loading branch information
Mecoli1219 committed Oct 28, 2024
1 parent 712019d commit 792b27c
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 3 deletions.
24 changes: 22 additions & 2 deletions examples/jupyter_notebook_basics/README.md
Original file line number Diff line number Diff line change
@@ -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
```
Original file line number Diff line number Diff line change
Expand Up @@ -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"
]
},
{
Expand Down

0 comments on commit 792b27c

Please sign in to comment.