optimum-rbln 0.1.15__py3-none-any.whl → 0.2.1a0__py3-none-any.whl

optimum_rbln-0.2.1a0.dist-info/licenses/LICENSE

@@ -0,0 +1,288 @@
+                       Software User License Agreement
+
+This User License Agreement (this "Agreement") is a binding agreement between
+[Rebellions Inc.], a Korean company with its office located at [102-801, 239,
+Jeongjail-ro, Bundang-gu, Seongnam-si, Gyeonggi-do, Republic of Korea], ("Licensor")
+and you, your employer, your employees, or other entity for whose benefit you act as
+applicable, as the licensee of the Software (“You” or "Licensee"). DO NOT download,
+install, access, copy, or use the entirety or any portion of the Software until
+You have read and agreed to the terms and conditions of this Agreement.
+
+Licensor provides the Software solely on the terms and conditions set forth in
+this Agreement and on the condition that Licensee accepts and complies with them.
+By downloading, installing, accessing, copying, or using the Software You
+(a) accept this Agreement and agree that licensee is legally bound by its terms;
+and (b) represent and warrant that: (i) You are of legal age to enter into a
+binding agreement; and (ii) if Licensee is a corporation, governmental organization,
+or other legal entity, You have the right, power, and authority to enter into this
+Agreement on behalf of Licensee and bind Licensee to its terms. If Licensee does
+not agree to the terms of this Agreement, Licensor will not and does not license
+the Software to Licensee and You must not download, install, access, copy, use or
+otherwise utilize the Software or Documentation.
+
+This Agreement expressly excludes any right, concerning any software that Licensee
+did not acquire lawfully or that is not a legitimate, authorized copy of Licensor's
+Software.
+
+  1. Definitions. For purposes of this Agreement, the following terms have the
+    following meanings:
+
+      "Documentation" means user manuals, technical manuals, and any other materials
+      provided by Licensor, in printed, electronic, or other form, that describe the
+      installation, operation, use, or technical specifications of the Software.
+
+      “Hardware” means cloud service provider’s proprietary device(s) supplied by
+      Licensor and used for cloud services and which use right is purchased by
+      Licensee for the purpose of its direct use or to provide subsequent services
+      to end-customers. 
+
+      "Intellectual Property Rights" means any and all registered and unregistered
+      rights granted, applied for, or otherwise now or hereafter in existence under
+      or related to any patent, copyright, trademark, trade secret, database
+      protection, or other intellectual property rights laws, and all similar or
+      equivalent rights or forms of protection, in any part of the world.
+
+      "Licensee" has the meaning set forth in the preamble.
+
+      "Licensor" has the meaning set forth in the preamble.
+
+      "PERSON" MEANS AN INDIVIDUAL, CORPORATION, PARTNERSHIP, JOINT VENTURE, LIMITED
+      LIABILITY COMPANY, GOVERNMENTAL AUTHORITY, UNINCORPORATED ORGANIZATION, TRUST,
+      ASSOCIATION, OR OTHER ENTITY.
+
+      "Software" means any one or more of the developer kits, libraries, runtimes
+      and drivers, together with any necessary updates and accompanying Documentation,
+      that are provided by Licensor in connection with the use and/or implementation
+      of one or more of Hardware as provided under this Agreement, excluding any
+      Third Party files, programs, or other materials.
+
+      "Term" has the meaning set forth in Section 11.
+
+      "Third Party" means any Person other than Licensee or Licensor.
+
+  2. License Grant and Scope. Subject to and conditioned upon Licensee's strict
+    compliance with all terms and conditions set forth in this Agreement, Licensor
+    hereby grants to Licensee a non-exclusive, non-transferable, non-sublicensable,
+    limited license during the Term to use the Software and Documentation, solely
+    as set forth in this Section 2 and subject to all conditions and limitations set
+    forth in Section 3 or elsewhere in this Agreement. This license grants Licensee to:
+
+      (a) Download, access, copy, and install in accordance with the Documentation
+      one (1) copy of the Software on one (1) computer owned or leased, and controlled
+      by,Licensee for the sole purpose of utilizing the Hardware. Each such computer
+      shall be for a single user authorized by Licensee, unless agreed otherwise. All
+      copies of the Software made by the Licensee:
+
+        (i) will be the exclusive property of the Licensor;
+
+        (ii) will be subject to the terms and conditions of this Agreement; and 
+
+        (iii) must include all trademark, copyright, patent, and other Intellectual
+        Property Rights notices contained in the original.
+
+      (b) Use and run the Software as properly installed in accordance with this
+      Agreement and the Documentation, solely as set forth in the Documentation and
+      solely for Licensee's internal business purposes. No source code of the Software
+      shall be made available or accessible to the Licensee except to the extent
+      explicitly permitted and necessary for Licensee’s use of the Software under
+      this Agreement.
+
+  3. Use Restrictions. Licensee shall not, and shall require its authorized users not
+    to, directly or indirectly:
+
+    (a) use (including make any copies of) the Software or Documentation beyond the
+    scope of the license granted under Section 2;
+
+    (b) use the Software separately from the Hardware except explicitly permitted
+    by the Licensor or independently agreed between Licensor and Licensee;
+
+    (c) provide any other Person, including any subcontractor, independent contractor,
+    affiliate, or service provider of Licensee, with access to or use of the Software
+    or Documentation;
+
+    (d) modify, translate, adapt, or otherwise create derivative works or improvements,
+    whether or not patentable, of the Software or Documentation or any part thereof;
+
+    (e) combine the Software or any part thereof with, or incorporate the Software or
+    any part thereof in, any other programs;
+
+    (f) reverse engineer, disassemble, decompile, decode, or otherwise attempt to
+    derive or gain access to the source code of the Software or any part thereof;
+
+    (g) remove, delete, alter, or obscure any trademarks or any copyright, trademark,
+    patent, or other intellectual property or proprietary rights notices provided on
+    or with the Software or Documentation, including any copy thereof;
+
+    (h) except as expressly set forth in Section 2(a), copy the Software or
+    Documentation, in whole or in part;
+
+    (i) rent, lease, lend, sell, sublicense, assign, distribute, publish, transfer,
+    or otherwise make available the Software, or any features or functionality of the
+    Software, to any unauthorized Third Party by any way for any reason;
+
+    (j) use the Software or Documentation in, or in association with, the design,
+    construction, maintenance, or operation of any hazardous environments or systems; 
+
+    (k) use the Software or Documentation in violation of any law, regulation, or rule; or
+
+    (l) use the Software or Documentation for purposes of competitive analysis of the
+    Software, the development of a competing software product or service, or any other
+    purpose that is to the Licensor's commercial disadvantage.
+
+  4. Responsibility for Use of Software. Licensee is responsible and liable for all uses
+    of the Software and Documentation through access thereto provided by Licensee, directly
+    or indirectly. Specifically, and without limiting the generality of the foregoing,
+    Licensee is responsible and liable for all actions and failures to take required
+    actions with respect to the Software and Documentation by any Person to whom Licensee
+    may provide access to or use of the Software and/or Documentation, whether such access
+    or use is permitted by or in violation of this Agreement.
+
+  5. Maintenance and Support Package. Licensee acknowledges that the scope of this Agreement
+    does not include any right for Licensee to receive maintenance, support, or mapping
+    services with regard to the Software. Licensor has full discretion to offer maintenance,
+    support, and/or mapping services for the Software on a separate subscription basis (the
+    “Support Subscription”). 
+
+  6. Intellectual Property Rights. Licensee acknowledges and agrees that the Software and
+    Documentation are provided under license, and not sold, to Licensee. Licensee does not
+    acquire any ownership interest in the Software or Documentation under this Agreement,
+    or any other rights thereto, other than to use the same in accordance with the license
+    granted and subject to all terms, conditions, and restrictions under this Agreement.
+    Licensor and its licensors and service providers reserve and shall retain their entire
+    right, title, and interest in and to the Software and all Intellectual Property Rights
+    arising out of or relating to the Software, except as expressly granted to the Licensee
+    in this Agreement. Licensee shall safeguard all Software (including all copies thereof)
+    from infringement, misappropriation, theft, misuse, or unauthorized access. 
+
+  7. Term and Termination.
+
+    (a) This Agreement and the license granted hereunder shall remain in effect until
+    terminated as set forth herein (the "Term").
+
+    (b) Licensor may terminate this Agreement, effective immediately, if its separate
+    agreement for use of the Hardware is terminated.
+
+    (c) Licensor may terminate this Agreement without cause and effective immediately
+    upon written notice to Licensee. 
+
+    (d) Licensor may terminate this Agreement, effective upon notice to Licensee, if 
+    Licensee fails to comply with any of the terms and conditions in this Agreement
+    during the Term.
+
+    (e) Upon expiration or termination of this Agreement, the license granted hereunder
+    shall also terminate, and Licensee shall cease using and destroy all copies of the
+    Software and Documentation. 
+
+    (f) Licensor may suspend the Software licensed hereunder or terminate this Agreement,
+    if the Licensee commences, participates or threatens to commence or participate in
+    any legal proceeding against Licensor.
+
+  8. Exclusion of Warranties. The Software is provided “as is” without any express or
+    implied warranty of any kind, including warranties of merchantability, non-infringement,
+    or fitness for a particular purpose. Licensor does not warrant or assume responsibility
+    for the accuracy or completeness of any information, text, graphics, links, or other
+    items within the Software. 
+
+  9. Limitation of Liability. TO THE FULLEST EXTENT PERMITTED UNDER APPLICABLE LAW:
+
+    (a) IN NO EVENT WILL LICENSOR OR ITS AFFILIATES, OR ANY OF ITS OR THEIR RESPECTIVE
+    LICENSORS OR SERVICE PROVIDERS, BE LIABLE TO LICENSEE OR ANY THIRD PARTY FOR ANY USE,
+    INTERRUPTION, DELAY, OR INABILITY TO USE THE SOFTWARE; LOST REVENUES OR PROFITS;
+    DELAYS, INTERRUPTION, OR LOSS OF SERVICES, BUSINESS, OR GOODWILL; LOSS OR CORRUPTION
+    OF DATA; LOSS RESULTING FROM SYSTEM OR SYSTEM SERVICE FAILURE, MALFUNCTION, OR
+    SHUTDOWN; FAILURE TO ACCURATELY TRANSFER, READ, OR TRANSMIT INFORMATION; FAILURE TO
+    UPDATE OR PROVIDE CORRECT INFORMATION; SYSTEM INCOMPATIBILITY OR PROVISION OF INCORRECT
+    COMPATIBILITY INFORMATION; OR BREACHES IN SYSTEM SECURITY; OR FOR ANY CONSEQUENTIAL,
+    INCIDENTAL, INDIRECT, EXEMPLARY, SPECIAL, OR PUNITIVE DAMAGES, WHETHER ARISING OUT
+    OF OR IN CONNECTION WITH THIS AGREEMENT, BREACH OF CONTRACT, TORT (INCLUDING NEGLIGENCE),
+    OR OTHERWISE, REGARDLESS OF WHETHER SUCH DAMAGES WERE FORESEEABLE AND WHETHER OR NOT THE
+    LICENSOR WAS ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+    (b) THE LIMITATIONS SET FORTH IN SECTION 9(a) SHALL APPLY EVEN IF THE LICENSEE'S
+    REMEDIES UNDER THIS AGREEMENT FAIL OF THEIR ESSENTIAL PURPOSE.
+
+  10. Open Source Statement. The Software may include open source software (“OSS”) licensed
+    pursuant to OSS license agreement(s) identified in the OSS comments in the applicable
+    source code file(s) or file header(s) provided with or otherwise associated with the
+    Software. Neither Licensee nor any OEM, ODM, customer, distributor or other end user
+    may subject any proprietary portion of the Software to any OSS license obligations
+    including, without limitation, combining or distributing the Software with OSS in a
+    manner that subjects Licensee, the Software or any portion thereof to any OSS license
+    obligation. Nothing in this Agreement limits any rights under, or grants rights that
+    supersede, the terms of any applicable OSS license.
+
+  11. Export Regulation. The Software and Documentation may be subject to export control
+    laws of relevant jurisdictions. The Licensee shall not, directly or indirectly, export,
+    re-export, or release the Software or Documentation to, or make the Software or
+    Documentation accessible from, any jurisdiction or country to which export, re-export,
+    or release is prohibited by law, rule, or regulation. The Licensee shall comply with
+    all applicable laws, regulations, and rules, and complete all required undertakings
+    (including obtaining any necessary export license or other governmental approval),
+    prior to exporting, re-exporting, releasing, or otherwise making the Software or
+    Documentation available outside the Republic of Korea.
+
+  12. Miscellaneous.
+
+    (a) This Agreement and any dispute arising out of or relating to it will be governed
+    by the laws of the Republic of Korea, without regard to conflict of laws principles.
+    The Parties exclude the application of the United Nations Convention on Contracts for
+    the International Sale of Goods (1980). The Seoul Central District Court will have
+    exclusive jurisdiction over any dispute arising out of or relating to this Agreement.
+    The Parties consent to personal jurisdiction and venue in the aforementioned court.
+    A Party that obtains a judgment against the other Party in the courts identified in
+    this section may enforce that judgment in any court that has jurisdiction over the
+    Parties.
+
+    (b) Licensor will not be responsible or liable to Licensee, or deemed in default or
+    breach hereunder by reason of any failure or delay in the performance of its obligations
+    hereunder where such failure or delay is due to strikes, labor disputes, civil
+    disturbances, riot, rebellion, invasion, epidemic, hostilities, war, terrorist attack,
+    embargo, natural disaster, acts of God, flood, fire, sabotage, fluctuations or
+    non-availability of electrical power, heat, light, air conditioning, or Licensee
+    equipment, loss and destruction of property, or any other circumstances or causes
+    beyond Licensor's reasonable control.
+
+    (c) This Agreement, together with all annexes, schedules, and exhibits attached hereto
+    and all other documents that are incorporated by reference herein, constitutes the sole
+    and entire agreement between Licensee and Licensor with respect to the subject matter
+    contained herein, and supersedes all prior and contemporaneous understandings,
+    agreements, representations, and warranties, both written and oral, with respect to
+    such subject matter. 
+
+    (d) Licensee shall not assign or otherwise transfer any of its rights, or delegate or
+    otherwise transfer any of its obligations or performance, under this Agreement, in
+    each case whether voluntarily, involuntarily, by operation of law, or otherwise,
+    without Licensor's prior written consent, which consent Licensor may give or withhold
+    in its sole discretion. For purposes of the preceding sentence, and without limiting
+    its generality, any merger, consolidation, or reorganization involving Licensee
+    (regardless of whether Licensee is a surviving or disappearing entity) will be deemed
+    to be a transfer of rights, obligations, or performance under this Agreement for which
+    Licensor's prior written consent is required. No delegation or other transfer will
+    relieve Licensee of any of its obligations or performance under this Agreement.
+    Any purported assignment, delegation, or transfer in violation of this Section is void.
+    Licensor may freely assign or otherwise transfer all or any of its rights, or delegate
+    or otherwise transfer all or any of its obligations or performance, under this Agreement
+    without Licensee's consent. This Agreement is binding upon and inures to the benefit
+    of the parties hereto and their respective permitted successors and assigns.
+
+    (e) This Agreement is for the sole benefit of the parties hereto and their respective
+    successors and permitted assigns and nothing herein, express or implied, is intended
+    to or shall confer on any other Person any legal or equitable right, benefit, or remedy
+    of any nature whatsoever under or by reason of this Agreement.
+
+    (f) No waiver by any party of any of the provisions hereof shall be effective unless
+    explicitly set forth in writing and signed by the party so waiving. Except as otherwise
+    set forth in this Agreement, no failure to exercise, or delay in exercising, any right,
+    remedy, power, or privilege arising from this Agreement shall operate or be construed
+    as a waiver thereof; nor shall any single or partial exercise of any right, remedy,
+    power, or privilege hereunder preclude any other or further exercise thereof or the
+    exercise of any other right, remedy, power, or privilege.
+
+    (g) If any term or provision of this Agreement is invalid, illegal, or unenforceable in
+    any jurisdiction, such invalidity, illegality, or unenforceability shall not affect
+    any other term or provision of this Agreement or invalidate or render unenforceable
+    such term or provision in any other jurisdiction.
+
+    (h) The headings in this Agreement are for reference only and do not affect the
+    interpretation of this Agreement.
+

