kalavai-client 0.5.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- kalavai_client-0.5.0/LICENSE +201 -0
- kalavai_client-0.5.0/PKG-INFO +279 -0
- kalavai_client-0.5.0/README.md +234 -0
- kalavai_client-0.5.0/kalavai_client/__init__.py +2 -0
- kalavai_client-0.5.0/kalavai_client/__main__.py +5 -0
- kalavai_client-0.5.0/kalavai_client/assets/apps.yaml +201 -0
- kalavai_client-0.5.0/kalavai_client/assets/apps_values.yaml +83 -0
- kalavai_client-0.5.0/kalavai_client/assets/docker-compose-template.yaml +55 -0
- kalavai_client-0.5.0/kalavai_client/assets/pool_config_template.yaml +19 -0
- kalavai_client-0.5.0/kalavai_client/assets/pool_config_values.yaml +12 -0
- kalavai_client-0.5.0/kalavai_client/assets/user_workspace.yaml +19 -0
- kalavai_client-0.5.0/kalavai_client/assets/user_workspace_values.yaml +29 -0
- kalavai_client-0.5.0/kalavai_client/assets/vpn-template.yaml +13 -0
- kalavai_client-0.5.0/kalavai_client/auth.py +68 -0
- kalavai_client-0.5.0/kalavai_client/cli.py +1989 -0
- kalavai_client-0.5.0/kalavai_client/cluster.py +308 -0
- kalavai_client-0.5.0/kalavai_client/utils.py +456 -0
- kalavai_client-0.5.0/pyproject.toml +62 -0
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -0,0 +1,279 @@
|
|
|
1
|
+
Metadata-Version: 2.3
|
|
2
|
+
Name: kalavai-client
|
|
3
|
+
Version: 0.5.0
|
|
4
|
+
Summary: Client app for kalavai platform
|
|
5
|
+
License: Apache-2.0
|
|
6
|
+
Keywords: LLM,platform
|
|
7
|
+
Author: Carlos Fernandez Musoles
|
|
8
|
+
Author-email: carlos@kalavai.net
|
|
9
|
+
Maintainer: Carlos Fernandez Musoles
|
|
10
|
+
Maintainer-email: carlos@kalavai.net
|
|
11
|
+
Requires-Python: <3.12
|
|
12
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
13
|
+
Classifier: Programming Language :: Python :: 2
|
|
14
|
+
Classifier: Programming Language :: Python :: 2.7
|
|
15
|
+
Classifier: Programming Language :: Python :: 3
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.4
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.5
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.6
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.7
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.8
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
22
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
23
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
24
|
+
Provides-Extra: dev
|
|
25
|
+
Requires-Dist: Pillow (==10.3.0)
|
|
26
|
+
Requires-Dist: anvil-uplink (==0.5.1)
|
|
27
|
+
Requires-Dist: arguably (>=1.2.5)
|
|
28
|
+
Requires-Dist: build ; extra == "dev"
|
|
29
|
+
Requires-Dist: gputil (==1.4.0)
|
|
30
|
+
Requires-Dist: importlib_resources (==6.5.2)
|
|
31
|
+
Requires-Dist: jinja2 (==3.1.4)
|
|
32
|
+
Requires-Dist: netifaces (==0.11.0)
|
|
33
|
+
Requires-Dist: psutil (==5.9.8)
|
|
34
|
+
Requires-Dist: py2app (==0.28.7) ; extra == "dev"
|
|
35
|
+
Requires-Dist: pyinstaller (==6.5.0) ; extra == "dev"
|
|
36
|
+
Requires-Dist: pyyaml (==6.0.2)
|
|
37
|
+
Requires-Dist: requests (>=2.25)
|
|
38
|
+
Requires-Dist: rich (==13.7.1)
|
|
39
|
+
Requires-Dist: setuptools (<70.0.0)
|
|
40
|
+
Requires-Dist: twine ; extra == "dev"
|
|
41
|
+
Project-URL: Homepage, https://platform.kalavai.net
|
|
42
|
+
Project-URL: Website, https://kalavai.net
|
|
43
|
+
Description-Content-Type: text/markdown
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
<div align="center">
|
|
48
|
+
|
|
49
|
+
 
