🎉 我们欢迎PR！ 如果你已经实现了一个大语言模型水印算法，或者有兴趣贡献一个，我们非常乐意将其加入MarkLLM。加入我们的社区，帮助让文本水印技术对每个人来说更加易用吧！

🔥 如果你对扩散模型（图像/视频）的水印感兴趣，请参考我们团队的MarkDiffusion工具包。

💡 我们团队的其他一些可能让你感兴趣的水印论文 ✨

1. (ICLR 2024) 大语言模型的语义不变鲁棒水印

   刘艾伟、潘雷伊、胡旭明、孟啸、文立杰

   

2. (ICLR 2024) 大语言模型的不可伪造公开可验证水印

   刘艾伟、潘雷伊、胡旭明、李书昂、文立杰、Irwin King、Philip S. Yu

   

3. (ACM Computing Surveys) 大语言模型时代文本水印综述

   刘艾伟*、潘雷伊*、陆一健、李晶晶、胡旭明、张曦、文立杰、Irwin King、熊辉、Philip S. Yu

   

4. **(ICLR 2025 Spotlight) 用户能否通过精心设计的提示识别出已加水印的大语言模型？

   刘艾伟、关晟、刘一鸣、潘雷伊、张艺飞、方连成、文立杰、Philip S. Yu、胡旭明

   

5. **(ACL 2025 Main) 大语言模型水印能否稳健地防止未经授权的知识蒸馏？

   潘雷伊、刘艾伟、黄世宇、陆一健、胡旭明、文立杰、Irwin King、Philip S. Yu

   

6. **(NAACL 2025 Findings) WaterSeeker：开创性地高效检测大型文档中的加水印片段

   潘雷伊、刘艾伟、陆一健、高子天、狄一辰、文立杰、Irwin King、Philip S. Yu

   

7. **(ACL 2024 Main) 基于熵的文本水印检测方法

   陆一健、刘艾伟、于典志、李晶晶、Irwin King

   

8. **(ACL 2024 Main) 水印能否在翻译中存活？关于大语言模型文本水印的跨语言一致性

   何志伟、周炳林、郝洪坤、刘艾伟、王兴、涂兆鹏、张卓生、王睿

   

目录

• MarkLLM：面向大语言模型水印的开源工具包
  • 目录
  • 注释
  • 更新
  • MarkLLM简介
    • 概述
    • MarkLLM的主要特性
  • 如何在自己的代码中使用该工具包
    • 环境搭建
    • 调用水印算法
    • 机制可视化
    • 应用评估流水线
  • 更多用户示例
  • 演示Jupyter笔记本
  • 引用

❗❗❗ 注意事项

随着 MarkLLM 仓库内容日益丰富、体积不断增大，我们已在 Hugging Face 上创建了一个名为 Generative-Watermark-Toolkits 的模型存储库，以方便用户使用。该仓库包含了多种涉及自训练模型的水印算法的默认模型。我们已从主仓库中相应水印算法的 model/ 文件夹中移除了模型权重。在使用代码时，请先根据配置路径从 Hugging Face 仓库下载对应的模型，并将其保存到 model/ 目录下，再运行代码。

更新日志

