Apppublic

MakiAi/NotebookForgeDemo

sourceHugging Facemitupdated 2y agoView on Hugging Face

1likes

App README

<p align="center"> <img src="https://raw.githubusercontent.com/Sunwood-ai-labs/NotebookForgeBeta/main/docs/NotebookForge_icon.jpg" width="100%"> <br> <h1 align="center">NotebookForge</h1> <h3 align="center">～Markdown to Jupyter Notebook Converter～

![Hugging Face Spaces](https://huggingface.co/spaces/MakiAi/NotebookForgeDemo) ![GitHub Stars](https://github.com/Sunwood-ai-labs/NotebookForgeBeta) ![GitHub Last Commit](https://github.com/Sunwood-ai-labs/NotebookForgeBeta) ![GitHub Top Language](https://github.com/Sunwood-ai-labs/NotebookForgeBeta) ![GitHub Release](https://github.com/Sunwood-ai-labs/NotebookForgeBeta) ![GitHub Tag](https://github.com/Sunwood-ai-labs/NotebookForgeBeta)

</h3> </p>

Introduction

NotebookForgeは、マークダウンファイルをJupyter Notebookに変換するPythonツールです。主な特徴と利点は以下の通りです。

—マークダウンファイル内のPythonコードブロックを適切なセルタイプ（コードセルまたはマークダウンセル）に自動変換
—通常のテキストはマークダウンセルに変換
—生成されたNotebookは指定された出力ファイルに保存
—シンプルで使いやすいインターフェース

NotebookForgeを使用することで、マークダウンファイルで書かれたドキュメントやチュートリアルを簡単にJupyter Notebook形式に変換できます。これにより、対話的な実行環境を提供しつつ、マークダウンの読みやすさと書きやすさを維持できます。

このリポジトリはSourceSageを活用しており、リリースノートやREADME、コミットメッセージの9割はSourceSage ＋ claude.aiで生成しています。

Demo

![Hugging Face Spaces](https://huggingface.co/spaces/MakiAi/NotebookForgeDemo)

NotebookForgeの使用例として、Cohere APIのClassifyエンドポイントについての解説をマークダウンで書き、Jupyter Notebookに変換しました。

—example/example01.md: 変換元のマークダウンファイル
—example/example01.ipynb: 変換後のJupyter Notebookファイル

このようにNotebookForgeを使うことで、APIドキュメントやチュートリアルを対話的なNotebook形式で提供できます。

Updates

—[2024/04/17] NotebookForge v2.0.0
—Markdownファイルから Jupyter Notebookを生成する機能を大幅に改善

—[2024/04/11] NotebookForge v1.0.0
—Streamlitベースのウェブアプリを実装
—ユーザーフレンドリーなGUIでマークダウンからノートブックへの変換を実行可能に
—生成されたノートブックをダウンロードする機能を追加
—Hugging Faceでのデモアプリをリリース
—NotebookForgeDemoにてアプリを公開
—ノートブック生成ロジックの最適化
—ドキュメントの拡充
—マークダウン解析時のバグを修正

—[2024/04/10] NotebookForge v0.2.0
—Cohere APIのClassifyエンドポイントについての解説をサンプルに追加
—READMEファイルを追加し、プロジェクトの概要とツールの使い方を記載
—exampleディレクトリを新設し、サンプルファイルを整理
—サンプルコードのインデントを修正し可読性を向上

Getting Started

インストール

NotebookForgeを使用するには、Python 3.11以上が必要です。以下のコマンドでNotebookForge用のConda環境を作成し、アクティベートします。

bash

conda create -n notebook-forge python=3.11
conda activate notebook-forge

使用方法

1.コードブロックを含むマークダウンファイルを用意します。（例: example/example01.md）

1.以下のコマンドを実行し、マークダウンファイルをJupyter Notebookに変換します。

bash

   python create_jupyter_notebook.py

1.変換後のNotebookファイルが生成されます。（例: example/example01.ipynb）

カスタマイズ

create_jupyter_notebook.pyスクリプトの以下の部分を変更することで、入出力ファイルのパスをカスタマイズできます。

python

markdown_file = 'example/example01.md'
output_file = 'example/example01.ipynb'
create_jupyter_notebook(markdown_file, output_file)

Contributing

NotebookForgeへの貢献を歓迎します。バグ報告、機能要望、プルリクエストをお待ちしております。

License

NotebookForgeはMITライセンスの下で公開されています。詳細はLICENSEファイルを参照してください。

Acknowledgements

NotebookForgeの開発にあたり、以下のオープンソースプロジェクトを参考にさせていただきました。

—Jupyter Notebook
—nbformat