There is a newer version available. For the latest stable version, please use dengjen-tashkeel 3.x!

Troubleshooting

Python: RuntimeError mentioning onnxruntime on import

The wheel loads the shared library of the pip onnxruntime package when it is imported. Install a compatible version:

pip install "onnxruntime>=1.28,<2"

If onnxruntime-gpu is installed, uninstall it first: it provides the same onnxruntime import name and clashes with the CPU package.

Rust: build fails while fetching ONNX Runtime

The default ort-static feature downloads prebuilt ONNX Runtime binaries at build time. On an offline machine or an unsupported target, build with the ort-dylib feature and supply a system library instead; see Rust installation.

Java: native library not found

Native jars exist only for linux-x86_64, windows-x64, and macos-aarch64. On other platforms, build the C ABI library and set -Ddengjen.tashkeel.native.library.path to the file; see Java installation.

C: dengjen_tashkeel_init returns DENGJEN_TASHKEEL_ALREADY_INITIALIZED

Code 4: the engine is already initialized, either by an earlier dengjen_tashkeel_init call or lazily by the first dengjenTashkeelTashkeel call. The existing engine stays in place. Call dengjen_tashkeel_init once, before any diacritization. The first engine wins: a later call with a different model_path does not replace it, so treat this code as non-fatal only when the existing engine uses the model you wanted.