Langfair 集成 - 以编程方式使用文档

LangFair 是一个全面的 Python 库，旨在对大型语言模型 (LLM) 用例进行偏差和公平性评估。LangFair 代码仓库包含一个全面的框架，用于选择偏差和公平性指标，以及演示笔记本和一个技术手册，其中讨论了 LLM 偏差和公平性风险、评估指标和最佳实践。

探索我们的文档站点获取使用 LangFair 的详细说明。

## ⚡ 快速入门指南 ### （可选）为使用 LangFair 创建虚拟环境我们建议使用 venv 创建新的虚拟环境，然后再安装 LangFair。为此，请参阅 Python venv 文档.

### 安装 LangFair 最新版本可从 PyPI 安装：

pip install langfair

uv add langfair

### 使用示例以下是代码示例，说明如何使用 LangFair 评估文本生成和摘要用例中的偏差和公平性风险。以下示例假设用户已从其用例中定义了提示列表， prompts.

##### 生成 LLM 响应要生成响应，我们可以使用 LangFair 的 ResponseGenerator 类。首先，我们必须创建一个 langchain LLM 对象。以下我们使用 ChatVertexAI，但 **任何 LangChain 的 LLM 类都可以替代使用**。请注意 InMemoryRateLimiter 用于避免速率限制错误。

from langchain_google_vertexai import ChatVertexAI
from langchain_core.rate_limiters import InMemoryRateLimiter
rate_limiter = InMemoryRateLimiter(
    requests_per_second=4.5, check_every_n_seconds=0.5, max_bucket_size=280,
)
llm = ChatVertexAI(
    model_name="gemini-pro", temperature=0.3, rate_limiter=rate_limiter
)

我们可以使用 ResponseGenerator.generate_responses 为每个提示生成 25 个响应，这是毒性评估的常规做法。

from langfair.generator import ResponseGenerator
rg = ResponseGenerator(langchain_llm=llm)
generations = await rg.generate_responses(prompts=prompts, count=25)
responses = generations["data"]["response"]
duplicated_prompts = generations["data"]["prompt"] # so prompts correspond to responses

##### 计算毒性指标毒性指标可以使用 ToxicityMetrics计算。请注意 torch.device 是可选的，如果有 GPU 可用，应该使用它来加速毒性计算。

# import torch # uncomment if GPU is available
# device = torch.device("cuda") # uncomment if GPU is available
from langfair.metrics.toxicity import ToxicityMetrics
tm = ToxicityMetrics(
    # device=device, # uncomment if GPU is available,
)
tox_result = tm.evaluate(
    prompts=duplicated_prompts,
    responses=responses,
    return_data=True
)
tox_result['metrics']
# # Output is below
# {'Toxic Fraction': 0.0004,
# 'Expected Maximum Toxicity': 0.013845130120171235,
# 'Toxicity Probability': 0.01}

##### 计算刻板印象指标刻板印象指标可以使用 StereotypeMetrics.

from langfair.metrics.stereotype import StereotypeMetrics
sm = StereotypeMetrics()
stereo_result = sm.evaluate(responses=responses, categories=["gender"])
stereo_result['metrics']
# # Output is below
# {'Stereotype Association': 0.3172750176745329,
# 'Cooccurrence Bias': 0.44766333654278373,
# 'Stereotype Fraction - gender': 0.08}

##### 生成反事实响应并计算指标我们可以使用 CounterfactualGenerator.

from langfair.generator.counterfactual import CounterfactualGenerator
cg = CounterfactualGenerator(langchain_llm=llm)
cf_generations = await cg.generate_responses(
    prompts=prompts, attribute='gender', count=25
)
male_responses = cf_generations['data']['male_response']
female_responses = cf_generations['data']['female_response']

生成反事实响应。反事实指标可以轻松使用 CounterfactualMetrics.

from langfair.metrics.counterfactual import CounterfactualMetrics
cm = CounterfactualMetrics()
cf_result = cm.evaluate(
    texts1=male_responses,
    texts2=female_responses,
    attribute='gender'
)
cf_result['metrics']
# # Output is below
# {'Cosine Similarity': 0.8318708,
# 'RougeL Similarity': 0.5195852482361165,
# 'Bleu Similarity': 0.3278433712872481,
# 'Sentiment Bias': 0.0009947145187601957}

##### 计算。替代方案：使用 AutoEval 进行半自动化评估。为了简化文本生成和摘要用例的评估， AutoEval 类通过两行代码完成多步骤流程，实现所有上述功能。

from langfair.auto import AutoEval
auto_object = AutoEval(
    prompts=prompts,
    langchain_llm=llm,
    # toxicity_device=device # uncomment if GPU is available
)
results = await auto_object.evaluate()
results['metrics']
# # Output is below
# {'Toxicity': {'Toxic Fraction': 0.0004,
#   'Expected Maximum Toxicity': 0.013845130120171235,
#   'Toxicity Probability': 0.01},
#  'Stereotype': {'Stereotype Association': 0.3172750176745329,
#   'Cooccurrence Bias': 0.44766333654278373,
#   'Stereotype Fraction - gender': 0.08,
#   'Expected Maximum Stereotype - gender': 0.60355167388916,
#   'Stereotype Probability - gender': 0.27036},
#  'Counterfactual': {'male-female': {'Cosine Similarity': 0.8318708,
#    'RougeL Similarity': 0.5195852482361165,
#    'Bleu Similarity': 0.3278433712872481,
#    'Sentiment Bias': 0.0009947145187601957}}}