Skip to content

A VSCode extension that leverages Gemini AI to analyze and explain errors in Jupyter notebooks, helping beginners debug with ease.

License

Notifications You must be signed in to change notification settings

IDKNWHORU/jupyter-gemini-assistant

Repository files navigation

Jupyter Gemini Assistant

This extension requires VS Code version 1.89.0 or higher to install and use.

한국어 문서를 선호하신 다면 이 문서를 확인해보세요

An assistant designed to help beginners easily understand and resolve errors occurring in Jupyter notebook (.ipynb) files.

Features

  • Provides insights into the cause of errors occurring in Jupyter notebooks
  • Suggests solutions for resolving errors
  • Supports multiple languages (English and Korean)
  • Displays error analysis results in a side panel

Error Analyse Button Click Show Analyse Result

How to Use

  1. Run your code in a Jupyter Notebook.
  2. If an error occurs, click the analyse button that appears in the cell.
  3. The Gemini Assistant will analyze the error and suggest solutions.
  4. View the detailed analysis results in the side panel.

Installation

To install the Jupyter Gemini Assistant:

  1. Open Visual Studio Code.
  2. Go to the Extensions view by clicking on the square icon in the left sidebar or pressing Ctrl+Shift+X.
  3. Search for "Jupyter Gemini Assistant" in the Extensions view search box.
  4. Click on the "Install" button next to the Jupyter Gemini Assistant extension.
  5. Once installed, you may need to reload VS Code to activate the extension.

Here's a visual guide to help you find the extension:

VSCode Extension Installation

Configuration

You can configure the language used by the Jupyter Gemini Assistant:

  1. Open VS Code settings (File > Preferences > Settings).
  2. Search for "Jupyter Gemini Assistant".
  3. Choose your preferred language (English or Korean) from the dropdown menu.

Alternatively, you can use the command:

  1. Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P on macOS).
  2. Type "Select Language for Jupyter Gemini assistant" and select it.
  3. Choose your preferred language from the options presented.

Gemini Server

This extension utilizes the gemini-server for error analysis and solution suggestions. The gemini-server acts as an intermediary, facilitating communication between the Jupyter environment and the Google Gemini Pro API, enabling the assistant to provide intelligent and helpful insights.

Release Notes

For detailed changes, please refer to the CHANGELOG.md file.

Contributing

While we don't have a formal contribution process at the moment, we welcome any suggestions or feedback. If you have ideas for improvements or encounter any issues, please feel free to open an issue in the GitHub repository.

License

This project is licensed under the MIT License. See the LICENSE file in the project root for the full license text.

About

A VSCode extension that leverages Gemini AI to analyze and explain errors in Jupyter notebooks, helping beginners debug with ease.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published