Skip to main content

The Bridge from Thoughts to Well-Crafted Jupyter Notebook

Project description

🚀 Notebook Copilot: From Thoughts to Well-Crafted Code at Record-Speed.

Welcome to Notebook Copilot, your next-generation tool for Jupyter Notebooks. Inspired by GitHub Copilot, Notebook Copilot is designed to help engineers and data scientists in developing professional, high-quality notebooks. It's like having your personal AI-powered assistant that helps you navigate through the Jupyter universe, seamlessly generating code and markdown cells based on your inputs.

Imagine not having to start with a blank notebook every time. Sounds dreamy, right?

Demo

<iframe src="https://www.loom.com/embed/d347052d3403412083cf4ea75b2e2cd4" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>

Key Features

  • %copilot magic function: Continues the notebook for you, generating professional code and markdown cells, making blank notebooks a thing of the past.
  • %generate magic function: Utilizes AI to generate the next cell from your comments. Just give it a hint, and it'll do the heavy lifting for you.
  • %explain magic function: Produces a markdown cell that elaborates the functionality of the current cell. Don't just write code, understand it thoroughly!

Installation

You can install Notebook Copilot directly from PyPI:

pip install notebook_copilot

Usage

Load the Notebook Copilot extension in your Jupyter notebook:

%load_ext notebook_copilot

Now you're ready to use the magic functions:

# Enter Assistant Mode, will continue the notebook for you
%copilot
# Generate the next cell code
%%generate plot the confusion matrix using for the model
# Explain the current cell
%%explain
# some code…

Roadmap

  • Copilot Magic Function: Continues the notebook for you, generating professional code and markdown cells, making blank notebooks a thing of the past.
  • Generate Magic Function: Turn Your Comments into Code
  • Explain Magic Function: Generate Markdown Cells that Explain Your Code
  • Update underlying strategy to ToT
  • AI-Powered Code completion inside cells

Contributing

We appreciate all contributions. If you're planning to contribute back bug-fixes, please do so without any further discussion. If you plan to contribute new features, utility functions, or extensions to the core, please first open an issue and discuss the feature with us.

License

Notebook Copilot is MIT licensed, as found in the LICENSE file.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

notebook_copilot-0.1.1.tar.gz (8.9 kB view hashes)

Uploaded Source

Built Distribution

notebook_copilot-0.1.1-py3-none-any.whl (9.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page