Installation

Requirements

• 3.9 <= Python <= 3.13
• 2.4 <= PyTorch <= 2.8
• Any Linux OS from 2014 and beyond. clika-ace is compiled as manylinux2014.
• [Recommended] Any NVIDIA GPU that is compatible with PyTorch.
• Internet connection, in-case of using the On-Prem clika-ace version.
  • Air-Gapped version is also available, which does not require any internet connection.
• In-case usage of Huggingface libraries:
  • 4.55 <= transformers < 4.58

note

Although a GPU is not strictly required to use clika-ace, it is highly recommended to use one. For reference, running a task using clika-ace on a GPU might take few minutes while using CPU might take few hours.

note

In-case there are no version preferences, we recommend PyTorch 2.8 & Python 3.12 as of now.

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 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 dependant 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 could also programmatically set it in Python using the following snippet. Make sure you run it prior to importing clika-ace

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

Potential Issues

Installing the package using pip fails

In-case pip fails to install clika-ace, and you a message similar to:

 ###########################################################################################
*** 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
###########################################################################################

Reasons might be:

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