pytorch-crf

在 PyTorch <http://pytorch.org/>_ 中的条件随机场。

.. image:: https://img.shields.io/pypi/pyversions/pytorch-crf.svg?style=flat :target: https://img.shields.io/pypi/pyversions/pytorch-crf.svg?style=flat :alt: Python 版本

.. image:: https://img.shields.io/pypi/v/pytorch-crf.svg?style=flat :target: https://pypi.org/project/pytorch-crf :alt: PyPI 项目

.. image:: https://github.com/kmkurn/pytorch-crf/actions/workflows/run_tests.yml/badge.svg :target: https://github.com/kmkurn/pytorch-crf/actions/workflows/run_tests.yml :alt: 构建状态

.. image:: https://img.shields.io/readthedocs/pytorch-crf.svg?style=flat :target: https://pytorch-crf.readthedocs.io :alt: 文档状态

.. image:: https://img.shields.io/coveralls/github/kmkurn/pytorch-crf.svg?style=flat :target: https://coveralls.io/github/kmkurn/pytorch-crf :alt: 代码覆盖率

.. image:: https://img.shields.io/pypi/l/pytorch-crf.svg?style=flat :target: https://choosealicense.com/licenses/mit/ :alt: 许可证

.. image:: https://cdn.rawgit.com/syl20bnr/spacemacs/442d025779da2f62fc86c2082703697714db6514/assets/spacemacs-badge.svg :target: http://spacemacs.org :alt: 使用 Spacemacs 构建

该包在 PyTorch 中提供了线性链式 条件随机场 <https://en.wikipedia.org/wiki/Conditional_random_field>_ (CRF) 的实现。此实现主要借鉴了 AllenNLP CRF 模块 <https://github.com/allenai/allennlp/blob/master/allennlp/modules/conditional_ra ndom_field.py>_，并进行了一些修改。

文档

https://pytorch-crf.readthedocs.io/

许可证

MIT

贡献

欢迎贡献！请按照以下说明安装依赖项，并运行测试和 linter。

安装依赖项

请确保已设置好 Python 虚拟环境。然后，安装 requirements.txt 文件中的所有依赖项，并以开发模式安装本包。

::

pip install -r requirements.txt
pip install -e .

设置 pre-commit 钩子

只需运行：

::

ln -s ../../pre-commit.sh .git/hooks/pre-commit

运行测试

在项目根目录下运行 pytest。

运行 linter

在项目根目录下运行 flake8。由于使用了 flake8-mypy 包，它也会同时运行 mypy。

pytorch-crf 快速上手指南

pytorch-crf 是一个基于 PyTorch 实现的线性链条件随机场（Linear-chain CRF）库，常用于序列标注任务（如命名实体识别、词性标注等）。

环境准备

• 操作系统：Linux, macOS, Windows
• Python 版本：支持 Python 3.x（具体版本参考 PyPI 徽章）
• 前置依赖：
  • PyTorch (http://pytorch.org/)
  • pip 包管理工具

提示：建议先安装好 PyTorch。国内用户可使用清华或阿里镜像加速安装：

pip install torch torchvision torchaudio --index-url https://mirrors.tuna.tsinghua.edu.cn/pypi/web/simple

安装步骤

推荐使用 pip 直接安装发布版：

pip install pytorch-crf

如需使用国内镜像源加速安装：

pip install pytorch-crf -i https://pypi.tuna.tsinghua.edu.cn/simple

若需参与开发或修改源码，可克隆仓库并以开发模式安装：

git clone https://github.com/kmkurn/pytorch-crf.git
cd pytorch-crf
pip install -r requirements.txt
pip install -e .

基本使用

以下是最简单的使用示例，展示如何定义 CRF 层并进行解码：

import torch
from torchcrf import CRF

# 假设批次大小为 2，序列长度为 5，标签类别数为 3
batch_size = 2
seq_length = 5
num_tags = 3

# 初始化 CRF 层
crf = CRF(num_tags)

# 模拟发射分数 (emissions): [batch_size, seq_length, num_tags]
emissions = torch.randn(batch_size, seq_length, num_tags)

# 模拟真实标签 (tags): [batch_size, seq_length]
tags = torch.randint(0, num_tags, (batch_size, seq_length))

# 计算负对数似然损失 (通常用于训练)
loss = -crf(emissions, tags, reduction='mean')
print(f"Loss: {loss.item()}")

# 解码获取最优标签序列 (通常用于预测)
best_tags = crf.decode(emissions)
print(f"Best tags: {best_tags}")

说明：

• emissions：模型输出的每个位置对应各个标签的分数。
• tags：真实的标签序列（训练时使用）。
• crf.decode()：使用维特比算法解码出概率最大的标签路径。