Installation

Requirements

• Python 3.9 - 3.13
• PyTorch 2.4 - 2.8
• A Linux distribution from 2014 or later (manylinux2014).
• [Recommended] Any NVIDIA GPU that is compatible with PyTorch.
• An internet connection for the on-premise version of clika-ace.
  • An air-gapped version of clika-ace, which does not require any internet connection, is also available.
• If you are using Hugging Face libraries:
  • transformers version 4.55 to 4.57 (4.55 <= version < 4.58)

note

Although a GPU is not strictly required to use clika-ace, we highly recommend using one. Running a task using clika-ace on a CPU instead of a GPU can result in runtimes of hours instead of minutes.

note

If you do not have a version preference, we recommend using PyTorch 2.8 and Python 3.12.

Installation

Installing clika-ace is similar to installing any other Python package using the pip package manager; the only special requirement is to add the license key to gain access to CLIKA's private package pip index.

You can install the package using the following lines:

1. Set your license key as an environment variable

   export CLIKA_ACE_LICENSE=YOUR_LICENSE_KEY

2. Install clika-ace using the following:

   pip install "clika-ace" --extra-index-url https://license:$CLIKA_ACE_LICENSE@license.clika.io/simple

tip

If you wish to add clika-ace to a requirements.txt file, you can add the following lines:

--extra-index-url https://license:$ACE_LICENSE_KEY@license.clika.io/simple
clika-ace

Dependencies

clika-ace is dependent on 2 packages:

• torch
• onnx

Setting the license key to be globally available

Since every usage of clika-ace requires the availability of a valid license key, there are 2 main methods of doing so:

Method 1 - Using clika-init-license script

1. Make sure clika-ace is installed and the Python environment is set up.
2. Run the command:

   clika-init-license

3. Once done, a file that contains the license key will be generated at: ~/.clika/.ace_license

Method 2 - Environment variable

1. Setting an environment variable in your shell profile (e.g. ~/.zshrc or ~/.bashrc)

   export CLIKA_ACE_LICENSE=YOUR_LICENSE_KEY

   Alternatively, you can set the license key programmatically within your Python script. It is crucial that this code runs before you import clika-ace:

   import os
   os.environ["CLIKA_ACE_LICENSE"] = "LICENSE_KEY"

Potential Issues

pip installation fails

If pip fails to install clika-ace and you see a message similar to the one below:

 ###########################################################################################
*** WARNING ***
The package you are trying to install is only a placeholder project on PyPI.org repository.
This package is hosted on CLIKA Python Package Index to which you would need a license key to download.

Please visit us at www.clika.io
###########################################################################################

it could be for one of the following reasons:

1. Unsupported Python version. Please see requirements.
2. Invalid LICENSE key. Please verify that the provided license key is correct.