VQModel (Vector Quantized Model)¶
VQModel(Vector Quantized Model)은 Kandinsky V2.2와 같은 확산 모델에서 자주 사용됩니다. VAE(Variational Autoencoder)와 유사하게 작동하지만 연속적인 잠재 공간 대신 벡터 양자화를 사용합니다. 이미지를 이산적인 잠재 표현으로 인코딩하고 이러한 표현을 다시 이미지로 디코딩하는 역할을 합니다. RBLN NPU는 Optimum RBLN을 사용하여 VQModel 추론을 가속화할 수 있습니다.
API 참조¶
Classes¶
RBLNVQModel
¶
Bases: RBLNModel
RBLN implementation of VQModel for diffusion models.
This model is used to accelerate VQModel models from diffusers library on RBLN NPUs. It can be configured to include both encoder and decoder, or just the decoder part for latent-to-image conversion.
This class inherits from [RBLNModel
]. Check the superclass documentation for the generic methods
the library implements for all its models.
Functions¶
from_model(model, config=None, rbln_config=None, model_save_dir=None, subfolder='', **kwargs)
classmethod
¶
Converts and compiles a pre-trained HuggingFace library model into a RBLN model. This method performs the actual model conversion and compilation process.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model
|
PreTrainedModel
|
The PyTorch model to be compiled. The object must be an instance of the HuggingFace transformers PreTrainedModel class. |
required |
config
|
Optional[PretrainedConfig]
|
The configuration object associated with the model. |
None
|
rbln_config
|
Optional[Union[RBLNModelConfig, Dict]]
|
Configuration for RBLN model compilation and runtime.
This can be provided as a dictionary or an instance of the model's configuration class (e.g., |
None
|
kwargs
|
Any
|
Additional keyword arguments. Arguments with the prefix |
{}
|
The method performs the following steps:
- Compiles the PyTorch model into an optimized RBLN graph
- Configures the model for the specified NPU device
- Creates the necessary runtime objects if requested
- Saves the compiled model and configurations
Returns:
Type | Description |
---|---|
RBLNModel
|
A RBLN model instance ready for inference on RBLN NPU devices. |
encode(x, return_dict=True, **kwargs)
¶
Encode an input image into a quantized latent representation.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
x
|
FloatTensor
|
The input image to encode. |
required |
return_dict
|
bool
|
Whether to return output as a dictionary. Defaults to True. |
True
|
kwargs
|
Any
|
Additional arguments to pass to the encoder/quantizer. |
{}
|
Returns:
Type | Description |
---|---|
Union[FloatTensor, VQEncoderOutput]
|
The quantized latent representation or a specific output object. |
decode(h, return_dict=True, **kwargs)
¶
Decode a quantized latent representation back into an image.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
h
|
FloatTensor
|
The quantized latent representation to decode. |
required |
return_dict
|
bool
|
Whether to return output as a dictionary. Defaults to True. |
True
|
kwargs
|
Any
|
Additional arguments to pass to the decoder. |
{}
|
Returns:
Type | Description |
---|---|
Union[FloatTensor, DecoderOutput]
|
The decoded image or a DecoderOutput object. |
from_pretrained(model_id, export=None, rbln_config=None, **kwargs)
classmethod
¶
The from_pretrained()
function is utilized in its standard form as in the HuggingFace transformers library.
User can use this function to load a pre-trained model from the HuggingFace library and convert it to a RBLN model to be run on RBLN NPUs.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model_id
|
Union[str, Path]
|
The model id of the pre-trained model to be loaded. It can be downloaded from the HuggingFace model hub or a local path, or a model id of a compiled model using the RBLN Compiler. |
required |
export
|
Optional[bool]
|
A boolean flag to indicate whether the model should be compiled. If None, it will be determined based on the existence of the compiled model files in the model_id. |
None
|
rbln_config
|
Optional[Union[Dict, RBLNModelConfig]]
|
Configuration for RBLN model compilation and runtime.
This can be provided as a dictionary or an instance of the model's configuration class (e.g., |
None
|
kwargs
|
Any
|
Additional keyword arguments. Arguments with the prefix |
{}
|
Returns:
Type | Description |
---|---|
RBLNModel
|
A RBLN model instance ready for inference on RBLN NPU devices. |
save_pretrained(save_directory, push_to_hub=False, **kwargs)
¶
Saves a model and its configuration file to a directory, so that it can be re-loaded using the
[~optimum.rbln.modeling_base.RBLNBaseModel.from_pretrained
] class method.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
save_directory
|
Union[str, Path]
|
Directory where to save the model file. |
required |
push_to_hub
|
bool
|
Whether or not to push your model to the HuggingFace model hub after saving it. |
False
|
Functions¶
Classes¶
RBLNVQModelConfig
¶
Bases: RBLNModelConfig
Configuration class for RBLN VQModel models, used in Kandinsky.
This class inherits from RBLNModelConfig and provides specific configuration options for VQModel, which acts similarly to a VAE but uses vector quantization.
Functions¶
__init__(batch_size=None, sample_size=None, uses_encoder=None, vqmodel_scale_factor=None, in_channels=None, latent_channels=None, **kwargs)
¶
Parameters:
Name | Type | Description | Default |
---|---|---|---|
batch_size
|
Optional[int]
|
The batch size for inference. Defaults to 1. |
None
|
sample_size
|
Optional[Tuple[int, int]]
|
The spatial dimensions (height, width) of the input/output images. If an integer is provided, it's used for both height and width. |
None
|
uses_encoder
|
Optional[bool]
|
Whether to include the encoder part of the VAE in the model. When False, only the decoder is used (for latent-to-image conversion). |
None
|
vqmodel_scale_factor
|
Optional[float]
|
The scaling factor between pixel space and latent space. Determines the downsampling ratio between original images and latent representations. |
None
|
in_channels
|
Optional[int]
|
Number of input channels for the model. |
None
|
latent_channels
|
Optional[int]
|
Number of channels in the latent space. |
None
|
kwargs
|
Any
|
Additional arguments passed to the parent RBLNModelConfig. |
{}
|
Raises:
Type | Description |
---|---|
ValueError
|
If batch_size is not a positive integer. |
load(path, **kwargs)
classmethod
¶
Load a RBLNModelConfig from a path.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path
|
str
|
Path to the RBLNModelConfig file or directory containing the config file. |
required |
kwargs
|
Any
|
Additional keyword arguments to override configuration values. Keys starting with 'rbln_' will have the prefix removed and be used to update the configuration. |
{}
|
Returns:
Name | Type | Description |
---|---|---|
RBLNModelConfig |
RBLNModelConfig
|
The loaded configuration instance. |
Note
This method loads the configuration from the specified path and applies any provided overrides. If the loaded configuration class doesn't match the expected class, a warning will be logged.