guidellm.scheduler.constraints.error
Error-based constraint implementations.
Provides constraint types for limiting benchmark execution based on error rates and error counts. These constraints monitor request error status to determine when to stop benchmark execution due to excessive errors.
MaxErrorRateConstraint
Bases: PydanticConstraintInitializer
Constraint that limits execution based on sliding window error rate.
Tracks error status of recent requests in a sliding window and stops all processing when the error rate exceeds the threshold. Only applies the constraint after processing enough requests to fill the minimum window size for statistical significance.
Source code in src/guidellm/scheduler/constraints/error.py
173 174 175 176 177 178 179 180 181 182 183 184 185 186 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 | |
__call__(state, request_info)
Evaluate constraint against sliding window error rate.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
state | SchedulerState | Current scheduler state with request counts | required |
request_info | RequestInfo | Individual request with completion status | required |
Returns:
| Type | Description |
|---|---|
SchedulerUpdateAction | Action indicating whether to continue or stop operations |
Source code in src/guidellm/scheduler/constraints/error.py
create_constraint(**_kwargs)
Create a new instance of MaxErrorRateConstraint (due to stateful window).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
kwargs | Additional keyword arguments (unused) | required |
Returns:
| Type | Description |
|---|---|
Constraint | New instance of the constraint |
Source code in src/guidellm/scheduler/constraints/error.py
MaxErrorRateConstraintArgs
Bases: ConstraintArgs
Arguments for maximum error rate constraint (sliding window).
Stops execution when the windowed error rate exceeds the threshold.
Attributes:
| Name | Type | Description |
|---|---|---|
kind | Literal['max_error_rate'] | Always "max_error_rate" |
Source code in src/guidellm/scheduler/constraints/error.py
MaxErrorsConstraint
Bases: PydanticConstraintInitializer
Constraint that limits execution based on absolute error count.
Stops both request queuing and all request processing when the total number of errored requests reaches the maximum threshold. Uses global error tracking across all requests for immediate constraint evaluation.
Source code in src/guidellm/scheduler/constraints/error.py
__call__(state, request_info)
Evaluate constraint against current error count.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
state | SchedulerState | Current scheduler state with error counts | required |
request_info | RequestInfo | Individual request information (unused) | required |
Returns:
| Type | Description |
|---|---|
SchedulerUpdateAction | Action indicating whether to continue or stop operations |
Source code in src/guidellm/scheduler/constraints/error.py
create_constraint(**_kwargs)
Return self as the constraint instance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
kwargs | Additional keyword arguments (unused) | required |
Returns:
| Type | Description |
|---|---|
Constraint | Self instance as the constraint |
Source code in src/guidellm/scheduler/constraints/error.py
MaxErrorsConstraintArgs
Bases: ConstraintArgs
Arguments for maximum error count constraint.
Stops execution when total errors reach the threshold.
Attributes:
| Name | Type | Description |
|---|---|---|
kind | Literal['max_errors'] | Always "max_errors" |
Source code in src/guidellm/scheduler/constraints/error.py
MaxGlobalErrorRateConstraint
Bases: PydanticConstraintInitializer
Constraint that limits execution based on global error rate.
Calculates error rate across all processed requests and stops all processing when the rate exceeds the threshold. Only applies the constraint after processing the minimum number of requests to ensure statistical significance for global error rate calculations.
Source code in src/guidellm/scheduler/constraints/error.py
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 | |
__call__(state, request_info)
Evaluate constraint against global error rate.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
state | SchedulerState | Current scheduler state with global request and error counts | required |
request_info | RequestInfo | Individual request information (unused) | required |
Returns:
| Type | Description |
|---|---|
SchedulerUpdateAction | Action indicating whether to continue or stop operations |
Source code in src/guidellm/scheduler/constraints/error.py
create_constraint(**_kwargs)
Return self as the constraint instance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
kwargs | Additional keyword arguments (unused) | required |
Returns:
| Type | Description |
|---|---|
Constraint | Self instance as the constraint |
Source code in src/guidellm/scheduler/constraints/error.py
MaxGlobalErrorRateConstraintArgs
Bases: ConstraintArgs
Arguments for maximum global error rate constraint.
Stops execution when the overall error rate across all requests exceeds the threshold. Only applies after min_processed requests are completed.
Attributes:
| Name | Type | Description |
|---|---|---|
kind | Literal['max_global_error_rate'] | Always "max_global_error_rate" |