Skip to main content

Python client library for the Kamiwaza AI Platform

This project has been archived.

The maintainers of this project have marked this project as archived. No new releases are expected.

Project description

Kamiwaza Python SDK

Python client library and CLI for interacting with the Kamiwaza AI Platform. This SDK provides a type-safe interface to all Kamiwaza API endpoints with built-in authentication, error handling, and resource management.

Installation

pip install kamiwaza-client

Python SDK Usage

from kamiwaza_client import KamiwazaClient

# Initialize the client for local development
client = KamiwazaClient("http://localhost:7777/api/")

Examples

The /examples directory contains Jupyter notebooks demonstrating various use cases:

  1. Model Download and Deployment - A comprehensive guide to searching, downloading, deploying, and using models with the Kamiwaza SDK
  2. Quick Model Deployment - Streamlined approach to download and deploy models using a single function
  3. Model Evaluation - How to evaluate and benchmark multiple language models for performance comparison using the streamlined download_and_deploy_model function
  4. Structured Output - Using Kamiwaza's OpenAI-compatible interface to generate structured outputs with specific JSON schemas

More examples coming soon!

Service Overview

Service Description Documentation
client.models Model management Models Service
client.serving Model deployment Serving Service
client.vectordb Vector database VectorDB Service
client.catalog Data management Catalog Service
client.embedding Text processing Embedding Service
client.retrieval Search Retrieval Service
client.ingestion Data pipeline Ingestion Service
client.cluster Infrastructure Cluster Service
client.lab Lab environments Lab Service
client.auth Security Auth Service
client.activity Monitoring Activity Service
client.openai OpenAI API compatible OpenAI Service

Quick Start - CLI

The easiest way to get started is using the CLI:

# First time setup
kamiwaza config set-url http://localhost:7777/api

# Download, deploy, and chat with a model in one command
$ kamiwaza run qwen2.5-7b-instruct
🚀 Deploying Qwen2.5-7B-Instruct-GGUF...
✨ Deployment ready!

🤖 Chat session started (Ctrl+C to exit)

User: What is a funny way to explain GenAI?

Assistant: GenAI is like a magic wand that can create amazing things. It can write code, draw pictures, and even figure out your taxes.

For more CLI commands and examples, see the CLI Documentation.

The Kamiwaza SDK is actively being developed with new features, examples, and documentation being added regularly. Stay tuned for updates including additional example notebooks, enhanced documentation, and expanded functionality across all services.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kamiwaza-0.3.3.0.tar.gz (60.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kamiwaza-0.3.3.0-py3-none-any.whl (81.4 kB view details)

Uploaded Python 3

File details

Details for the file kamiwaza-0.3.3.0.tar.gz.

File metadata

  • Download URL: kamiwaza-0.3.3.0.tar.gz
  • Upload date:
  • Size: 60.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.14

File hashes

Hashes for kamiwaza-0.3.3.0.tar.gz
Algorithm Hash digest
SHA256 158cc19c6a53fcb96e44843af0b9a1553eb4b32f58b6204681681757339e3a03
MD5 319b23da17ec9a81234ae659583a9f3c
BLAKE2b-256 6cd41435cdfcfd7f607e9ed20400723d31a5de234df69470aed6d6b855f55673

See more details on using hashes here.

File details

Details for the file kamiwaza-0.3.3.0-py3-none-any.whl.

File metadata

  • Download URL: kamiwaza-0.3.3.0-py3-none-any.whl
  • Upload date:
  • Size: 81.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.14

File hashes

Hashes for kamiwaza-0.3.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 55ff8c5287e95f7286bf3ac28040a293cc36d5892925b3bd2590e8f6bffff178
MD5 6ea0adf2ad144b8880402632539592a3
BLAKE2b-256 2258b80f3aa310604cea106c0ccc8d73ed41f3b4adc358247b29ccdfd732a4bf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page