콘텐츠로 이동

ResNet

ResNet(Residual Networks)은 층이 깊은 네트워크에서 기울기 소실 문제를 해결하기 위해 스킵 연결을 도입한 컨볼루션 신경망 아키텍처입니다. 이미지 분류와 특징 추출 작업에 널리 사용됩니다. RBLN Optimum을 사용하면 RBLN NPU에서 ResNet 모델 추론을 가속할 수 있습니다.

API 참조

RBLNResNetForImageClassification

Bases: RBLNModelForImageClassification

RBLN optimized ResNet model for image classification tasks.

This class provides hardware-accelerated inference for ResNet models on RBLN devices, supporting image classification with convolutional neural networks designed for computer vision tasks.

forward(pixel_values, output_hidden_states=None, return_dict=None, **kwargs)

Foward pass for the RBLN-optimized ResNet model for image classification.

Parameters:

Name Type Description Default
pixel_values torch.FloatTensor of shape (batch_size, channels, height, width)

The tensors corresponding to the input images.

 required
output_hidden_states bool, *optional*, defaults to False

Whether or not to return the hidden states of all layers. See hidden_states under returned tensors for more details.

 None
return_dict bool, *optional*, defaults to True

Whether to return a dictionary of outputs.

 None

Returns:

Type Description
tuple | ImageClassifierOutputWithNoAttention

The model outputs. If return_dict=False is passed, returns a tuple of tensors. Otherwise, returns a ImageClassifierOutputWithNoAttention object.

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 | ModelMixin

The PyTorch model to be compiled. The object must be a HuggingFace transformers PreTrainedModel or a Diffusers component based on diffusers.ModelMixin, such as a VAE, UNet or ControlNet.

 required
config PretrainedConfig | None

The configuration object associated with the model.

 None
rbln_config RBLNModelConfig | dict | None

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., RBLNLlamaForCausalLMConfig for Llama models). For detailed configuration options, see the specific model's configuration class documentation.

 None
kwargs Any

Additional keyword arguments. Arguments with the prefix rbln_ are passed to rbln_config, while the remaining arguments are passed to the HuggingFace library.

 {}

The method performs the following steps:

  1. Compiles the PyTorch model into an optimized RBLN graph
  2. Configures the model for the specified NPU device
  3. Creates the necessary runtime objects if requested
  4. Saves the compiled model and configurations

Returns:

Type Description
RBLNModel

A RBLN model instance ready for inference on RBLN NPU devices.

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 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 bool | None

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 dict | RBLNModelConfig | None

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., RBLNLlamaForCausalLMConfig for Llama models). For detailed configuration options, see the specific model's configuration class documentation.

 None
kwargs Any

Additional keyword arguments. Arguments with the prefix rbln_ are passed to rbln_config, while the remaining arguments are passed to the HuggingFace library.

 {}

Returns:

Type Description
RBLNModel

A RBLN model instance ready for inference on RBLN NPU devices.

get_hf_class() classmethod

Lazily load and cache the HuggingFace class this model wraps.

The class is looked up in hf_library_name under the name without the RBLN prefix (e.g. RBLNLlamaForCausalLM -> LlamaForCausalLM).

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 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

RBLNResNetForImageClassificationConfig

Bases: RBLNModelForImageClassificationConfig

Configuration class for RBLNResNetForImageClassification.

This configuration class stores the configuration parameters specific to RBLN-optimized ResNet models for image classification tasks.

__init__(image_size=None, batch_size=None, output_hidden_states=None, **kwargs)

Parameters:

Name Type Description Default
image_size int | tuple[int, int] | None

The size of input images. Can be an integer for square images or a tuple (height, width).

 None
batch_size int | None

The batch size for inference. Defaults to 1.

 None
output_hidden_states bool

Whether or not to return the hidden states of all layers.

 None
kwargs Any

Additional arguments passed to the parent RBLNModelConfig.

 {}

Raises:

Type Description
ValueError

If batch_size is not a positive integer.

initialize_submodule_config(submodule_config=None, force_kwargs=False, **kwargs)

Build the config of a submodule from the parent's runtime options and kwargs.

Returns the submodule config instance when its class is known (an instance was passed, or cls_name was given), otherwise the merged kwargs dict for the model class to resolve later.

get_load_overrides()

Extract the options that must cross the load boundary, for passing to from_pretrained.

Returns the explicitly-set runtime options (device, device_map, create_runtimes, activate_profiler, timeout) and the subclass-specific non-save attributes (load-behavior flags such as _load_visual_runtime, which are never serialized so they can only travel with the caller), recursively including submodules. Compile-time attributes are not included: when loading a compiled model they come from the artifact's rbln_config.json, and this dict is merged on top of it.

Returns:

Type Description
dict[str, Any]

Dictionary of load overrides, keyed like the rbln_config dict accepted by from_pretrained.

from_pretrained(path, rbln_config=None, return_unused_kwargs=False, **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
rbln_config dict[str, Any] | None

Additional configuration to override.

 None
return_unused_kwargs bool

Whether to return unused kwargs.

 False
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 Self | tuple[Self, dict[str, Any]]

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.

Examples:

1
config = RBLNResNetForImageClassificationConfig.from_pretrained("/path/to/model")