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界面
• 在上传文档上的后续问题以进行更多澄清
• 后续编辑请求

贡献

强烈鼓励您分叉存储库，并提出带有新功能的拉动请求

免责声明

这是一个简单的工具，可能无法完全适合所有文档。建议审查输出并进行必要的更改。

享受！