Components and configs¶
mindone.diffusers.modular_pipelines.modular_pipeline.ComponentSpec
dataclass
¶
Specification for a pipeline component.
A component can be created in two ways:
1. From scratch using init with a config dict
2. using from_pretrained
ATTRIBUTE | DESCRIPTION |
---|---|
name |
Name of the component
TYPE:
|
type_hint |
Type of the component (e.g. UNet2DConditionModel)
TYPE:
|
description |
Optional description of the component
TYPE:
|
config |
Optional config dict for init creation
TYPE:
|
repo |
Optional repo path for from_pretrained creation
TYPE:
|
subfolder |
Optional subfolder in repo
TYPE:
|
variant |
Optional variant in repo
TYPE:
|
revision |
Optional revision in repo
TYPE:
|
default_creation_method |
Preferred creation method - "from_config" or "from_pretrained"
TYPE:
|
Source code in mindone/diffusers/modular_pipelines/modular_pipeline_utils.py
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 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 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 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 |
|
mindone.diffusers.modular_pipelines.modular_pipeline.ComponentSpec.load_id
property
¶
Unique identifier for this spec's pretrained load, composed of repo|subfolder|variant|revision (no empty segments).
mindone.diffusers.modular_pipelines.modular_pipeline.ComponentSpec.__eq__(other)
¶
Compare ComponentSpec objects based on name and load_id.
Source code in mindone/diffusers/modular_pipelines/modular_pipeline_utils.py
101 102 103 104 105 106 107 108 109 |
|
mindone.diffusers.modular_pipelines.modular_pipeline.ComponentSpec.__hash__()
¶
Make ComponentSpec hashable, using load_id as the hash value.
Source code in mindone/diffusers/modular_pipelines/modular_pipeline_utils.py
97 98 99 |
|
mindone.diffusers.modular_pipelines.modular_pipeline.ComponentSpec.create(config=None, **kwargs)
¶
Create component using from_config with config.
Source code in mindone/diffusers/modular_pipelines/modular_pipeline_utils.py
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 |
|
mindone.diffusers.modular_pipelines.modular_pipeline.ComponentSpec.decode_load_id(load_id)
classmethod
¶
Decode a load_id string back into a dictionary of loading fields and values.
PARAMETER | DESCRIPTION |
---|---|
load_id
|
The load_id string to decode, format: "repo|subfolder|variant|revision" where None values are represented as "null"
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
Dict[str, Optional[str]]
|
Dict mapping loading field names to their values. e.g. { "repo": "path/to/repo", "subfolder": "subfolder", "variant": "variant", "revision": "revision" |
Dict[str, Optional[str]]
|
} If a segment value is "null", it's replaced with None. Returns None if load_id is "null" (indicating |
Dict[str, Optional[str]]
|
component not created with |
Source code in mindone/diffusers/modular_pipelines/modular_pipeline_utils.py
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 |
|
mindone.diffusers.modular_pipelines.modular_pipeline.ComponentSpec.from_component(name, component)
classmethod
¶
Create a ComponentSpec from a Component.
Currently supports:
- Components created with ComponentSpec.load()
method
- Components that are ConfigMixin subclasses but not nn.Modules (e.g. schedulers, guiders)
PARAMETER | DESCRIPTION |
---|---|
name
|
Name of the component
TYPE:
|
component
|
Component object to create spec from
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
Any
|
ComponentSpec object |
RAISES | DESCRIPTION |
---|---|
ValueError
|
If component is not supported (e.g. nn.Module without load_id, non-ConfigMixin) |
Source code in mindone/diffusers/modular_pipelines/modular_pipeline_utils.py
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 |
|
mindone.diffusers.modular_pipelines.modular_pipeline.ComponentSpec.load(**kwargs)
¶
Load component using from_pretrained.
Source code in mindone/diffusers/modular_pipelines/modular_pipeline_utils.py
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 |
|
mindone.diffusers.modular_pipelines.modular_pipeline.ComponentSpec.loading_fields()
classmethod
¶
Return the names of all loading‐related fields (i.e. those whose field.metadata["loading"] is True).
Source code in mindone/diffusers/modular_pipelines/modular_pipeline_utils.py
171 172 173 174 175 176 |
|
mindone.diffusers.modular_pipelines.modular_pipeline.ConfigSpec
dataclass
¶
Specification for a pipeline configuration parameter.
Source code in mindone/diffusers/modular_pipelines/modular_pipeline_utils.py
293 294 295 296 297 298 299 |
|
mindone.diffusers.modular_pipelines.components_manager.ComponentsManager
¶
A central registry and management system for model components across multiple pipelines.
[ComponentsManager
] provides a unified way to register, track, and reuse model components (like UNet, VAE, text
encoders, etc.) across different modular pipelines. It includes features for duplicate detection, memory
management, and component organization.
This is an experimental feature and is likely to change in the future.
Example
from mindone.diffusers import ComponentsManager
# Create a components manager
cm = ComponentsManager()
# Add components
cm.add("unet", unet_model, collection="sdxl")
cm.add("vae", vae_model, collection="sdxl")
# Retrieve components
unet = cm.get_one(name="unet", collection="sdxl")
Source code in mindone/diffusers/modular_pipelines/components_manager.py
98 99 100 101 102 103 104 105 106 107 108 109 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 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 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 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 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 |
|
mindone.diffusers.modular_pipelines.components_manager.ComponentsManager.add(name, component, collection=None)
¶
Add a component to the ComponentsManager.
PARAMETER | DESCRIPTION |
---|---|
name
|
The name of the component
TYPE:
|
component
|
The component to add
TYPE:
|
collection
|
The collection to add the component to
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
str
|
The unique component ID, which is generated as "{name}_{id(component)}" where id(component) is Python's built-in unique identifier for the object |
Source code in mindone/diffusers/modular_pipelines/components_manager.py
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 |
|
mindone.diffusers.modular_pipelines.components_manager.ComponentsManager.get_components_by_ids(ids, return_dict_with_names=True)
¶
Get components by a list of IDs.
PARAMETER | DESCRIPTION |
---|---|
ids
|
List of component IDs
TYPE:
|
return_dict_with_names
|
Whether to return a dictionary with component names as keys:
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
Dict[str, Any]: Dictionary of components. - If return_dict_with_names=True, keys are component names. - If return_dict_with_names=False, keys are component IDs. |
RAISES | DESCRIPTION |
---|---|
ValueError
|
If duplicate component names are found in the search results when return_dict_with_names=True |
Source code in mindone/diffusers/modular_pipelines/components_manager.py
748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 |
|
mindone.diffusers.modular_pipelines.components_manager.ComponentsManager.get_components_by_names(names, collection=None)
¶
Get components by a list of names, optionally filtered by collection.
PARAMETER | DESCRIPTION |
---|---|
names
|
List of component names
TYPE:
|
collection
|
Optional collection to filter by
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
Dict[str, Any]: Dictionary of components with component names as keys |
RAISES | DESCRIPTION |
---|---|
ValueError
|
If duplicate component names are found in the search results |
Source code in mindone/diffusers/modular_pipelines/components_manager.py
781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 |
|
mindone.diffusers.modular_pipelines.components_manager.ComponentsManager.get_ids(names=None, collection=None)
¶
Get component IDs by a list of names, optionally filtered by collection.
PARAMETER | DESCRIPTION |
---|---|
names
|
List of component names
TYPE:
|
collection
|
Optional collection to filter by
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
List[str]: List of component IDs |
Source code in mindone/diffusers/modular_pipelines/components_manager.py
730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 |
|
mindone.diffusers.modular_pipelines.components_manager.ComponentsManager.get_model_info(component_id, fields=None)
¶
Get comprehensive information about a component.
PARAMETER | DESCRIPTION |
---|---|
component_id
|
Name of the component to get info for
TYPE:
|
fields
|
Field(s) to return. Can be a string for single field or list of fields. If None, uses the available_info_fields setting.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
Optional[Dict[str, Any]]
|
Dictionary containing requested component metadata. If fields is specified, returns only those fields. |
Optional[Dict[str, Any]]
|
Otherwise, returns all fields. |
Source code in mindone/diffusers/modular_pipelines/components_manager.py
483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 |
|
mindone.diffusers.modular_pipelines.components_manager.ComponentsManager.get_one(component_id=None, name=None, collection=None, load_id=None)
¶
Get a single component by either: - searching name (pattern matching), collection, or load_id. - passing in a component_id Raises an error if multiple components match or none are found.
PARAMETER | DESCRIPTION |
---|---|
component_id
|
Optional component ID to get
TYPE:
|
name
|
Component name or pattern
TYPE:
|
collection
|
Optional collection to filter by
TYPE:
|
load_id
|
Optional load_id to filter by
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
Any
|
A single component |
RAISES | DESCRIPTION |
---|---|
ValueError
|
If no components match or multiple components match |
Source code in mindone/diffusers/modular_pipelines/components_manager.py
685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 |
|
mindone.diffusers.modular_pipelines.components_manager.ComponentsManager.remove(component_id=None)
¶
Remove a component from the ComponentsManager.
PARAMETER | DESCRIPTION |
---|---|
component_id
|
The ID of the component to remove
TYPE:
|
Source code in mindone/diffusers/modular_pipelines/components_manager.py
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 |
|
mindone.diffusers.modular_pipelines.components_manager.ComponentsManager.remove_from_collection(component_id, collection)
¶
Remove a component from a collection.
Source code in mindone/diffusers/modular_pipelines/components_manager.py
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 |
|
mindone.diffusers.modular_pipelines.components_manager.ComponentsManager.search_components(names=None, collection=None, load_id=None, return_dict_with_names=True)
¶
Search components by name with simple pattern matching. Optionally filter by collection or load_id.
PARAMETER | DESCRIPTION |
---|---|
names
|
Component name(s) or pattern(s) Patterns: - "unet" : match any component with base name "unet" (e.g., unet_123abc) - "!unet" : everything except components with base name "unet" - "unet*" : anything with base name starting with "unet" - "!unet*" : anything with base name NOT starting with "unet" - "unet" : anything with base name containing "unet" - "!unet" : anything with base name NOT containing "unet" - "refiner|vae|unet" : anything with base name exactly matching "refiner", "vae", or "unet" - "!refiner|vae|unet" : anything with base name NOT exactly matching "refiner", "vae", or "unet" - "unet*|vae*" : anything with base name starting with "unet" OR starting with "vae"
TYPE:
|
collection
|
Optional collection to filter by
TYPE:
|
load_id
|
Optional load_id to filter by
TYPE:
|
return_dict_with_names
|
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
Dictionary mapping component names to components if return_dict_with_names=True, or a dictionary mapping |
|
component IDs to components if return_dict_with_names=False |
Source code in mindone/diffusers/modular_pipelines/components_manager.py
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 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 |
|
mindone.diffusers.modular_pipelines.modular_pipeline_utils.InsertableDict
¶
Bases: OrderedDict
Source code in mindone/diffusers/modular_pipelines/modular_pipeline_utils.py
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 |
|