Zebra Translate
Python API

API Reference for the Zebra Python SDK (PyPI).

pvzebra.create()

def create(
        access_key: str,
        model_path: Optional[str] = None,
        device: Optional[str] = None,
        library_path: Optional[str] = None) -> Zebra

Factory method for Zebra Translate engine.

Parameters

• access_key str : AccessKey obtained from Picovoice Console.
• model_path Optional[str] : Absolute path to the file containing model parameters (.pv). Sets the source and target translation languages.
• device Optional[str] : String representation of the device (e.g., CPU or GPU) to use. If set to best, the most suitable device is selected automatically. If set to gpu, the engine uses the first available GPU device. To select a specific GPU device, set this argument to gpu:${GPU_INDEX}, where ${GPU_INDEX} is the index of the target GPU. If set tocpu, the engine will run on the CPU with the default number of threads. To specify the number of threads, set this argument to cpu:${NUM_THREADS}, where ${NUM_THREADS} is the desired number of threads.
• library_path Optional[str] : Absolute path to Zebra's dynamic library.

Returns

• Zebra : An instance of Zebra Translate engine.

Throws

• ZebraError

pvzebra.available_devices()

def available_devices(library_path: Optional[str] = None) -> Sequence[str]

Lists all available devices that Zebra can use for inference. Each entry in the list can be the device argument of create() factory method or Zebra constructor.

Parameters

• library_path Optional[str] : Absolute path to Zebra's dynamic library. If not set it will be set to the default location.

Returns

• Sequence[str]: List of all available devices that Zebra can use for inference.

Throws

• ZebraError

pvzebra.Zebra

class Zebra(object)

Class for the Zebra Translate engine. Zebra can be initialized either using the module level create() function or directly using the class __init__() method. Resources should be cleaned when you are done using the delete() method.

pvzebra.Zebra.version

self.version: str

The version string of the Zebra library.

pvzebra.Zebra.max_character_limit

self.max_character_limit: int

The maximum number of characters allowed in a single translate request.

pvzebra.Zebra.__init__()

def __init__(
        self,
        access_key: str,
        model_path: str,
        device: str,
        library_path: str) -> Zebra

__init__ method for Zebra Translate engine.

Parameters

• access_key str : AccessKey obtained from Picovoice Console.
• model_path str : Absolute path to the file containing model parameters (.pv). Sets the source and target translation languages.
• device str : String representation of the device (e.g., CPU or GPU) to use. If set to best, the most suitable device is selected automatically. If set to gpu, the engine uses the first available GPU device. To select a specific GPU device, set this argument to gpu:${GPU_INDEX}, where ${GPU_INDEX} is the index of the target GPU. If set tocpu, the engine will run on the CPU with the default number of threads. To specify the number of threads, set this argument to cpu:${NUM_THREADS}, where ${NUM_THREADS} is the desired number of threads.
• library_path str : Absolute path to Zebra's dynamic library.

Returns

• Zebra: An instance of Zebra Translate engine.

Throws

• ZebraError

pvzebra.Zebra.delete()

def delete(self)

Releases resources acquired by Zebra.

pvzebra.Zebra.translate()

def translate(self, text: str) -> str

Translates text. The maximum number of characters that can be translated at once is given by .maxCharacterLimit.

Parameters

• text str : Text to translate.

Returns

• str : Translated text.

Throws

• ZebraError

pvzebra.list_hardware_devices()

def list_hardware_devices(library_path: str) -> Sequence[str]:

Lists all available devices that Zebra can use for inference. Each entry in the list can be the device argument of create() factory method or Zebra constructor.

Internal method. The higher level pvzebra.available_devices() should be used instead.

Parameters

• library_path str : Absolute path to Zebra's dynamic library.

Returns

• Sequence[str]: List of all available devices that Zebra can use for inference.

Throws

• ZebraError

pvzebra.ZebraError

class ZebraError(Exception)

Error thrown if an error occurs within Zebra Translate engine.

Exceptions

class ZebraActivationError(ZebraError)
class ZebraActivationLimitError(ZebraError)
class ZebraActivationRefusedError(ZebraError)
class ZebraActivationThrottledError(ZebraError)
class ZebraIOError(ZebraError)
class ZebraInvalidArgumentError(ZebraError)
class ZebraInvalidStateError(ZebraError)
class ZebraKeyError(ZebraError)
class ZebraMemoryError(ZebraError)
class ZebraRuntimeError(ZebraError)
class ZebraStopIterationError(ZebraError)