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進行摘要。

• 您可以將自己的編輯添加到Markdown文件中，並使用命令將其作為PDF導出：

mdpdf -o summary.pdf summary.md

• 您可以通過編輯prompt.txt添加自己的提示

測試

您可以在test/

未來的工作

• 添加用於聊天和上傳文檔的Web界面
• 在上傳文檔上的後續問題以進行更多澄清
• 後續編輯請求

貢獻

強烈鼓勵您分叉存儲庫，並提出帶有新功能的拉動請求

免責聲明

這是一個簡單的工具，可能無法完全適合所有文檔。建議審查輸出並進行必要的更改。

享受！