optimum/rbln/transformers/cache_utils.py

@@ -1,107 +0,0 @@
-from typing import Optional, Tuple
-
-import torch
-from transformers.cache_utils import DynamicCache
-
-
-class RebelDynamicCache(DynamicCache):
-    """
-    A cache that grows dynamically as more tokens are generated. This is the default for generative models.
-
-    It stores the Key and Value states as a list of tensors, one for each layer. The expected shape for each tensor is
-    `[batch_size, num_heads, seq_len, head_dim]`.
-    """
-
-    def __init__(self, position_ids) -> None:
-        super().__init__()
-        # batch, _ = position_ids.shape
-        # current_steps = [position_ids[b][0] for b in range(batch)]
-        self.current_steps = position_ids[:, 0]
-
-    def assign(
-        self,
-        key_states: torch.Tensor,
-        value_states: torch.Tensor,
-        layer_idx: int,
-    ) -> None:
-        self.key_cache[layer_idx] = key_states.squeeze(2)
-        self.value_cache[layer_idx] = value_states.squeeze(2)
-
-    def update(
-        self,
-        key_states: torch.Tensor,
-        value_states: torch.Tensor,
-        layer_idx: int,
-        batch_idx: int,
-        read_first_step: Optional[bool] = False,
-    ) -> Tuple[torch.Tensor, torch.Tensor]:
-        """
-        Updates the cache with the new `key_states` and `value_states` for the layer `layer_idx` and the batch 'batch_inx'
-        based on self.current_step,
-        """
-        current_step = self.current_steps[0 if read_first_step else batch_idx]
-        kend = current_step + key_states.shape[-2]
-        vend = current_step + value_states.shape[-2]
-        update_key_states = (
-            self.key_cache[layer_idx][batch_idx]
-            .unsqueeze(0)
-            .unsqueeze(2)
-            .slice_scatter(key_states, dim=-2, start=current_step, end=kend)
-        )
-        update_value_states = (
-            self.value_cache[layer_idx][batch_idx]
-            .unsqueeze(0)
-            .unsqueeze(2)
-            .slice_scatter(value_states, dim=-2, start=current_step, end=vend)
-        )
-
-        return update_key_states, update_value_states
-
-    @classmethod
-    def from_input_format(cls, position_ids, num_hidden_layer, *past_key_values) -> "DynamicCache":
-        """Converts a cache in the rbln cache format (list of past_kv) into an equivalent `DynamicCache`."""
-        cache = cls(position_ids)
-        for layer_idx in range(num_hidden_layer):
-            key_states = past_key_values[layer_idx * 2]
-            value_states = past_key_values[layer_idx * 2 + 1]
-            cache.key_cache.append(key_states)
-            cache.value_cache.append(value_states)
-
-        return cache
-
-
-class RebelDynamicCache_4D(RebelDynamicCache):
-    def assign(
-        self,
-        keys: torch.Tensor,
-        values: torch.Tensor,
-        layer_idx: int,
-    ) -> None:
-        self.key_cache[layer_idx] = keys
-        self.value_cache[layer_idx] = values
-
-    def update(
-        self,
-        keys: torch.Tensor,
-        values: torch.Tensor,
-        layer_idx: int,
-        batch_idx: int,
-        read_first_step: Optional[bool] = False,
-    ) -> Tuple[torch.Tensor, torch.Tensor]:
-        """
-        Updates the cache with the new `keys` and `values` for the layer `layer_idx` and the batch 'batch_inx'
-        based on self.current_step,
-        """
-        current_step = self.current_steps[0 if read_first_step else batch_idx]
-        kend = current_step + keys.shape[-2]
-        vend = current_step + values.shape[-2]
-        update_keys = (
-            self.key_cache[layer_idx][batch_idx].unsqueeze(0).slice_scatter(keys, dim=-2, start=current_step, end=kend)
-        )
-        update_values = (
-            self.value_cache[layer_idx][batch_idx]
-            .unsqueeze(0)
-            .slice_scatter(values, dim=-2, start=current_step, end=vend)
-        )
-
-        return update_keys, update_values

