Skip to content

Commit

Permalink
Update parallelism example readme
Browse files Browse the repository at this point in the history
Fix typo, and add new video walkthrough.
  • Loading branch information
skrawcz committed Nov 21, 2024
1 parent 326fa01 commit bb74ac9
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 4 deletions.
4 changes: 2 additions & 2 deletions examples/parallelism/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Parallelism

In this example we go over Burr's parallelism capabilities. It is based on the documentation (https://burr.dagworks.io/pull/370/concepts/parallelism/), demonstrating the `MapStates` capabilities.
In this example we go over Burr's parallelism capabilities. It is based on the documentation (https://burr.dagworks.io/concepts/parallelism/), demonstrating the `MapStates` capabilities.

See [the notebook](./notebook.ipynb) for the full example. Or <a target="_blank" href="https://colab.research.google.com/github/dagworks-inc/burr/blob/main/examples/parallelism/notebook.ipynb">
<img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
</a>

You can follow along with this [Loom video](https://www.loom.com/share/a871abe84f974a499d7fb5bae42c35ae)
You can follow along with this [youtube video](https://youtu.be/G7lw63IBSmY)
16 changes: 14 additions & 2 deletions examples/parallelism/notebook.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
"<a target=\"_blank\" href=\"https://colab.research.google.com/github/dagworks-inc/burr/blob/main/examples/parallelism/notebook.ipynb\">\n",
" <img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/>\n",
"</a> \n",
"or <a target=\"_blank\" href=\"https://www.github.com/dagworks-inc/burr/tree/main/examples/parallelism/notebook.ipynb\">view source</a>"
"or <a target=\"_blank\" href=\"https://www.github.com/dagworks-inc/burr/tree/main/examples/parallelism/notebook.ipynb\">view source</a>\n",
"\n",
"For a video walkthrough of this notebook <a href=\"https://youtu.be/G7lw63IBSmY\">click here</a>."
]
},
{
Expand Down Expand Up @@ -128,10 +130,20 @@
"source": [
"# if in google collab we need to expose the port\n",
"from google.colab import output\n",
"# output.serve_kernel_port_as_iframe(7241) # can expose as an iframe directly\n",
"output.serve_kernel_port_as_window(7241) # can expose as a new tab -- take note of the URL and provide it below."
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "f3e74f3e-db80-436c-ac67-10078e7965de",
"metadata": {},
"outputs": [],
"source": [
"# can expose as an iframe directly\n",
"output.serve_kernel_port_as_iframe(7241) "
]
},
{
"cell_type": "code",
"execution_count": 79,
Expand Down

0 comments on commit bb74ac9

Please sign in to comment.