csed_assistant

CSEDスタディアシスタント

イントロ

これは、CSEDの学生が彼らの研究を支援するための簡単なアシスタントです。講義を要約するために使用できるシンプルなコマンドラインツールです

インストール

1. リポジトリをクローンします
2. 次のコマンドを実行して、必要なパッケージをインストールします

pip install -r requirements.txt

3. Gemini APIキーを.envに追加すると、Gemini Studioから無料のAPIキーを入手できます

使用法

• 次のコマンドを実行して、アシスタントを開始します

python summarize.py {path to the lecture file( " lect1.pdf " )}

これにより、MD形式とPDFで要約が行われます。

• 独自の編集をマークダウンファイルに追加して、コマンドを使用してPDFとしてエクスポートできます。

mdpdf -o summary.pdf summary.md

• prompt.txtを編集して、独自のプロンプトを追加できます

テスト

test/

将来の仕事

• ドキュメントのチャットとアップロードのためのWebインターフェイスの追加
• より明確にするために、アップロードされたドキュメントの質問をフォローアップ
• 編集リクエストをフォローアップします

貢献

リポジトリをフォークし、新機能でプルリクエストを行うことを強くお勧めします

免責事項

これはシンプルなツールであり、すべてのドキュメントに完全には機能しない場合があります。出力を確認し、必要な変更を加えることをお勧めします。

楽しむ！