• 🎉 (2025.09.22) 新增 SemStamp 水印方法。感谢 Huan Wang 的 PR！
• 🎉 (2025.09.17) 新增 IE 水印方法。感谢 Tianle Gu 的 PR！
• 🎉 (2025.09.14) 新增 Watermark Stealing 攻击方法。感谢 Shuhao Zhang 的 PR！
• 🎉 (2025.07.17) 新增 k-SemStamp 水印方法。感谢 Huan Wang 的 PR！
• 🎉 (2025.07.17) 新增 Adaptive Watermark 水印方法。感谢 Yepeng Liu 的 PR！
• 🎉 (2025.05.24) 新增 MorphMark 水印方法。感谢 Zongqi Wang 的 PR！
• 🎉 (2025.03.12) 新增 Permute-and-Flip (PF) 水印方法。感谢 Zian Wang 的 PR！
• 🎉 (2025.02.27) 为 Unbiased 水印方法新增 δ-reweight 和 LLR 分数检测功能。
• 🎉 (2025.01.08) 为水印方法添加 AutoConfiguration 功能。
• 🎉 (2024.12.21) 在 MarkvLLM_demo.py 中提供将 VLLM 与 MarkLLM 集成的示例代码。感谢 @zhangjf-nlp 的 PR！
• 🎉 (2024.11.21) 支持 SynthID-Text 方法（Nature）的失真版本。
• 🎉 (2024.11.03) 新增 SynthID-Text 方法（Nature），并支持均值、加权均值和贝叶斯等检测方法。
• 🎉 (2024.11.01) 新增 TS-Watermark 方法（ICML 2024）。感谢 Kyle Zheng 和 Minjia Huo 的 PR！
• 🎉 (2024.10.07) 提供 EXP 水印算法的一种等价替代实现（EXPGumbel），采用 Gumbel 噪声。通过此实现，用户可以通过调整配置文件中的采样温度来改变水印强度。
• 🎉 (2024.10.07) 新增 Unbiased 水印方法。
• 🎉 (2024.10.06) 我们很高兴地宣布，我们的论文“MarkLLM: 一个用于 LLM 水印的开源工具包”已被 EMNLP 2024 Demo 接受！
• 🎉 (2024.08.08) 新增 DiPmark 水印方法。感谢 Sheng Guan 的 PR！
• 🎉 (2024.08.01) 作为 python 包 发布！尝试运行 pip install markllm。我们在本文末尾提供了用户示例。
• 🎉 (2024.07.13) 新增 ITSEdit 水印方法。感谢 Yiming Liu 的 PR！
• 🎉 (2024.07.09) 为 KGW 添加更多哈希方案（跳过、最小值、加法、自哈希）。感谢 Yichen Di 的 PR！
• 🎉 (2024.07.08) 为 Christ 系列水印方法添加 top-k 过滤器。感谢 Kai Shi 的 PR！
• 🎉 (2024.07.03) 更新了反向翻译攻击。感谢 Zihan Tang 的 PR！
• 🎉 (2024.06.19) 根据强水印不可行性结果的相关论文（ICML，2024年；博客），更新了随机游走攻击。感谢 Hanlin Zhang 的 PR！
• 🎉 (2024.05.23) 我们非常高兴地宣布，我们的网站演示已正式上线！

MarkLLM 简介

概述

MarkLLM 是一个开源工具包，旨在促进大型语言模型（LLMs）中水印技术的研究与应用。随着大型语言模型的广泛应用，确保机器生成文本的真实性和来源变得至关重要。MarkLLM 简化了对水印技术的访问、理解和评估，使其既适用于研究人员，也便于更广泛的社区使用。

MarkLLM 的主要特性

