Render notebooks within Discourse when linked to GitHub

SimonBiggs · June 14, 2023, 1:26am

Hi,

Over on the Discourse Meta forum there is a discussion around rendering Jupyter Notebooks when they are linked to on GitHub:

As you can see, for the time being, when a GitHub link is provided the current one-box in Discourse displays the JSON:

github.com

openai/openai-cookbook/blob/41a5d394ca355e276ba21290696116c33f55ad9f/examples/How_to_call_functions_with_chat_models.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "3e67f200",
   "metadata": {},
   "source": [
    "# How to call functions with chat models\n",
    "\n",
    "This notebook covers how to use the Chat Completions API in combination with external functions to extend the capabilities of GPT models.\n",
    "\n",
    "## How to use functions\n",
    "\n",
    "`functions` is an optional parameter in the ChatCompletion API which can be used to provide function specifications. The purpose of this is to enable models to generate outputs which adhere to function input schemas. Note that the API will not actually execute any function calls. It is up to developers to execute function calls using model outputs.\n",
    "\n",
    "If the `functions` parameter is provided then by default the model will decide when it is appropriate to use one of the functions. The API can also be forced to use a specific function by setting the `function_call` parameter to `{\"name\": \"<insert-function-name>\"}`. If a function is used, the output will contain `\"finish_reason\": \"function_call\"` in the response, as well as a `function_call` object that has the name of the function and the generated function arguments.\n",
    "\n",
    "Functions are specified with the following fields:\n",
    "\n",
    "- **Name:** The name of the function.\n",

This file has been truncated. show original

Might there be an option to have a Jupyter Discourse plugin?

Cheers,
Simon

fomightez · June 14, 2023, 3:52am

Looks like the way MyBinder launches render the preview using nbviewer would be a good guide good for this. This below is the pertinent code from the source of the page you get if you go to https://github.com/binder-examples/conda and hit ‘launch binder’ and then scroll down on the page:

<div id="nbviewer-preview">
  <iframe src="https://nbviewer.jupyter.org/github/binder-examples/conda_environment/blob/HEAD/index.ipynb"></iframe>
</div>

You’ll see that URL (https://nbviewer.jupyter.org/github/binder-examples/conda_environment/blob/HEAD/index.ipynb) just points nbviewer’s renderer at the GitHub source for the notebook json code. The nbviewer render experience is more full-featured in several ways than the one in use by GitHub, even though GitHub’s support has continued to improve even as recent as last November.

That corresponding iframe will show up on the launch page right below the text that says “Here’s a non-interactive preview on nbviewer while we start a server for you. Your binder will open automatically when it is ready.” The top part of that iframe is featured in the bottom of the following image.

Launches were happening too fast for me to get a great screenshot of the notebook iframe fully.
I got a bad shot of a middle of it, too:

Applying that…

It looks like the trello example is using iframes and so I think it would be just a matter of plugging into that as a guide to point to the nbviewer render?

Topic		Replies	Views
Incorrect rendering on GitHub of <details> HTML tags inside Jupyter notebooks JupyterLab help-wanted	0	473	December 2, 2021
Feature Idea: A specification for notebook output dependencies Notebook feature-idea	18	1382	August 12, 2021
Editor text not being saved in notebook model JupyterLab jupyterlab , how-to , help-wanted	0	262	March 28, 2023
Integrating IPython context with Large Language Models Special Topics ipython	0	563	March 16, 2023
JupyterLab Github Output JupyterLab how-to , help-wanted	2	818	March 28, 2022

Render notebooks within Discourse when linked to GitHub

Applying that…

Related Topics