Installation

This chapter provides a step-by-step guide for installing aixd on your system. The toolkit can be installed using pip, conda or uv, which are widely-used package managers for Python. The following instructions will guide you through each method. Alternatively, you can clone the aixd library directly from our repository.

Installation using pip

The most popular package manager for Python is pip. You can use it to install packages from the Python Package Index and other indexes.

Step 1: Update pip

It is good practice to ensure that you are using the latest version of pip. To update pip, run the following command:

python -m pip install --upgrade pip

Step 2: Install toolkit

To install aixd using pip, execute the following command:

pip install aixd

Installation using conda

conda is an open-source package management system and environment management system that runs on Windows, macOS, and Linux. It’s very popular in the realm of scientific computing.

Step 1: Create a conda environment (Optional)

It’s often beneficial to create a new environment for your project. This can be done using the following command:

conda create --name project_name python=3.x

Replace project_name with your desired environment name and 3.x with the specific version of Python you want to use. This package requires python 3.9 or a higher.

Activate the new environment by running:

conda activate project_name

Step 2: Install toolkit

To install aixd in your conda environment, use the following command:

conda install -c conda-forge aixd

Installation using uv

uv is a modern Python package and project manager, written in Rust. It acts as a replace for pip, pip-tools, pipx, poetry, pyenv, twine, virtualenv, and more.

Step 1: Install uv (standalone)

You can find the installation instructions for uv on their official website: uv installation guide. Depending on your operating system, you can install uv using the following commands:

  • On Windows:

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

  • On Unix-based systems (Linux, macOS):

curl -LsSf https://astral.sh/uv/install.sh | sh

Step 2: Create a uv environment

To create a new environment using uv, run the following command:

uv venv

Then, you will need to activate the environment. The command for activating the environment depends on your operating system:

  • On Windows:

.\.venv\Scripts\Activate

  • On Unix-based systems (Linux, macOS):

source .venv/bin/activate

Step 3: Install toolkit

To install aixd in your uv environment, use the following command:

uv pip install aixd --torch-backend=auto

the --torch-backend=auto flag allows uv to automatically detect your CUDA driver, AMD ROCm driver, or Intel GPU and selects the most suitable PyTorch version. If no compatible GPU is found, the CPU version will be installed. For more information, refer to the uv documentation.

Verify installation

After installation, you can verify that the toolkit has been successfully installed by running:

python -c "import aixd; print(aixd.__version__)"

If everything worked out correctly, the version of the installed toolkit will be printed on the screen, and you can start using the toolkit in your projects.