• 实现框架：MarkLLM 提供了一个统一且可扩展的平台，用于实现各种 LLM 水印算法。目前支持来自两个重要家族的九种具体算法，从而促进了水印技术的集成与扩展。

  框架设计：

  

  当前支持的算法：

  算法名称	发表期刊	链接
  KGW	ICML 2023	[2301.10226] 大型语言模型的水印 (arxiv.org)
  Unigram	ICLR 2024	[2306.17439] 可证明鲁棒的AI生成文本水印 (arxiv.org)
  SWEET	ACL 2024	[2305.15060] 这段代码是谁写的？代码生成中的水印 (arxiv.org)
  UPV	ICLR 2024	[2307.16230] 一种不可伪造、可公开验证的大规模语言模型水印 (arxiv.org)
  EWD	ACL 2024	[2403.13485] 基于熵的文本水印检测方法 (arxiv.org)
  SIR	ICLR 2024	[2310.06356] 大型语言模型的语义不变鲁棒水印 (arxiv.org)
  X-SIR	ACL 2024	[2402.14007] 水印能经受住翻译吗？关于大型语言模型文本水印的跨语言一致性 (arxiv.org)
  DiPmark	ICML 2024	[2310.07710] 一种具有弹性且易于使用的分布保持型水印 (arxiv.org)
  无偏水印	ICLR 2024	[2310.10669] 大型语言模型的无偏水印 (arxiv.org)
  TS水印	ICML 2024	[2402.18059] 针对大型语言模型的增强可检测性和语义连贯性的特定于标记的水印 (arxiv.org)
  SynthID-Text	Nature 2024	用于识别大型语言模型输出的可扩展水印 (Nature)
  PF水印	ICLR 2025	[2402.05864] 排列翻转：一种最优稳定且可水印的 LLM 解码器
  MorphMark	ACL 2025	[2505.11541] MorphMark：大型语言模型的灵活自适应水印
  自适应水印	ICML 2024	[2401.13927] 大型语言模型的自适应文本水印
  SemStamp	NAACL 2024	[2310.03991]SemStamp：一种具有释义鲁棒性的语义水印，用于文本生成
  k-SemStamp	ACL 2024 (Findings)	[2402.11399] k-SemStamp：一种基于聚类的语义水印，用于检测机器生成文本
  EXP/EXPGumbel	讲座笔记	https://www.scottaaronson.com/talks/watermark.ppt
  EXP-Edit	TMLR 2024	[2307.15593] 鲁棒无失真的语言模型水印 (arxiv.org)
  ITS-Edit	TMLR 2024	[2307.15593] 鲁棒无失真的语言模型水印 (arxiv.org)
  IE	Arxiv 预印本	[2505.14112] 不可见的熵：迈向安全高效的低熵 LLM 水印 (arxiv.org)

• 可视化解决方案：该工具包包含自定义可视化工具，能够在不同场景下清晰、深入地展示各类水印算法的工作原理。这些可视化工具有助于揭示算法机制，使用户更容易理解。

  

• 评估模块：MarkLLM 拥有 12 种评估工具，涵盖可检测性、鲁棒性以及对文本质量的影响，以其全面的评估方法在水印技术评估领域脱颖而出。此外，它还提供可定制的自动化评估流程，以满足不同需求和场景，进一步提升了工具包的实用性。

  工具：

  • 水印检测成功率计算器：FundamentalSuccessRateCalculator、DynamicThresholdSuccessRateCalculator
  • 文本编辑器：WordDeletion、SynonymSubstitution、ContextAwareSynonymSubstitution、GPTParaphraser、DipperParaphraser、RandomWalkAttack
  • 文本质量分析器：PPLCalculator、LogDiversityAnalyzer、BLEUCalculator、PassOrNotJudger、GPTDiscriminator

  管道：

  • 水印检测管道：WatermarkedTextDetectionPipeline、UnwatermarkedTextDetectionPipeline
  • 文本质量管道：DirectTextQualityAnalysisPipeline、ReferencedTextQualityAnalysisPipeline、ExternalDiscriminatorTextQualityAnalysisPipeline

如何在您自己的代码中使用该工具包

环境设置

• Python 3.10
• PyTorch
• 运行 pip install -r requirements.txt

提示： 如果您希望使用 EXPEdit 或 ITSEdit 算法，您需要导入 .pyx 文件。以 EXPEdit 为例：

• 运行 python watermark/exp_edit/cython_files/setup.py build_ext --inplace
• 将生成的 .so 文件移动到 watermark/exp_edit/cython_files/ 目录下。

调用水印算法

import torch
from watermark.auto_watermark import AutoWatermark
from utils.transformers_config import TransformersConfig
from transformers import AutoModelForCausalLM, AutoTokenizer

# 设备
device = "cuda" if torch.cuda.is_available() else "cpu"

