optimum-rbln 0.9.2rc0__py3-none-any.whl → 0.9.2rc1__py3-none-any.whl

optimum/rbln/__version__.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.9.2rc0'
-__version_tuple__ = version_tuple = (0, 9, 2, 'rc0')
+__version__ = version = '0.9.2rc1'
+__version_tuple__ = version_tuple = (0, 9, 2, 'rc1')
 
 __commit_id__ = commit_id = None

optimum/rbln/transformers/models/colpali/configuration_colpali.py

@@ -28,23 +28,23 @@ class RBLNColPaliForRetrievalConfig(RBLNModelConfig):
     including vision tower settings and multi-sequence length support.
 
     Example usage:
-    ```python
-    from optimum.rbln import RBLNColPaliForRetrieval, RBLNColPaliForRetrievalConfig
-
-    # Create a configuration object
-    config = RBLNColPaliForRetrievalConfig(
-        max_seq_lens=1152,
-        output_hidden_states=False,
-        tensor_parallel_size=4
-    )
-
-    # Use the configuration with from_pretrained
-    model = RBLNColPaliForRetrieval.from_pretrained(
-        "vidore/colpali-v1.3-hf",
-        export=True,
-        rbln_config=config
-    )
-    ```
+        ```python
+        from optimum.rbln import RBLNColPaliForRetrieval, RBLNColPaliForRetrievalConfig
+
+        # Create a configuration object
+        config = RBLNColPaliForRetrievalConfig(
+            max_seq_lens=1152,
+            output_hidden_states=False,
+            tensor_parallel_size=4
+        )
+
+        # Use the configuration with from_pretrained
+        model = RBLNColPaliForRetrieval.from_pretrained(
+            "vidore/colpali-v1.3-hf",
+            export=True,
+            rbln_config=config
+        )
+        ```
     """
 
     submodules = ["vision_tower"]

optimum/rbln/transformers/models/colqwen2/configuration_colqwen2.py

@@ -20,6 +20,37 @@ from ..decoderonly.configuration_decoderonly import RBLNDecoderOnlyModelConfig
 
 
 class RBLNColQwen2ForRetrievalConfig(RBLNDecoderOnlyModelConfig):
+    """
+    Configuration class for RBLN ColQwen2 models for document retrieval.
+
+    This class extends RBLNModelConfig with specific configurations for ColQwen2 models,
+    including vision tower settings and multi-sequence length support.
+
+    Example usage:
+        ```python
+        from optimum.rbln import RBLNColQwen2ForRetrievalConfig, RBLNColQwen2ForRetrievalConfig
+
+        # Create a configuration object
+        config = RBLNColQwen2ForRetrievalConfig(
+            visual={
+                "max_seq_lens": 6400,
+                "device": 0,
+            },
+            max_seq_len=32_768,
+            tensor_parallel_size=4,
+            device=[0, 1, 2, 3],
+            output_hidden_states=False,
+        )
+
+        # Use the configuration with from_pretrained
+        model = RBLNColQwen2ForRetrieval.from_pretrained(
+            "vidore/colqwen2-v1.0-hf",
+            export=True,
+            rbln_config=config
+        )
+        ```
+    """
+
     submodules = ["visual"]
 
     def __init__(

optimum/rbln/transformers/models/colqwen2/modeling_colqwen2.py

@@ -51,6 +51,63 @@ from .colqwen2_architecture import ColQwen2LanguageModelWrapper
 
 
 class RBLNColQwen2ForRetrieval(RBLNDecoderOnlyModel):
+    """
+    The ColQwen Model transformer for document retrieval using vision-language models.
+    This model inherits from [`RBLNDecoderOnlyModel`]. Check the superclass documentation for the generic methods the library implements for all its models.
+
+    A class to convert and run pre-trained transformers based `ColQwen2ForRetrieval` model on RBLN devices.
+    It implements the methods to convert a pre-trained transformers `ColQwen2ForRetrieval` model into a RBLN transformer model by:
+
+    - transferring the checkpoint weights of the original into an optimized RBLN graph,
+    - compiling the resulting graph using the RBLN compiler.
+
+    **Configuration:**
+    This model uses [`RBLNColQwen2ForRetrievalConfig`] for configuration. When calling methods like `from_pretrained` or `from_model`,
+    the `rbln_config` parameter should be an instance of [`RBLNColQwen2ForRetrievalConfig`] or a dictionary conforming to its structure.
+
+    See the [`RBLNColQwen2ForRetrievalConfig`] class for all available configuration options.
+
+    Examples:
+        ```python
+        from optimum.rbln import RBLNColQwen2ForRetrieval
+
+        # Using a config dictionary
+        rbln_config = {
+            "visual": {
+                "max_seq_lens": 6400,
+            },
+            "max_seq_len": 32_768,
+            "tensor_parallel_size": 4,
+            "device": [0, 1, 2, 3],
+            "output_hidden_states": False,
+        }
+        model = RBLNColQwen2ForRetrieval.from_pretrained(
+            "vidore/colqwen2-v1.0-hf",
+            export=True,
+            rbln_config=rbln_config
+        )
+
+        # Using a RBLNColQwen2ForRetrievalConfig instance (recommended for type checking)
+        from optimum.rbln import RBLNColQwen2ForRetrievalConfig
+
+        config = RBLNColQwen2ForRetrievalConfig(
+            visual={
+                "max_seq_lens": 6400,
+                "device": 0,
+            },
+            max_seq_len=32_768,
+            tensor_parallel_size=4,
+            device=[0, 1, 2, 3],
+            output_hidden_states=False,
+        )
+        model = RBLNColQwen2ForRetrieval.from_pretrained(
+            "vidore/colqwen2-v1.0-hf",
+            export=True,
+            rbln_config=config
+        )
+        ```
+    """
+
     main_input_name = "inputs_embeds"
     auto_model_class = None
     _rbln_submodules = [

{optimum_rbln-0.9.2rc0.dist-info → optimum_rbln-0.9.2rc1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: optimum-rbln
-Version: 0.9.2rc0
+Version: 0.9.2rc1
 Summary: Optimum RBLN is the interface between the HuggingFace Transformers and Diffusers libraries and RBLN accelerators. It provides a set of tools enabling easy model loading and inference on single and multiple rbln device settings for different downstream tasks.
 Project-URL: Homepage, https://rebellions.ai
 Project-URL: Documentation, https://docs.rbln.ai

{optimum_rbln-0.9.2rc0.dist-info → optimum_rbln-0.9.2rc1.dist-info}/RECORD

@@ -1,5 +1,5 @@
 optimum/rbln/__init__.py,sha256=ns14slnkiDevAQCeOXQoejSnzfk3WNuie4cyYiMQZSc,18980
-optimum/rbln/__version__.py,sha256=eX7dIgcPHT2s34NRv665o56Hk3CKxWFMF5u_b-pQWPA,714
+optimum/rbln/__version__.py,sha256=WozqVRDHdwcyqBUlRJldKeU9qimFW1KUCZdsg_ks-Fg,714
 optimum/rbln/cli.py,sha256=944P_f9btDyFryHfHzxUKQvwXWYD1hrceDuK6SWNQcQ,22832
 optimum/rbln/configuration_utils.py,sha256=uLjMsWyYz-4SQ2wbvYqDUZcau29EjU-AghF4q1LNGxw,37260
 optimum/rbln/modeling.py,sha256=50BE-bpn-GMImXjQGrG5rqnhofg1DHs6jyS2CzprPBY,16247
@@ -102,12 +102,12 @@ optimum/rbln/transformers/models/clip/configuration_clip.py,sha256=Ea8TCVmMayydf
 optimum/rbln/transformers/models/clip/modeling_clip.py,sha256=BLAYJAtv_2ZnKOlZ8iDBr2Su3bKM_eMWeUSK9MOaj7I,13198
 optimum/rbln/transformers/models/colpali/__init__.py,sha256=n3rueXT_oC0N8myoZiic0YkVK24CW5hZBPa-0L8so6Y,119
 optimum/rbln/transformers/models/colpali/colpali_architecture.py,sha256=TCOW3v5l9fIt1uIFtWa8ZAxq1cdCER8gXWjmbLQD20M,8079
-optimum/rbln/transformers/models/colpali/configuration_colpali.py,sha256=_HuZBVV-ponml95UapkYpRhffZy53-9jSZknx7hID7o,3348
+optimum/rbln/transformers/models/colpali/configuration_colpali.py,sha256=qjaUC7S9kCZBWL9LsXnEo0woxsksPSHJpqA3TRTx6KE,3408
 optimum/rbln/transformers/models/colpali/modeling_colpali.py,sha256=2lHxvtrK3x2GOv7r-5nZelmjezm3ehe6Qf28cMdNmoQ,17961
 optimum/rbln/transformers/models/colqwen2/__init__.py,sha256=gEKc5X4uGME4XKySDD1H6JlT89jaMvZ00HqbDVXNHU8,123
 optimum/rbln/transformers/models/colqwen2/colqwen2_architecture.py,sha256=spIH6d-09asUBSqhuJN9NAK2Ke7Kv1RP7HdwMOcxf_s,8732
-optimum/rbln/transformers/models/colqwen2/configuration_colqwen2.py,sha256=7c31acILXiIeOatZ73YEbgvEAhKACL3KzsLjik-fvII,1691
-optimum/rbln/transformers/models/colqwen2/modeling_colqwen2.py,sha256=jPwu3FPezkBBWLIBMKUfFFsburNBi7JzGX7IyA_yX4U,16362
+optimum/rbln/transformers/models/colqwen2/configuration_colqwen2.py,sha256=_HYOLR2O8xjEJvXn7LRU_BSxdysMXmJ7oEhCLhaG2z0,2649
+optimum/rbln/transformers/models/colqwen2/modeling_colqwen2.py,sha256=Iy5wa3Aa-Vfjv4FTyDvL-KtyGAB9nBuGCPXz_Alv_l0,18598
 optimum/rbln/transformers/models/decoderonly/__init__.py,sha256=pKBXAtE3y_6nnwYfQJjdPmWqUwxuJ0lr8rrqkgyH07M,1126
 optimum/rbln/transformers/models/decoderonly/configuration_decoderonly.py,sha256=GX-IwTe6ywM9hmyquIu66y0YgIVZS5JNIz8LKAb4Ow8,17003
 optimum/rbln/transformers/models/decoderonly/configuration_lora.py,sha256=5DuTs2vy7jF7MLy161QD_KvCTaNW-5Mok7hBH0yK44U,17356
@@ -250,8 +250,8 @@ optimum/rbln/utils/model_utils.py,sha256=4k5879Kh75m3x_vS4-qOGfqsOiAvc2kdNFFfvsF
 optimum/rbln/utils/runtime_utils.py,sha256=Sf0YOUeJkhByArEgqofb_THvFBYdMVIgF_MGvhL4i-w,8540
 optimum/rbln/utils/save_utils.py,sha256=hG5uOtYmecSXZuGTvCXsTM-SiyZpr5q3InUGCCq_jzQ,3619
 optimum/rbln/utils/submodule.py,sha256=SKLnM3KsX8_rv3HauO4oB2-JSjzuadQjRwo_BhMUzLI,6362
-optimum_rbln-0.9.2rc0.dist-info/METADATA,sha256=lQVSk-maixwy-qvGSDnbTyoh2W9sDMJ76nUSN6UaMZ0,5351
-optimum_rbln-0.9.2rc0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-optimum_rbln-0.9.2rc0.dist-info/entry_points.txt,sha256=-orKDGKfLypxlPlTz8-ZkmdKULNvax9yeCCCn-q89n4,59
-optimum_rbln-0.9.2rc0.dist-info/licenses/LICENSE,sha256=QwcOLU5TJoTeUhuIXzhdCEEDDvorGiC6-3YTOl4TecE,11356
-optimum_rbln-0.9.2rc0.dist-info/RECORD,,
+optimum_rbln-0.9.2rc1.dist-info/METADATA,sha256=yxmUuYsEcOT081Qt2J0S_07MHZ4V-QnYPILasp45SiU,5351
+optimum_rbln-0.9.2rc1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+optimum_rbln-0.9.2rc1.dist-info/entry_points.txt,sha256=-orKDGKfLypxlPlTz8-ZkmdKULNvax9yeCCCn-q89n4,59
+optimum_rbln-0.9.2rc1.dist-info/licenses/LICENSE,sha256=QwcOLU5TJoTeUhuIXzhdCEEDDvorGiC6-3YTOl4TecE,11356
+optimum_rbln-0.9.2rc1.dist-info/RECORD,,