https://github.com/minusxai/smart-nbconvert

Create an automated report from a notebook
https://github.com/minusxai/smart-nbconvert

Last synced: about 1 month ago
JSON representation

Create an automated report from a notebook

• Host: GitHub
• URL: https://github.com/minusxai/smart-nbconvert
• Owner: minusxai
• License: mit
• Created: 2024-11-10T02:34:11.000Z (about 2 months ago)
• Default Branch: master
• Last Pushed: 2024-11-10T03:07:26.000Z (about 2 months ago)
• Last Synced: 2024-11-10T03:25:38.413Z (about 2 months ago)
• Language: Python
• Size: 0 Bytes
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# smart-nbconvert

smart-nbconvert is a tool for automatically generating detailed reports from Jupyter Notebooks with the help of LLMs. This python script processes the notebook, notebook, extracts key content, and converts it into a structured markdown report. It also handles inline images, etc.

## Installation

```bash

pip install -r requirements.txt

```

## Usage

```bash

# export your openai key if you haven't already

export OPENAI_API_KEY="your_openai_api_key"

# simple usage

python smart_nbconvert.py --notebook examples/anthropic_analysis.ipynb

# more controls

python smart_nbconvert.py \

  --notebook examples/anthropic_analysis.ipynb \

  --model gpt-4o \

  --instructions "How to reduce latency" \

  --output report.md

```

## Example input/output

![example](./examples/example.png)

## License

MIT License