optimum/rbln/utils/timer_utils.py

@@ -1,43 +0,0 @@
-import os
-from datetime import datetime
-
-from halo import Halo
-
-from .logging import get_logger
-
-
-logger = get_logger()
-
-
-def rbln_timer(print_name):
-    def decorator(function):
-        def wrapper(*args, **kwargs):
-            disable = os.getenv("OPTIMUM_RBLN_DISABLE_SPIN", "False").lower() in ("true", "1", "t")
-            if disable:
-                logger.info(f"{print_name} ...")
-
-            spinner = Halo(text=f"{print_name} ...", spinner="dots", color="green", enabled=(not disable))
-            spinner.start()
-
-            # Start timer
-            tick = datetime.now()
-            try:
-                result = function(*args, **kwargs)
-            except Exception as e:
-                spinner.fail(f"{print_name} failed.")
-                raise e
-
-            # Print elapsed time.
-            if disable:
-                logger.info(f"{print_name} done. Elasped time: {format_elapsed_time(tick)}")
-
-            spinner.stop()
-            spinner.succeed(text=f"{print_name} done. Elasped time: {format_elapsed_time(tick)}")
-            return result
-
-        return wrapper
-
-    def format_elapsed_time(start_time: datetime) -> str:
-        return str(datetime.now() - start_time)[:7]
-
-    return decorator