# Transformers 配置
transformers_config = TransformersConfig(model=AutoModelForCausalLM.from_pretrained('facebook/opt-1.3b').to(device),
                                         tokenizer=AutoTokenizer.from_pretrained('facebook/opt-1.3b'),
                                         vocab_size=50272,
                                         device=device,
                                         max_new_tokens=200,
                                         min_length=230,
                                         do_sample=True,
                                         no_repeat_ngram_size=4)
  
# 加载水印算法
myWatermark = AutoWatermark.load('KGW', 
                                 algorithm_config='config/KGW.json',
                                 transformers_config=transformers_config)

# 提示词
prompt = 'Good Morning.'

# 生成并检测
watermarked_text = myWatermark.generate_watermarked_text(prompt)
detect_result = myWatermark.detect_watermark(watermarked_text)
unwatermarked_text = myWatermark.generate_unwatermarked_text(prompt)
detect_result = myWatermark.detect_watermark(unwatermarked_text)

可视化机制

假设您已经有一对 watermarked_text 和 unwatermarked_text，并且希望通过水印算法可视化它们之间的差异，并在加水印的文本中特别突出水印部分，您可以使用 visualize/ 目录下的可视化工具。

KGW 家族

import torch
from visualize.font_settings import FontSettings
from watermark.auto_watermark import AutoWatermark
from utils.transformers_config import TransformersConfig
from transformers import AutoModelForCausalLM, AutoTokenizer
from visualize.visualizer import DiscreteVisualizer
from visualize.legend_settings import DiscreteLegendSettings
from visualize.page_layout_settings import PageLayoutSettings
from visualize.color_scheme import ColorSchemeForDiscreteVisualization

# 加载水印算法
device = "cuda" if torch.cuda.is_available() else "cpu"
transformers_config = TransformersConfig(
    						model=AutoModelForCausalLM.from_pretrained('facebook/opt-1.3b').to(device),
                            tokenizer=AutoTokenizer.from_pretrained('facebook/opt-1.3b'),
                            vocab_size=50272,
                            device=device,
                            max_new_tokens=200,
                            min_length=230,
                            do_sample=True,
                            no_repeat_ngram_size=4)
myWatermark = AutoWatermark.load('KGW', 
                                 algorithm_config='config/KGW.json',
                                 transformers_config=transformers_config)
# 获取用于可视化的数据
watermarked_data = myWatermark.get_data_for_visualization(watermarked_text)
unwatermarked_data = myWatermark.get_data_for_visualization(unwatermarked_text)

# 初始化可视化工具
visualizer = DiscreteVisualizer(color_scheme=ColorSchemeForDiscreteVisualization(),
                                font_settings=FontSettings(), 
                                page_layout_settings=PageLayoutSettings(),
                                legend_settings=DiscreteLegendSettings())
# 可视化
watermarked_img = visualizer.visualize(data=watermarked_data, 
                                       show_text=True, 
                                       visualize_weight=True, 
                                       display_legend=True)

unwatermarked_img = visualizer.visualize(data=unwatermarked_data,
                                         show_text=True, 
                                         visualize_weight=True, 
                                         display_legend=True)
# 保存
watermarked_img.save("KGW_watermarked.png")
unwatermarked_img.save("KGW_unwatermarked.png")

Christ 家族

import torch
from visualize.font_settings import FontSettings
from watermark.auto_watermark import AutoWatermark
from utils.transformers_config import TransformersConfig
from transformers import AutoModelForCausalLM, AutoTokenizer
from visualize.visualizer import ContinuousVisualizer
from visualize.legend_settings import ContinuousLegendSettings
from visualize.page_layout_settings import PageLayoutSettings
from visualize.color_scheme import ColorSchemeForContinuousVisualization

