Package: gpt-jupyterlab
gpt_jupyterlabA JupyterLab extension.GPT JupterLab is a JupyterLab extension to use OpenAI’s GPT models for text and code completion on your notebook cells.This extension passes your current notebook cell to the GPT API and completes your code/text for you. You can customize the GPT parameters in the Advanced Settings menu.This extension is composed of a Python package namedgpt_jupyterlabfor the server extension and a NPM package namedgpt_jupyterlabfor the frontend extension.Note: You will need your own OpenAI API Key to use this extension. You can get them in theAPI Key page, which requires an OpenAI account.https://user-images.githubusercontent.com/1387307/214353795-d867d9d1-caee-4494-a2ee-14d5f12005e7.mp4InstallTo install the extension, execute:pipinstallgpt_jupyterlabIt should now appear on your installed extensions list.Note: Make sure that you have enabled extensions. You may also need to restart the server(not the kernel) to make sure that it runs properly.Installing in GCP Vertex Workbench1. Create new notebook2. Runpip install gpt_jupyterlab3. Enable extensionsYou should seegpt_jupyterlabinstalled, but you need to restart the server to make4. Restart the notebookStop the notebookStart the notebookYou should be able to see the GPT button and be able to make queries.UninstallTo remove the extension, execute:pipuninstallgpt_jupyterlabGetting StartedThere are three ways to prompt the GPT API.1. Use the GPT Button in the Toolbar2. ClickGPT Completionunder theEditMenu3. Use theCtrl+Space(Windows)/Cmd+Space(Mac) Keyboard ShortcutHow to Change Your SettingsGo to theSettingsMenu and clickAdvanced Settings EditorClickgpt_jupyterlabin the left sidebarTroubleshootIf you are seeing the frontend extension, but it is not working, check
that the server extension is enabled:jupyterserverextensionlistIf the server extension is installed and enabled, but you are not seeing
the frontend extension, check the frontend extension is installed:jupyterlabextensionlistContributingDevelopment installNote: You will need NodeJS to build the extension package.Thejlpmcommand is JupyterLab's pinned version ofyarnthat is installed with JupyterLab. You may useyarnornpmin lieu ofjlpmbelow.# Clone the repo to your local environment# Change directory to the gpt_jupyterlab directory# Install package in development modepipinstall-e".[test]"# Link your development version of the extension with JupyterLabjupyterlabextensiondevelop.--overwrite# Server extension must be manually installed in develop modejupyterserverextensionenablegpt_jupyterlab# Rebuild extension Typescript source after making changesjlpmbuildYou can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.# Watch the source directory in one terminal, automatically rebuilding when neededjlpmwatch# Run JupyterLab in another terminaljupyterlabWith the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).By default, thejlpm buildcommand generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:jupyterlabbuild--minimize=FalseDevelopment uninstall# Server extension must be manually disabled in develop modejupyterserverextensiondisablegpt_jupyterlab
pipuninstallgpt_jupyterlabIn development mode, you will also need to remove the symlink created byjupyter labextension developcommand. To find its location, you can runjupyter labextension listto figure out where thelabextensionsfolder is located. Then you can remove the symlink namedgpt_jupyterlabwithin that folder.Testing the extensionServer testsThis extension is usingPytestfor Python code testing.Install test dependencies (needed only once):pipinstall-e".[test]"# Each time you install the Python package, you need to restore the front-end extension linkjupyterlabextensiondevelop.--overwriteTo execute them, run:pytest-vv-rap--covgpt_jupyterlabFrontend testsThis extension is usingJestfor JavaScript code testing.To execute them, execute:jlpm
jlpmtestIntegration testsThis extension usesPlaywrightfor the integration tests (aka user level tests).
More precisely, the JupyterLab helperGalatais used to handle testing the extension in JupyterLab.More information are provided within theui-testsREADME.Packaging the extensionSeeRELEASE