Skip to main content

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 description

Optimum RBLN

PyPI version License Documentation Contributor Covenant

🤗 Optimum RBLN provides an interface between HuggingFace libraries (Transformers, Diffusers) and RBLN NPUs, including ATOM and REBEL.

This library enables seamless integration between the HuggingFace ecosystem and RBLN NPUs through a comprehensive toolkit for model loading and inference across single and multi-NPU environments. While we maintain a list of officially validated models and tasks, 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 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

Seamless Replacement for Existing HuggingFace Code

- from diffusers import StableDiffusionXLPipeline
+ from optimum.rbln import RBLNStableDiffusionXLPipeline

# Load model
model_id = "stabilityai/stable-diffusion-xl-base-1.0"
prompt = "Astronaut in a jungle, cold color palette, muted colors, detailed, 8k"
- pipe = StableDiffusionXLPipeline.from_pretrained(model_id)
+ pipe = RBLNStableDiffusionXLPipeline.from_pretrained(model_id, export=True)

# Generate image
image = pipe(prompt).images[0]

# Save image result
image.save("image.png")

+ # (Optional) Save compiled artifacts to skip the compilation step in future runs
+ pipe.save_pretrained("compiled_sdxl")

Documentation

Check out the documentation of Optimum RBLN for more advanced usage.

Getting Started

Note: The rebel-compiler library, which is required for running optimum-rbln, is only available for approved users. Please refer to the installation guide for instructions on accessing and installing rebel-compiler.

Install from PyPI

To install the latest release of this package:

pip install optimum-rbln

# CPU-only installation (recommended if you don't plan to use CUDA-enabled PyTorch)
pip install optimum-rbln --extra-index-url https://download.pytorch.org/whl/cpu

Install from source

Prerequisites

  • Install uv (refer to this link for detailed commands)

The below command installs optimum-rbln along with its dependencies.

git clone https://github.com/rebellions-sw/optimum-rbln.git
cd optimum-rbln
./scripts/uv-sync.sh

Need Help?

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

optimum_rbln-0.9.4a3.tar.gz (523.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

optimum_rbln-0.9.4a3-py3-none-any.whl (531.4 kB view details)

Uploaded Python 3

File details

Details for the file optimum_rbln-0.9.4a3.tar.gz.

File metadata

  • Download URL: optimum_rbln-0.9.4a3.tar.gz
  • Upload date:
  • Size: 523.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for optimum_rbln-0.9.4a3.tar.gz
Algorithm Hash digest
SHA256 21a5d053ef2bd3915864a87340f8c580f4256be14376aa90fbdce38f06f6150e
MD5 a23c718bb9826c0501b43fe72c71b62f
BLAKE2b-256 53734df2e6630aa2cc10471c8a46f9ae470c5c4553f476cc6857e6399bb54b82

See more details on using hashes here.

File details

Details for the file optimum_rbln-0.9.4a3-py3-none-any.whl.

File metadata

  • Download URL: optimum_rbln-0.9.4a3-py3-none-any.whl
  • Upload date:
  • Size: 531.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for optimum_rbln-0.9.4a3-py3-none-any.whl
Algorithm Hash digest
SHA256 05f7f8522164fe40e0a02c12a494fa41b22f137d96fd3afffcf63e760edc0f9c
MD5 a5a9afc397112a4b9c6e989203886fa2
BLAKE2b-256 153d4e1b32f73b7f118a8fc62ae99bf7478ac9b6aa5b3fe6077021908abaddc5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page