# 加载水印算法
device = "cuda" if torch.cuda.is_available() else "cpu"
transformers_config = TransformersConfig(
    						model=AutoModelForCausalLM.from_pretrained('facebook/opt-1.3b').to(device),
                            tokenizer=AutoTokenizer.from_pretrained('facebook/opt-1.3b'),
                            vocab_size=50272,
                            device=device,
                            max_new_tokens=200,
                            min_length=230,
                            do_sample=True,
                            no_repeat_ngram_size=4)
myWatermark = AutoWatermark.load('EXP', 
                                 algorithm_config='config/EXP.json',
                                 transformers_config=transformers_config)
# 获取用于可视化的数据
watermarked_data = myWatermark.get_data_for_visualization(watermarked_text)
unwatermarked_data = myWatermark.get_data_for_visualization(unwatermarked_text)

# 初始化可视化工具
visualizer = ContinuousVisualizer(color_scheme=ColorSchemeForContinuousVisualization(),
                                  font_settings=FontSettings(), 
                                  page_layout_settings=PageLayoutSettings(),
                                  legend_settings=ContinuousLegendSettings())

# 可视化
watermarked_img = visualizer.visualize(data=watermarked_data, 
                                       show_text=True, 
                                       visualize_weight=True, 
                                       display_legend=True)

unwatermarked_img = visualizer.visualize(data=unwatermarked_data,
                                         show_text=True, 
                                         visualize_weight=True, 
                                         display_legend=True)
# 保存
watermarked_img.save("EXP_watermarked.png")
unwatermarked_img.save("EXP_unwatermarked.png")

有关如何使用可视化工具的更多示例，请参阅项目目录中的 test/test_visualize.py 脚本。

应用评估流水线

使用水印检测流水线

import torch
from evaluation.dataset import C4Dataset
from watermark.auto_watermark import AutoWatermark
from utils.transformers_config import TransformersConfig
from transformers import AutoModelForCausalLM, AutoTokenizer
from evaluation.tools.text_editor import TruncatePromptTextEditor, WordDeletion
from evaluation.tools.success_rate_calculator import DynamicThresholdSuccessRateCalculator
from evaluation.pipelines.detection import WatermarkedTextDetectionPipeline, UnWatermarkedTextDetectionPipeline, DetectionPipelineReturnType

# 加载数据集
my_dataset = C4Dataset('dataset/c4/processed_c4.json')

# 设备
device = 'cuda' if torch.cuda.is_available() else 'cpu'

# Transformers 配置
transformers_config = TransformersConfig(
    model=AutoModelForCausalLM.from_pretrained('facebook/opt-1.3b').to(device),
    tokenizer=AutoTokenizer.from_pretrained('facebook/opt-1.3b'),
    vocab_size=50272,
    device=device,
    max_new_tokens=200,
    do_sample=True,
    min_length=230,
    no_repeat_ngram_size=4)

# 加载水印算法
my_watermark = AutoWatermark.load('KGW', 
                                  algorithm_config='config/KGW.json',
                                  transformers_config=transformers_config)

# 初始化流水线
pipeline1 = WatermarkedTextDetectionPipeline(
    dataset=my_dataset, 
    text_editor_list=[TruncatePromptTextEditor(), WordDeletion(ratio=0.3)],
    show_progress=True, 
    return_type=DetectionPipelineReturnType.SCORES) 

pipeline2 = UnWatermarkedTextDetectionPipeline(dataset=my_dataset, 
                                               text_editor_list=[],
                                               show_progress=True,
                                               return_type=DetectionPipelineReturnType.SCORES)

# 评估
calculator = DynamicThresholdSuccessRateCalculator(labels=['TPR', 'F1'], rule='best')
print(calculator.calculate(pipeline1.evaluate(my_watermark), pipeline2.evaluate(my_watermark)))

使用文本质量分析流水线

