Skip to content

kalavai-net/kalavai-client

Repository files navigation

Kalavai logo

GitHub Release PyPI - Downloads GitHub contributors GitHub License GitHub Repo stars Dynamic JSON Badge Signup

⭐⭐⭐ Kalavai and our LLM pools are open source, and free to use in both commercial and non-commercial purposes. If you find it useful, consider supporting us by giving a star to our GitHub project, joining our discord channel, follow our Substack and give us a review on Product Hunt.

Kalavai: turn your devices into a scalable LLM platform

Taming the adoption of Large Language Models

Kalavai is an open source tool that turns everyday devices into your very own LLM platform. It aggregates resources from multiple machines, including desktops and laptops, and is compatible with most model engines to make LLM deployment and orchestration simple and reliable.

Kalavai - The first platform to crowdsource AI computation | Product Hunt

What can Kalavai do?

Kalavai's goal is to make using LLMs in real applications accessible and affordable to all. It's a magic box that integrates all the components required to make LLM useful in the age of massive computing, from sourcing computing power, managing distributed infrastructure and storage, using industry-standard model engines and orchestration of LLMs.

Aggregate multiple devices in an LLM pool

every_tree_starts_as_a_seed.mp4

Deploy LLMs across the pool

your_wish_is_my_command.mp4

Single point of entry for all models (GUI + API)

one_api_to_rule_them_all.mp4

Self-hosted LLM pools

all_power_all_privacy.mp4

News updates

Support for LLM engines

We currently support out of the box the following LLM engines:

Coming soon:

Not what you were looking for? Tell us what engines you'd like to see.

Kalavai is at an early stage of its development. We encourage people to use it and give us feedback! Although we are trying to minimise breaking changes, these may occur until we have a stable version (v1.0).

Want to know more?

Getting started

The kalavai-client is the main tool to interact with the Kalavai platform, to create and manage both local and public pools and also to interact with them (e.g. deploy models). Let's go over its installation.

From release v0.5.0, you can now install kalavai-client in non-worker computers. You can run a pool on a set of machines and have the client on a remote computer from which you access the LLM pool. Because the client only requires having python installed, this means more computers are now supported to run it.

Requirements

For workers sharing resources with the pool:

Support for Windows and MacOS workers is experimental: kalavai workers run on docker containers that require access to the host network interfaces, thus systems that do not support containers natively (Windows and MacOS) may have difficulties finding each other.

Any system that runs python 3.6+ is able to run the kalavai-client and therefore connect and operate an LLM pool, without sharing with the pool. Your computer won't be adding its capacity to the pool, but it wil be able to deploy jobs and interact with models.

Common issues

If you see the following error:

fatal error: Python.h: No such file or directory | #include <Python.h>

Make sure you also install python3-dev package. For ubuntu distros:

sudo apt install python3-dev

If you see:

AttributeError: install_layout. Did you mean: 'install_platlib'?
      [end of output]

Upgrade your setuptools:

pip install -U setuptools

Install the client

The client is a python package and can be installed with one command:

pip install kalavai-client

Public LLM pools: crowdsource community resources

This is the easiest and most powerful way to experience Kalavai. It affords users the full resource capabilities of the community and access to all its deployed LLMs, via an OpenAI-compatible endpoint as well as a UI-based playground.

Check out our guide on how to join and start deploying LLMs.

Createa a local, private LLM pool

Kalavai is free to use, no caps, for both commercial and non-commercial purposes. All you need to get started is one or more computers that can see each other (i.e. within the same network), and you are good to go. If you wish to join computers in different locations / networks, check managed kalavai.

1. Start a seed node

Simply use the client to start your seed node:

kalavai pool start <pool-name>

Now you are ready to add worker nodes to this seed. To do so, generate a joining token:

$ kalavai pool token --user

Join token: <token>

2. Add worker nodes

Increase the power of your AI pool by inviting others to join.

Copy the joining token. On the worker node, run:

kalavai pool join <token>

3. Attach more clients

You can now connect to an existing pool from any computer -not just from worker nodes. To connect to a pool, run:

kalavai pool attach <token>

This won't add the machine as a worker, but you will be able to operate in the pool as if you were. This is ideal for remote access to the pool, and to use the pool from machines that cannot run workers (docker container limitations).

Enough already, let's run stuff!

Check our examples to put your new AI pool to good use!

Compatibility matrix

If your system is not currently supported, open an issue and request it. We are expanding this list constantly.

OS compatibility

Since worker nodes run inside docker, any machine that can run docker should be compatible with Kalavai. Here are instructions for linux, Windows and MacOS.

The kalavai client, which controls and access pools, can be installed on any machine that has python 3.10+.

Hardware compatibility:

Roadmap

  • Kalavai client on Linux
  • [TEMPLATE] Distributed LLM deployment
  • Kalavai client on Windows (with WSL2)
  • Public LLM pools
  • Self-hosted LLM pools
  • Collaborative LLM deployment
  • Ray cluster support
  • Kalavai client on Mac
  • [TEMPLATE] GPUStack support
  • [TEMPLATE] exo support
  • Support for AMD GPUs
  • Docker install path

Anything missing here? Give us a shout in the discussion board

Contribute

Star History

Star History Chart

Build from source

Requirements

Python version >= 3.6.

sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt update
sudo apt install python3.10 python3.10-dev python3-virtualenv
virtualenv -p python3.10 env
source env/bin/activate
sudo apt install  python3.10-venv python3.10-dev -y
pip install -U setuptools
pip install -e .[dev]

Build python wheels:

bash publish.sh build

Unit tests

To run the unit tests, use:

python -m unittest

docker run --rm --net=host -v /root/.cache/kalavai/:/root/.cache/kalavai/ ghcr.io/helmfile/helmfile:v0.169.2 helmfile sync --file /root/.cache/kalavai/apps.yaml --kubeconfig /root/.cache/kalavai/kubeconfig