访问官网
Github
Huggingface
文档
论文
Annif是一个自动主题索引工具包。它最初是作为一个统计自动索引工具创建的，使用Finna.fi发现界面的元数据作为训练语料库。
这个仓库包含了基于原型重写的Annif生产版本。 Finto AI 是一项基于 Annif 的服务；请查看 Finto AI 的源代码和包含 Finto AI 使用的模型的 🤗 Hugging Face Hub 集合。
基本安装
Annif 在 Linux 上开发和测试。如果您想在 Windows 或 Mac OS 上运行 Annif，推荐的方法是使用 Docker（见下文）或 Linux 虚拟机。
您需要 Python 3.9-3.12 来安装 Annif。
推荐的方法是从 PyPI 将 Annif 安装到虚拟环境中。
python3 -m venv annif-venv
source annif-venv/bin/activate
pip install annif
您还需要 NLTK 数据文件：
python -m nltk.downloader punkt
启动应用程序：
annif
更多详细信息请参阅 wiki 中的入门指南。
Shell 补全
Annif 支持在 bash、zsh 和 fish shell 中使用 Tab 键补全命令、选项、项目 ID、词汇表 ID 和路径参数。
要在当前终端会话中启用补全支持，请使用 annif completion 命令，并根据您的 shell 选择相应的选项来生成补全脚本并执行它。例如，运行：
source <(annif completion --bash)
要在所有新会话中启用补全支持，首先在您的主目录中添加补全脚本：
annif completion --bash > ~/.annif-complete.bash
然后通过在 ~/.bashrc 文件（或某些替代启动文件）中添加以下内容，使脚本在新终端会话中自动执行：
source ~/.annif-complete.bash
有关其他 shell 的详细信息和用法，请参阅 Click 文档。
Docker 安装
您可以使用来自 quay.io/natlibfi/annif 仓库的预构建 Docker 容器镜像来使用 Annif。详情请参阅 wiki 文档。
开发安装
可以通过克隆 GitHub 仓库 来安装 Annif 的开发版本。 Poetry 用于管理开发版本的依赖项和虚拟环境。
有关参与 Annif 开发时有用的单元测试、代码风格、开发流程等信息，请参阅 CONTRIBUTING.md。
安装和设置
克隆仓库。
切换到仓库目录。
如果您还没有安装 pipx 和 Poetry，请先安装它们。首先安装 pipx：
python3 -m pip install --user pipx
python3 -m pipx ensurepath
打开一个新的 shell，然后安装 Poetry：
pipx install poetry
也可以不使用 pipx 安装 Poetry：查看 Poetry 文档。
创建虚拟环境并安装依赖项：
poetry install
默认情况下包含开发依赖项。使用 -E 选项安装选定的可选功能的依赖项（多个额外功能使用 -E "extra1 extra2"），或使用 --all-extras 安装所有功能。默认情况下，虚拟环境目录不在项目目录下，但有一个设置可以选择这个选项。
进入虚拟环境：
poetry shell
您还需要 NLTK 数据文件：
python -m nltk.downloader punkt
启动应用程序： annif
在 Codespaces 中进行演示安装
可以在 GitHub Codespaces 中试用 Annif。只需通过下方的徽章打开配置新 codespace 的页面，点击绿色的"创建 codespace"按钮启动 codespace，浏览器中就会启动一个终端会话，其中包含 Annif-tutorial 仓库的内容：
获取帮助
有多种可用资源：
- wiki 中的使用文档
- Annif 教程，用于学习使用 Annif
- annif-users 讨论论坛
- ReadTheDocs 上的内部 API 文档
- annif.org 项目网站
出版物 / 如何引用
以下是一些发表在同行评审开放获取期刊上的关于 Annif 的文章。软件本身也已存档在 Zenodo 上，并有一个可引用的 DOI。
引用软件本身
参见仓库详情中的"引用此仓库"。
Annif 相关文章
-
Golub, K.; Suominen, O.; Mohammed, A.; Aagaard, H.; Osterman, O, 2024.
使用 Annif 软件对瑞典图书馆元数据进行自动杜威十进制分类。
Journal of Documentation, 即将出版。
https://doi.org/10.1108/JD-01-2022-0026
查看 BibTex
@article{golub2024annif, title={Automated Dewey Decimal Classification of Swedish library metadata using Annif software}, author={Golub, Koraljka and Suominen, Osma and Mohammed, Ahmed Taiye and Aagaard, Harriet and Osterman, Olof}, journal={J. Doc.}, year={in press}, doi = {10.1108/JD-01-2022-0026}, url={https://www.emerald.com/insight/content/doi/10.1108/JD-01-2022-0026}, } -
Suominen, O.; Inkinen, J.; Lehtinen, M., 2022.
Annif 和 Finto AI：自动主题索引的开发与实施。
JLIS.It, 13(1), 第 265–282 页。URL：
https://www.jlis.it/index.php/jlis/article/view/437
查看 BibTex
@article{suominen2022annif, title={Annif and Finto AI: Developing and Implementing Automated Subject Indexing}, author={Suominen, Osma and Inkinen, Juho and Lehtinen, Mona}, journal={JLIS.it}, volume={13}, number={1}, pages={265--282}, year={2022}, doi = {10.4403/jlis.it-12740}, url={https://www.jlis.it/index.php/jlis/article/view/437}, } -
Suominen, O.; Koskenniemi, I, 2022.
Annif 分析器对决：比较用于自动主题索引的文本词形还原方法。
Code4Lib Journal, (54)。URL：
https://journal.code4lib.org/articles/16719
查看 BibTex
@article{suominen2022analyzer, title={Annif分析器对比：比较用于自动主题标引的文本词形还原方法}, author={Suominen, Osma 和 Koskenniemi, Ilkka}, journal={Code4Lib J.}, number={54}, year={2022}, url={https://journal.code4lib.org/articles/16719}, } -
Suominen, O., 2019. Annif：使用多种算法的DIY自动主题标引。LIBER Quarterly, 29(1), 第1-25页。DOI：
https://doi.org/10.18352/lq.10285
查看BibTex
@article{suominen2019annif, title={Annif：使用多种算法的DIY自动主题标引}, author={Suominen, Osma}, journal={{LIBER} Quarterly}, volume={29}, number={1}, pages={1--25}, year={2019}, doi = {10.18352/lq.10285}, url = {https://doi.org/10.18352/lq.10285} }
许可证
本仓库中的代码采用Apache许可证2.0版授权，除了包含在annif/static/css和annif/static/js下的依赖项，它们有自己的许可证，详见文件头部。
请注意，YAKE库采用GPLv3许可，而Annif采用Apache许可证2.0版。这些许可证是兼容的，但根据法律解释，GPLv3的条款（例如在发布可执行应用程序时需要公布相应源代码的要求）可能会被认为适用于整个Annif+Yake，如果您决定安装可选的Yake依赖项。