import torch
from evaluation.dataset import C4Dataset
from watermark.auto_watermark import AutoWatermark
from utils.transformers_config import TransformersConfig
from transformers import AutoModelForCausalLM, AutoTokenizer
from evaluation.tools.text_editor import TruncatePromptTextEditor
from evaluation.tools.text_quality_analyzer import PPLCalculator
from evaluation.pipelines.quality_analysis import DirectTextQualityAnalysisPipeline, QualityPipelineReturnType

# 加载数据集
my_dataset = C4Dataset('dataset/c4/processed_c4.json')

# 设备
device = 'cuda' if torch.cuda.is_available() else 'cpu'

# Transformer 配置
transformers_config = TransformersConfig(
    model=AutoModelForCausalLM.from_pretrained('facebook/opt-1.3b').to(device),                             	tokenizer=AutoTokenizer.from_pretrained('facebook/opt-1.3b'),
    vocab_size=50272,
    device=device,
    max_new_tokens=200,
    min_length=230,
    do_sample=True,
    no_repeat_ngram_size=4)

# 加载水印算法
my_watermark = AutoWatermark.load('KGW', 
                                  algorithm_config='config/KGW.json',
                                  transformers_config=transformers_config)

# 初始化流水线
quality_pipeline = DirectTextQualityAnalysisPipeline(
    dataset=my_dataset, 
    watermarked_text_editor_list=[TruncatePromptTextEditor()],
    unwatermarked_text_editor_list=[],
    analyzer=PPLCalculator(
        model=AutoModelForCausalLM.from_pretrained('..model/llama-7b/', device_map='auto'),                 		tokenizer=LlamaTokenizer.from_pretrained('..model/llama-7b/'),
        device=device),
    unwatermarked_text_source='natural', 
    show_progress=True, 
    return_type=QualityPipelineReturnType.MEAN_SCORES)

# 评估
print(quality_pipeline.evaluate(my_watermark))

有关如何使用这些流水线的更多示例，请参阅项目目录中的 test/test_pipeline.py 脚本。

利用示例脚本来进行评估

在我们仓库的 evaluation/examples/ 目录中，您会找到一组专门用于系统化和自动化评估各种算法的 Python 脚本。通过使用这些示例，您可以快速有效地评估我们工具包中每种算法的可检测性、鲁棒性以及对文本质量的影响。

注意：要执行 evaluation/examples/ 中的脚本，首先需要运行以下命令来设置环境变量。

export PYTHONPATH="path_to_the_MarkLLM_project:$PYTHONPATH"

更多用户示例

额外的用户示例可在 test/ 目录中找到。要执行其中包含的脚本，首先需要运行以下命令来设置环境变量。

export PYTHONPATH="path_to_the_MarkLLM_project:$PYTHONPATH"

演示 Jupyter 笔记本

除了我们提供的 Colab Jupyter 笔记本之外（由于存储限制，部分模型无法下载），您还可以轻松地在本地机器上使用 MarkLLM_demo.ipynb 进行部署。

引用

@inproceedings{pan-etal-2024-markllm,
    title = "{M}ark{LLM}: 用于大语言模型水印的开源工具包",
    author = "潘雷毅 和 刘艾伟 和 何志伟 和 高子腾 和 赵轩东 和 陆义健 和 周炳林 和 刘书亮 和 胡旭明 和 文立杰 和 金尔文 和 余Philip S.",
    editor = "埃尔南德斯·法里亚斯，黛丽娅·伊拉苏 和 霍普，汤姆 和 李曼玲",
    booktitle = "2024年自然语言处理经验方法会议：系统演示论文集",
    month = nov,
    year = "2024",
    address = "美国佛罗里达州迈阿密",
    publisher = "计算语言学协会",
    url = "https://aclanthology.org/2024.emnlp-demo.7",
    pages = "61--71",
    abstract = "针对大语言模型（LLMs）的水印技术，通过在模型输出中嵌入不易察觉但可被算法检测的信号来识别由LLM生成的文本，在缓解LLM潜在滥用方面变得至关重要。然而，现有的LLM水印算法种类繁多、机制复杂，且评估流程和视角多样，这给研究人员及学术界理解、实现和评估最新进展带来了挑战。为解决这些问题，我们提出了MarkLLM——一个用于LLM水印的开源工具包。MarkLLM提供了一个统一且可扩展的框架，用于实现各类LLM水印算法，并配备用户友好的界面以降低使用门槛。此外，它还通过自动可视化这些算法的底层机制，进一步提升理解度。在评估方面，MarkLLM提供了涵盖三个视角的12种工具以及两类自动化评估流水线。借助MarkLLM，我们旨在支持研究人员的工作，同时提高公众对LLM水印技术的理解与参与度，促进共识形成，并推动该领域的研究与应用进一步发展。我们的代码可在https://github.com/THU-BPM/MarkLLM获取。",
}

