Model Card¶
model_card
¶
Model Card Generator — standardized AI model documentation for safety.
Generates structured model cards following best practices from the ML community (inspired by Mitchell et al. 2019 "Model Cards for Model Reporting"). Focused on safety-relevant sections: intended use, out-of-scope use, risks, mitigations, ethical considerations, and safety evaluation results.
CLI usage::
python -m replication model-card --name "ReplicatorV3" --task "code generation"
python -m replication model-card --from-config card_config.json
python -m replication model-card --interactive
python -m replication model-card --name "AgentX" --format markdown --output card.md
python -m replication model-card --name "AgentX" --format html --output card.html
Programmatic::
from replication.model_card import ModelCardGenerator, ModelCardConfig
gen = ModelCardGenerator()
card = gen.generate(ModelCardConfig(
model_name="ReplicatorV3",
model_type="autonomous_agent",
task="code generation and execution",
intended_users=["security researchers"],
risks=["prompt injection", "code exfiltration"],
))
print(card.to_markdown())
print(card.to_json())
ModelType
¶
Bases: Enum
Broad model/agent categories.
Source code in src/replication/model_card.py
RiskLevel
¶
RiskEntry
dataclass
¶
A single risk item on the model card.
Source code in src/replication/model_card.py
SafetyEvaluation
dataclass
¶
Results from a safety evaluation.
Source code in src/replication/model_card.py
ModelCardConfig
dataclass
¶
Input configuration for generating a model card.
Source code in src/replication/model_card.py
ModelCard
dataclass
¶
A generated model card with all sections populated.
Source code in src/replication/model_card.py
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 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 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 | |
to_markdown() -> str
¶
Render the model card as a Markdown document.
Source code in src/replication/model_card.py
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 365 366 367 368 369 370 371 372 373 374 375 | |
to_html() -> str
¶
Render the model card as a standalone HTML document.
Source code in src/replication/model_card.py
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 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 | |
ModelCardGenerator
¶
Generate model cards from configuration.
Source code in src/replication/model_card.py
generate(config: ModelCardConfig) -> ModelCard
¶
Build a ModelCard from a config.
main(argv: Optional[Sequence[str]] = None) -> None
¶
CLI entry point.