|
|
50
|
+
   [](https://discordapp.com/channels/1295009828623880313) [](https://platform.kalavai.net)
|
|
51
|
+
|
|
52
|
+
</div>
|
|
53
|
+
|
|
54
|
+
⭐⭐⭐ **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 [staring our GitHub project](https://github.com/kalavai-net/kalavai-client), joining our [discord channel](https://discord.gg/HJ8FNapQ), follow our [Substack](https://kalavainet.substack.com/) and give us a [review on Product Hunt](https://www.producthunt.com/products/kalavai/reviews/new).**
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
# Kalavai: turn your devices into a scalable LLM platform
|
|
58
|
+
|
|
59
|
+
### Taming the adoption of Large Language Models
|
|
60
|
+
|
|
61
|
+
> 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.
|
|
62
|
+
|
|
63
|
+
<div align="center">
|
|
64
|
+
|
|
65
|
+
<a href="https://www.producthunt.com/products/kalavai/reviews?utm_source=badge-product_review&utm_medium=badge&utm_souce=badge-kalavai" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/product_review.svg?product_id=720725&theme=neutral" alt="Kalavai - The first platform to crowdsource AI computation | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
|
|
66
|
+
|
|
67
|
+
</div>
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
## What can Kalavai do?
|
|
71
|
+
|
|
72
|
+
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.
|
|
73
|
+
|
|
74
|
+
### Aggregate multiple devices in an LLM pool
|
|
75
|
+
|
|
76
|
+
https://github.com/user-attachments/assets/4be59886-1b76-4400-ab5c-c803e3e414ec
|
|
77
|
+
|
|
78
|
+
### Deploy LLMs across the pool
|
|
79
|
+
|
|
80
|
+
https://github.com/user-attachments/assets/ea57a2ab-3924-4097-be2a-504e0988fbb1
|
|
81
|
+
|
|
82
|
+
### Single point of entry for all models (GUI + API)
|
|
83
|
+
|
|
84
|
+
https://github.com/user-attachments/assets/7df73bbc-d129-46aa-8ce5-0735177dedeb
|
|
85
|
+
|
|
86
|
+
### Self-hosted LLM pools
|
|
87
|
+
|
|
88
|
+
https://github.com/user-attachments/assets/0d2316f3-79ea-46ac-b41e-8ef720f52672
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
### News updates
|
|
92
|
+
|
|
93
|
+
- X January 2025: Support for accessing pools from remote computers
|
|
94
|
+
- 9 January 2025: Added support for [Aphrodite Engine](https://github.com/aphrodite-engine/aphrodite-engine) models
|
|
95
|
+
- 8 January 2025: Release of [a free, public, shared pool](/docs/docs/public_llm_pool.md) for community LLM deployment
|
|
96
|
+
- 24 December 2024: Release of [public BOINC pool](/docs/docs/boinc.md) to donate computing to scientific projects
|
|
97
|
+
- 23 December 2024: Release of [public petals swarm](/docs/docs/petals.md)
|
|
98
|
+
- 24 November 2024: Common pools with private user spaces
|
|
99
|
+
- 30 October 2024: Release of our [public pool platform](https://platform.kalavai.net)
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
### Support for LLM engines
|
|
103
|
+
|
|
104
|
+
We currently support out of the box the following LLM engines:
|
|
105
|
+
|
|
106
|
+
- [vLLM](https://docs.vllm.ai/en/latest/)
|
|
107
|
+
- [llama.cpp](https://github.com/ggerganov/llama.cpp)
|
|
108
|
+
- [Aphrodite Engine](https://github.com/aphrodite-engine/aphrodite-engine)
|
|
109
|
+
- [Petals](https://github.com/bigscience-workshop/petals)
|
|
110
|
+
|
|
111
|
+
Coming soon:
|
|
112
|
+
|
|
113
|
+
- [exo](https://github.com/exo-explore/exo)
|
|
114
|
+
- [GPUstack](https://docs.gpustack.ai/0.4/overview/)
|
|
115
|
+
- [RayServe](https://docs.ray.io/en/latest/serve/index.html)
|
|
116
|
+
|
|
117
|
+
Not what you were looking for? [Tell us](https://github.com/kalavai-net/kalavai-client/issues) what engines you'd like to see.
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
> 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).
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
## Want to know more?
|
|
124
|
+
|
|
125
|
+
- Get a free [Kalavai account](https://platform.kalavai.net) and access unlimited AI.
|
|
126
|
+
- Full [documentation](https://kalavai-net.github.io/kalavai-client/) for the project.
|
|
127
|
+
- [Join our Substack](https://kalavainet.substack.com/) for updates and be part of our community
|
|
128
|
+
- [Join our discord community](https://discord.gg/6VJWGzxg)
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
## Getting started
|
|
132
|
+
|
|
133
|
+
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.
|
|
134
|
+
|
|
135
|
+
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.
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
### Requirements for a worker machine
|
|
139
|
+
|
|
140
|
+
- A laptop, desktop or Virtual Machine
|
|
141
|
+
- Docker engine installed (for [linux](https://docs.docker.com/engine/install/), [Windows and MacOS](https://docs.docker.com/desktop/)) with [privilege access](https://docs.docker.com/engine/containers/run/#runtime-privilege-and-linux-capabilities).
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
### Requirements to run the client
|
|
145
|
+
|
|
146
|
+
- Python 3.10+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
### Install the client
|
|
150
|
+
|
|
151
|
+
The client is a python package and can be installed with one command:
|
|
152
|
+
|
|
153
|
+
```bash
|
|
154
|
+
pip install kalavai-client
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
## Public LLM pools: crowdsource community resources
|
|
158
|
+
|
|
159
|
+
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](https://kalavai-net.github.io/kalavai-client/public_llm_pool/#single-api-endpoint) as well as a [UI-based playground](https://kalavai-net.github.io/kalavai-client/public_llm_pool/#ui-playground).
|
|
160
|
+
|
|
161
|
+
Check out [our guide](https://kalavai-net.github.io/kalavai-client/public_llm_pool/) on how to join and start deploying LLMs.
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
## Createa a local, private LLM pool
|
|
165
|
+
|
|
166
|
+
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](#public-pools-crowdsource-community-resources).
|
|
167
|
+
|
|
168
|
+
### 1. Start a seed node
|
|
169
|
+
|
|
170
|
+
Simply use the client to start your seed node:
|
|
171
|
+
|
|
172
|
+
```bash
|
|
173
|
+
kalavai pool start <pool-name>
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
Now you are ready to add worker nodes to this seed. To do so, generate a joining token:
|
|
177
|
+
```bash
|
|
178
|
+
$ kalavai pool token --user
|
|
179
|
+
|
|
180
|
+
Join token: <token>
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
### 2. Add worker nodes
|
|
184
|
+
|
|
185
|
+
Increase the power of your AI pool by inviting others to join.
|
|
186
|
+
|
|
187
|
+
Copy the joining token. On the worker node, run:
|
|
188
|
+
|
|
189
|
+
```bash
|
|
190
|
+
kalavai pool join <token>
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
### Enough already, let's run stuff!
|
|
194
|
+
|
|
195
|
+
Check our [examples](examples/) to put your new AI pool to good use!
|
|
196
|
+
- [Single node vLLM GPU LLM](examples/singlenode_gpu_vllm.md) deployment
|
|
197
|
+
- [Multi node vLLM GPU LLM](examples/multinode_gpu_vllm.md) deployment
|
|
198
|
+
- [Aphrodite-engine quantized LLM](examples/quantized_gpu_llm.md) deployment, including Kobold interface
|
|
199
|
+
- [Ray cluster](examples/ray_cluster.md) for distributed computation.
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
## Compatibility matrix
|
|
203
|
+
|
|
204
|
+
If your system is not currently supported, [open an issue](https://github.com/kalavai-net/kalavai-client/issues) and request it. We are expanding this list constantly.
|
|
205
|
+
|
|
206
|
+
### OS compatibility
|
|
207
|
+
|
|
208
|
+
Since **worker nodes** run inside docker, any machine that can run docker **should** be compatible with Kalavai. Here are instructions for [linux](https://docs.docker.com/engine/install/), [Windows](https://docs.docker.com/desktop/setup/install/windows-install/) and [MacOS](https://docs.docker.com/desktop/setup/install/mac-install/).
|
|
209
|
+
|
|
210
|
+
The kalavai client, which controls and access pools, can be installed on any machine that has python 3.10+.
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
### Hardware compatibility:
|
|
214
|
+
|
|
215
|
+
- `amd64` or `x86_64` CPU architecture
|
|
216
|
+
- NVIDIA GPU
|
|
217
|
+
- AMD and Intel GPUs are currently not supported ([interested in helping us test it?](https://kalavai-net.github.io/kalavai-client/compatibility/#help-testing-amd-gpus))
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
## Roadmap
|
|
221
|
+
|
|
222
|
+
- [x] Kalavai client on Linux
|
|
223
|
+
- [x] [TEMPLATE] Distributed LLM deployment
|
|
224
|
+
- [x] Kalavai client on Windows (with WSL2)
|
|
225
|
+
- [x] Public LLM pools
|
|
226
|
+
- [x] Self-hosted LLM pools
|
|
227
|
+
- [x] Collaborative LLM deployment
|
|
228
|
+
- [x] Ray cluster support
|
|
229
|
+
- [x] Kalavai client on Mac
|
|
230
|
+
- [ ] [TEMPLATE] [GPUStack](https://github.com/gpustack/gpustack) support
|
|
231
|
+
- [ ] [TEMPLATE] [exo](https://github.com/exo-explore/exo) support
|
|
232
|
+
- [ ] Support for AMD GPUs
|
|
233
|
+
- [x] Docker install path
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
Anything missing here? Give us a shout in the [discussion board](https://github.com/kalavai-net/kalavai-client/discussions)
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
## Contribute
|
|
240
|
+
|
|
241
|
+
- PR welcome!
|
|
242
|
+
- [Join the community](https://github.com/kalavai-net/kalavai-client/) and share ideas!
|
|
243
|
+
- Report [bugs, issues and new features](https://github.com/kalavai-net/kalavai-client/issues).
|
|
244
|
+
- Help improve our [compatibility matrix](#compatibility-matrix) by testing on different operative systems.
|
|
245
|
+
- [Follow our Substack channel](https://kalavainet.substack.com/) for news, guides and more.
|
|
246
|
+
- [Community integrations](https://github.com/kalavai-net/kube-watcher/tree/main/templates) are template jobs built by Kalavai and the community that makes deploying distributed workflows easy for users. Anyone can extend them and contribute to the repo.
|
|
247
|
+
|
|
248
|
+
### Star History
|
|
249
|
+
|
|
250
|
+
[](https://star-history.com/#kalavai-net/kalavai-client&Date)
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
## Build from source
|
|
254
|
+
|
|
255
|
+
### Requirements
|
|
256
|
+
|
|
257
|
+
Python version <= 3.12.
|
|
258
|
+
|
|
259
|
+
```bash
|
|
260
|
+
virtualenv -p python3 env
|
|
261
|
+
source env/bin/activate
|
|
262
|
+
sudo apt install python3.10-venv python3.10-dev -y
|
|
263
|
+
pip install -e .[dev]
|
|
264
|
+
```
|
|
265
|
+
|
|
266
|
+
Build python wheels:
|
|
267
|
+
```bash
|
|
268
|
+
bash publish.sh build
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
### Unit tests
|
|
273
|
+
|
|
274
|
+
To run the unit tests, use:
|
|
275
|
+
|
|
276
|
+
```bash
|
|
277
|
+
python -m unittest
|
|
278
|
+
```
|
|
279
|
+
|