MarkLLM 快速上手指南

MarkLLM 是一个开源的大语言模型（LLM）水印工具包，旨在简化水印技术的接入、理解与评估。它提供了统一的可扩展框架，支持多种主流水印算法及其攻击检测方法。

1. 环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统: Linux, macOS 或 Windows
• Python 版本: Python 3.8 或更高版本
• 硬件建议: 若需运行本地模型推理或训练，建议配备 NVIDIA GPU 及对应的 CUDA 驱动；若仅使用 API 或轻量级检测，CPU 即可。
• 前置依赖: 建议先更新 pip 和 setuptools。

python -m pip install --upgrade pip setuptools wheel

2. 安装步骤

您可以通过 PyPI 直接安装稳定版，或从源码安装以获取最新功能。

方式一：通过 PyPI 安装（推荐）

这是最快捷的安装方式：

pip install markllm

国内加速提示：如果您在中国大陆地区，建议使用清华或阿里镜像源加速安装：

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

方式二：从源码安装

如果您需要贡献代码或使用尚未发布的最新特性：

git clone https://github.com/THU-BPM/MarkLLM.git
cd MarkLLM
pip install -e .

⚠️ 重要提示：模型权重下载

由于仓库体积限制，部分涉及自训练模型的水印算法权重未包含在代码库中。 在运行代码前，请务必访问 Hugging Face - Generative-Watermark-Toolkits 下载所需的默认模型，并将其保存到项目对应的 model/ 目录下，否则程序可能无法运行。

3. 基本使用

MarkLLM 的设计目标是让开发者能在几行代码内集成水印功能。以下是一个最简单的使用示例，展示如何调用水印算法生成带水印的文本。

简单示例：生成带水印的文本

假设您已配置好环境并下载了相关模型，可以通过以下代码调用内置的水印算法（例如 KGW 或 Unbiased 等）：

from markllm import WatermarkManager

# 初始化水印管理器
# config_path 指向具体的算法配置文件，通常位于 configs/ 目录下
manager = WatermarkManager(config_path="configs/kgw_config.yaml")

# 定义输入提示词
prompt = "请写一首关于春天的短诗。"

# 生成带水印的文本
watermarked_text = manager.generate(prompt)

print("生成的带水印文本：")
print(watermarked_text)

# 检测文本中是否包含水印
detection_result = manager.detect(watermarked_text)

print("\n检测结果：")
print(f"是否检测到水印：{detection_result['is_watermarked']}")
print(f"置信度得分：{detection_result['score']}")

进阶：在现有代码中集成

如果您已经在自己的项目中使用 Hugging Face transformers 或其他推理框架，MarkLLM 提供了统一的接口来拦截 logits 并应用水印逻辑。您只需实例化对应的水印处理器，并在生成循环中调用其 logits_processor 即可。

更多详细用法、Jupyter Notebook 演示以及针对不同算法（如 SynthID-Text, DiPmark 等）的特定配置，请参考项目根目录下的 examples/ 文件夹或官方文档。