Skip to content

Commit 72f6af4

Browse files
committed
add example image
1 parent f0616ef commit 72f6af4

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# smart-nbconvert
2-
smart-nbconvert is a tool for automatically generating reports from Jupyter Notebooks. This python script processes notebooks, extracts key content, and converts it into a structured markdown report. It also handles inline images, etc.
2+
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.
33

44

55
## Installation
@@ -23,5 +23,8 @@ python smart_nbconvert.py \
2323
--output report.md
2424
```
2525

26+
## Example input/output
27+
![example](./examples/example.png)
28+
2629
## License
2730
MIT License

examples/example.png

873 KB
Loading

0 commit comments

Comments
 (0)