phildockerphil/annomathtex

AnnoMathTeX 镜像文档

概述和主要用途

AnnoMathTeX是一个独立的基于Web的LaTeX文本和公式注释推荐工具，专为STEM（科学、技术、工程、数学）文档设计，采用Python Django框架实现。它允许用户为数学公式中包含的标识符（如常量和变量）以及整个公式添加语义注释，并从推荐列表中选择可能的概念名称。该工具旨在解决当前STEM领域缺乏带语义标注的数学公式数据集的问题，通过提供推荐功能简化注释过程，帮助创建用于训练机器学习模型的标注数据集。

核心功能和特性

注释对象

• 标识符：数学公式中符号的含义（如公式E=mc²中的"E"表示"能量"）
• 公式概念：整个公式的名称或语义（如公式E=mc²可标注为"质能等价"）

推荐来源

推荐建议来自四个主要来源，按出现频率排序：

• arXiv：arXiv语料库中围绕标识符出现的文本
• *****：数学*文章中围绕标识符的文本
• Wikidata：通过Wikidata Query Services API检索的匹配项
• Word Window：标注文档中公式周围文本的名词和专有名词（利用上下文解释公式及其组成部分）

核心特性

• 全局/局部注释：全局注释自动应用于文档中所有相同标识符，局部注释仅应用于当前出现的标识符
• 注释保存与重载：支持保存注释到JSON文件，重新打开文件时自动加载先前注释
• 实时注释表格：顶部实时更新的表格显示所有已做注释
• 评估文件生成：保存时生成CSV评估表，记录所选概念的来源及推荐位置
• 手动输入：若推荐项不匹配，支持手动输入注释内容
• 高亮反馈：已注释的标识符显示为绿色，推荐表格中选中项高亮

使用场景和适用范围

• STEM文档标注：适用于科学论文、教材、技术报告等包含数学公式的文档
• 数据集创建：帮助研究者构建带语义标注的数学公式数据集
• 机器学习训练：生成的标注数据可用于训练数学符号识别、公式推荐等机器学习模型
• 教育与研究：辅助学生和研究人员理解和标注数学公式的语义

使用方法和配置说明

前提条件

• Python版本 ≥3.6
• 已安装Git（用于克隆仓库）

本地安装与运行步骤

1. 克隆仓库

bash
git clone https://github.com/philsMINT/AnnoMathTeX.git
cd AnnoMathTeX

2. 创建并激活虚拟环境

bash
# 创建虚拟环境
python -m venv venv

# 激活虚拟环境（Windows）
venv\Scripts\activate

# 激活虚拟环境（Linux/macOS）
source venv/bin/activate

3. 安装依赖

bash
pip install -r requirements.txt

4. 启动服务器

bash
cd annomathtex  # 导航到包含manage.py的目录
python manage.py runserver

5. 访问应用

打开浏览器，访问 http://localhost:8000

标注操作流程

上传文件

1. 在浏览器中点击文件浏览器选择要标注的文件（支持.tex或.txt格式）
2. 上传后，文档将被处理并渲染，数学环境用高亮***符号包围，可标注的标识符会被高亮显示

标注标识符

1. 点击文档中高亮的标识符（如"E"），弹出推荐表格
2. 从推荐列表中选择合适的概念名称（点击对应单元格），选中项会高亮
3. 已标注的标识符显示为绿色，顶部注释表格实时更新
4. 若无可选推荐，可在表格中手动输入名称

选择注释类型

• 全局注释（默认）：所有相同标识符自动应用此注释
• 局部注释：点击表格顶部的"local"选项，仅当前标识符应用此注释

保存注释

1. 点击页面左上角的"save"按钮
2. 注释将保存到JSON文件，同时生成CSV评估文件（记录推荐来源及位置）
3. 重新打开同一文件时，先前的注释会自动加载

评估文件说明

评估文件为CSV格式，记录每个注释的详细信息，示例如下：

• Identifier：被标注的标识符
• Name：标注的概念名称（"manual insertion"表示手动输入）
• arXiv/*/Wikidata/WordWindow**：对应来源中推荐的位置（"-"表示未在该来源中找到）
• Type：注释类型（global或local）

许可证

本项目采用Apache License 2.0许可证。

作者

• Ian Mackerracher
• Philipp Scharpf

更多贡献者参见项目https://github.com/philsMINT/AnnoMathTeX/contributors%E3%80%82

致谢

感谢Wikimedia提供Web系统托管。