optimum_rbln-0.1.15.dist-info/METADATA

@@ -1,106 +0,0 @@
-Metadata-Version: 2.3
-Name: optimum-rbln
-Version: 0.1.15
-Summary: Optimum RBLN is the interface between the Hugging Face 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
-Author-email: "Rebellions Inc." <support@rebellions.ai>
-License: Apache
-Keywords: atom,diffusers,inference,rbln,rebel,transformers
-Classifier: Development Status :: 2 - Pre-Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Education
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Operating System :: POSIX :: Linux
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
-Requires-Python: <3.13,>=3.9
-Requires-Dist: accelerate>=1.0.1
-Requires-Dist: diffusers<=0.31.0
-Requires-Dist: einops>=0.8.0
-Requires-Dist: halo>=0.0.31
-Requires-Dist: packaging>=24.1
-Requires-Dist: torch<=2.5.1
-Requires-Dist: torchaudio<=2.5.1
-Requires-Dist: torchvision<=0.20.1
-Requires-Dist: transformers==4.45.2
-Description-Content-Type: text/markdown
-
-
-# Optimum RBLN
-
-<div align="center">
-
-<img src="assets/rbln_logo.png" width="60%"/>
-
-[![PyPI version](https://badge.fury.io/py/optimum-rbln.svg)](https://badge.fury.io/py/optimum-rbln)
-[![License](https://img.shields.io/github/license/rebellions-sw/optimum-rbln)](https://github.com/rebellions-sw/optimum-rbln/blob/main/LICENSE)
-
-</div>
-
-🤗 Optimum RBLN provides an interface between Hugging Face libraries ([Transformers](https://huggingface.co/docs/transformers), [Diffusers](https://huggingface.co/docs/diffusers/index)) and RBLN Accelerators, including [ATOM](https://rebellions.ai/rebellions-product/rbln-ca25/) and [REBEL](https://rebellions.ai/rebellions-product/rebel/).
-
-This library enables seamless integration between the Hugging Face ecosystem and RBLN's NPU acceleration through a comprehensive toolkit for model loading and inference across single- and multi-Accelerator environments. While we maintain a list of [officially validated models and tasks](https://docs.rbln.ai/software/optimum/optimum_rbln.html), users can easily adapt other models and tasks with minimal modifications.
-
-## Key Features
-
-🚀 **High Performance Inference**
-- Optimized model execution on RBLN NPUs through RBLN SDK compilation
-- Support for both single-NPU and multi-NPU inference
-- Integrated with RBLN Runtime for optimal performance
-
-🔧 **Easy Integration**
-- Seamless compatibility with Huggingface model hub
-- Drop-in replacement for existing Huggingface pipelines
-- Minimal code changes required for NPU acceleration
-
-
-## Documentation
-
-Check out [the documentation of Optimum RBLN](https://docs.rbln.ai/software/optimum/optimum_rbln.html) for more advanced usage.
-
-## Getting Started
-
-### Install from PyPI
-
-To install the latest release of this package:
-
-- Export environment variables to access to RBLN private PyPI.
-  ```bash
-  export REBEL_PYPI_USERNAME=<username>
-  export REBEL_PYPI_PASSWORD=<password>
-  ```
-
-- Install optimum-rbln package:
-  ```bash
-  pip install --index-url https://pypi.rebellions.in/simple optimum-rbln
-  ```
-
-### Install from source
-
-#### Prerequisites
-
-- Install [uv](https://docs.astral.sh/uv/) (refer [this link](https://docs.astral.sh/uv/getting-started/installation/) for detailed commands)
-
-The below command installs optimum-rbln along with its dependencies.
-
-```bash
-git clone https://github.com/rebellions-sw/optimum-rbln.git
-cd optimum-rbln
-./scripts/uv-sync.sh
-```
-
-If you want to install local rebel-compiler as editable mode in uv environment,
-```bash
-uv pip install -e /path/to/rebel_compiler/python
-```
-
-### Need Help?
-
-- Join our [Developer Community](https://discuss.rebellions.ai/)
-- Contact maintainers at [support@rebellions.ai](mailto:support@rebellions.ai)