pydantic_evals.reporting
ReportCase dataclass
基类:Generic[InputsT, OutputT, MetadataT]
评估报告中的单个案例。
源代码位于 pydantic_evals/pydantic_evals/reporting/__init__.py
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
|
output instance-attribute
output: OutputT
任务执行的输出。
ReportCaseFailure dataclass
基类:Generic[InputsT, OutputT, MetadataT]
评估报告中因任务执行期间出错而失败的单个案例。
源代码位于 pydantic_evals/pydantic_evals/reporting/__init__.py
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
ReportCaseAggregate
基类:BaseModel
一个综合性案例,用于总结一组案例。
源代码位于 pydantic_evals/pydantic_evals/reporting/__init__.py
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 |
|
average staticmethod
average(cases: list[ReportCase]) -> ReportCaseAggregate
通过对定量属性求平均值来生成一个综合性的“摘要”案例。
源代码位于 pydantic_evals/pydantic_evals/reporting/__init__.py
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 |
|
EvaluationReport dataclass
基类:Generic[InputsT, OutputT, MetadataT]
一份关于在一组案例上评估模型结果的报告。
源代码位于 pydantic_evals/pydantic_evals/reporting/__init__.py
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 |
|
failures class-attribute
instance-attribute
failures: list[
ReportCaseFailure[InputsT, OutputT, MetadataT]
] = field(default_factory=list)
报告中的失败案例。这些是任务执行时引发异常的案例。
print(
width: int | None = None,
baseline: (
EvaluationReport[InputsT, OutputT, MetadataT] | None
) = None,
*,
include_input: bool = False,
include_metadata: bool = False,
include_expected_output: bool = False,
include_output: bool = False,
include_durations: bool = True,
include_total_duration: bool = False,
include_removed_cases: bool = False,
include_averages: bool = True,
include_errors: bool = True,
include_error_stacktrace: bool = False,
include_evaluator_failures: bool = True,
input_config: RenderValueConfig | None = None,
metadata_config: RenderValueConfig | None = None,
output_config: RenderValueConfig | None = None,
score_configs: (
dict[str, RenderNumberConfig] | None
) = None,
label_configs: (
dict[str, RenderValueConfig] | None
) = None,
metric_configs: (
dict[str, RenderNumberConfig] | None
) = None,
duration_config: RenderNumberConfig | None = None,
include_reasons: bool = False
)
将此报告打印到控制台,可选择与基准报告进行比较。
如果您想对输出有更多控制,请改用 console_table
并将其传递给 rich.Console.print
。
源代码位于 pydantic_evals/pydantic_evals/reporting/__init__.py
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 |
|
console_table
console_table(
baseline: (
EvaluationReport[InputsT, OutputT, MetadataT] | None
) = None,
*,
include_input: bool = False,
include_metadata: bool = False,
include_expected_output: bool = False,
include_output: bool = False,
include_durations: bool = True,
include_total_duration: bool = False,
include_removed_cases: bool = False,
include_averages: bool = True,
include_evaluator_failures: bool = True,
input_config: RenderValueConfig | None = None,
metadata_config: RenderValueConfig | None = None,
output_config: RenderValueConfig | None = None,
score_configs: (
dict[str, RenderNumberConfig] | None
) = None,
label_configs: (
dict[str, RenderValueConfig] | None
) = None,
metric_configs: (
dict[str, RenderNumberConfig] | None
) = None,
duration_config: RenderNumberConfig | None = None,
include_reasons: bool = False
) -> Table
返回一个包含此报告数据的表格,或此报告与基准报告之间的差异。
可选择性地包含输入和输出的详细信息。
源代码位于 pydantic_evals/pydantic_evals/reporting/__init__.py
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 |
|
failures_table
failures_table(
*,
include_input: bool = False,
include_metadata: bool = False,
include_expected_output: bool = False,
include_error_message: bool = True,
include_error_stacktrace: bool = True,
input_config: RenderValueConfig | None = None,
metadata_config: RenderValueConfig | None = None
) -> Table
返回一个包含此报告中失败案例的表格。
源代码位于 pydantic_evals/pydantic_evals/reporting/__init__.py
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 |
|
__str__
__str__() -> str
返回报告的字符串表示形式。
源代码位于 pydantic_evals/pydantic_evals/reporting/__init__.py
359 360 361 362 363 364 |
|
RenderValueConfig
基类:TypedDict
用于在评估报告中渲染值的配置。
源代码位于 pydantic_evals/pydantic_evals/reporting/__init__.py
370 371 372 373 374 375 376 |
|
RenderNumberConfig
基类:TypedDict
用于在评估报告中渲染特定分数或指标的配置。
请参阅 _RenderNumber
的实现以更清楚地了解这些参数如何影响渲染。
源代码位于 pydantic_evals/pydantic_evals/reporting/__init__.py
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 |
|
value_formatter instance-attribute
用于格式化值的逻辑。
- 如果未提供,当所有值都是整数时格式化为整数,否则至少保留一位小数和至少四位有效数字。
- 您也可以使用自定义字符串格式规范,例如 '{:.3f}'
- 您也可以使用自定义函数,例如 lambda x: f'{x:.3f}'
diff_formatter instance-attribute
用于格式化差异详情的逻辑。
由 value_formatter 生成的字符串将始终包含在报告中,但 diff_formatter 用于生成关于新旧值之间差异的附加文本,例如绝对或相对差异。
- 如果未提供,当所有值都是整数时格式化为整数,否则至少保留一位小数和至少四位有效数字,并且会包含百分比变化。
- 您也可以使用自定义字符串格式规范,例如 '{:+.3f}'
- 您也可以使用自定义函数,例如 lambda x: f'{x:+.3f}'。如果此函数返回 None,则不会添加额外的差异文本。
- 您也可以使用 None 来从不生成额外的差异文本。
diff_atol instance-attribute
diff_atol: float
用于判断差异是否“显著”的绝对容差。
如果 abs(new - old) < self.diff_atol + self.diff_rtol * abs(old)
,则差异是“显著的”。
如果差异不显著,将不会应用差异样式。请注意,只要渲染前后的值不同,我们仍然会显示它们,即使差异不显著。(如果渲染后的值完全相同,我们只显示一次该值。)
如果未提供,则使用 1e-6。
diff_rtol instance-attribute
diff_rtol: float
用于判断差异是否“显著”的相对容差。
有关什么构成“显著”差异的更多详情,请参阅 diff_atol
的描述。
如果未提供,当所有值都是整数时使用 0.001,否则使用 0.05。
diff_increase_style instance-attribute
diff_increase_style: str
应用于有显著增加的差异值的样式。
有关什么构成“显著”差异的更多详情,请参阅 diff_atol
的描述。
如果未提供,分数使用绿色,指标使用红色。您也可以使用任意 rich
样式,例如 "bold red"。
diff_decrease_style instance-attribute
diff_decrease_style: str
应用于有显著减少的差异值的样式。
有关什么构成“显著”差异的更多详情,请参阅 diff_atol
的描述。
如果未提供,分数使用红色,指标使用绿色。您也可以使用任意 rich
样式,例如 "bold red"。
EvaluationRenderer dataclass
一个用于渲染 EvalReport 或两个 EvalReport 之间差异的类。
源代码位于 pydantic_evals/pydantic_evals/reporting/__init__.py
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 |
|