AnkiAIUtils 项目使用教程

AnkiAIUtils 项目使用教程

AnkiAIUtils AI-powered tools to enhance Anki flashcards with explanations, mnemonics, illustrations, and adaptive learning for medical school and beyond 项目地址: https://gitcode.com/gh_mirrors/an/AnkiAIUtils

1. 项目的目录结构及介绍

AnkiAIUtils 项目是一个为 Anki 闪卡增加智能功能的开源项目，其目录结构如下：

AnkiAIUtils/
├── examples/               # 示例文件目录
├── screenshots/            # 屏幕截图目录
├── utils/                  # 工具脚本目录
├── .gitignore              # Git 忽略文件
├── LICENSE                 # 项目许可证文件
├── README.md               # 项目说明文件
├── anchors_to_anki.py      # 将锚点转换为 Anki 闪卡的脚本
├── explainer.py            # 生成解释的脚本
├── illustrator.py          # 生成图像的脚本
├── mnemonics_creator.py    # 创建助记符的脚本
├── mnemonics_helper.py     # 助记符辅助脚本
├── reformulator.py         # 重新表述闪卡的脚本
└── requirements.txt        # 项目依赖文件

• examples/：包含项目使用的示例文件。
• screenshots/：包含项目的屏幕截图，用于展示功能效果。
• utils/：包含项目依赖的各种工具脚本。
• .gitignore：指定 Git 忽略的文件和目录。
• LICENSE：项目的许可证信息，本项目采用 GPL-3.0 许可。
• README.md：项目的说明文档，介绍项目的功能和用法。
• 其他 .py 文件：项目的核心脚本，实现各项功能。

2. 项目的启动文件介绍

AnkiAIUtils 项目没有特定的启动文件，而是通过各个功能脚本来执行相应的任务。以下是几个主要脚本的简要介绍：

• anchors_to_anki.py：此脚本用于将锚点转换为 Anki 闪卡，是项目中的主要功能之一。
• explainer.py：此脚本用于为 Anki 闪卡生成解释文本。
• illustrator.py：此脚本用于为 Anki 闪卡生成图像，帮助记忆。
• mnemonics_creator.py：此脚本用于创建助记符，增强记忆效果。
• reformulator.py：此脚本用于重新表述闪卡内容，使其更加清晰易懂。

使用这些脚本之前，需要确保已经安装了项目依赖的 Python 库，具体见 requirements.txt 文件。

3. 项目的配置文件介绍

AnkiAIUtils 项目没有专门的配置文件。项目的运行依赖于环境变量和命令行参数。用户需要根据自己的需求设置环境变量，例如指定模型和图像生成相关的设置。

在运行脚本之前，用户可能需要在命令行中设置相应的环境变量，例如：

export LLMMODEL="openai/gpt-4-0125-preview"
export IMAGEMODEL="openai/dall-e-3"

这些环境变量指定了要使用的语言模型和图像模型。具体的设置取决于用户的实际需求和可用的模型。

AnkiAIUtils AI-powered tools to enhance Anki flashcards with explanations, mnemonics, illustrations, and adaptive learning for medical school and beyond 项目地址: https://gitcode.com/gh_mirrors/an/AnkiAIUtils