> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nexa.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Get started with NexaAI Python SDK - choose your platform and explore AI capabilities.

## **What is NexaAI Python SDK?**

The NexaAI Python SDK provides a comprehensive API for on-device AI inference across multiple modalities. It supports:

* **Large Language Models (LLM)**: Text generation and conversation
* **Vision-Language Models (VLM)**: Multimodal understanding and generation
* **Embedder**: Text vectorization and similarity computation
* **Reranker**: Document reranking
* **ASR (Automatic Speech Recognition)**: Speech-to-text transcription
* **CV (Computer Vision)**: OCR/text recognition
* **TTS (Text-to-Speech)**: Text-to-speech synthesis
* **ImageGen**: Image generation from text prompts
* **Diarize**: Speaker diarization

## **Choose Your Platform**

The SDK supports multiple platforms with optimized backends. Select your platform for detailed setup instructions:

<CardGroup cols={3}>
  <Card title="macOS" icon="apple" href="/en/nexa-sdk-python/platform-guides/macos">
    **Apple Silicon optimized**<br />
    Python 3.10 • MLX backend • Metal acceleration
  </Card>

  <Card title="Windows x64" icon="windows" href="/en/nexa-sdk-python/platform-guides/windows-x64">
    **CPU/GPU acceleration**<br />
    Python 3.10 • GGUF models • CUDA support
  </Card>

  <Card title="Windows ARM64" icon="microchip" href="/en/nexa-sdk-python/platform-guides/windows-arm64">
    **NPU acceleration**<br />
    Python 3.11-3.13 ARM64 • Snapdragon X Elite
  </Card>
</CardGroup>

## **Quick Overview**

### **Installation**

Each platform has specific installation requirements. Follow your platform guide for detailed instructions:

* **macOS**: `pip install 'nexaai[mlx]'`
* **Windows x64**: `pip install nexaai`
* **Windows ARM64**: `pip install nexaai`

### **Authentication**

Set up your NexaAI token from [https://sdk.nexa.ai/](https://sdk.nexa.ai/):

```bash theme={"dark"}
# Linux/macOS
export NEXA_TOKEN="key/your_token_here"

# Windows
$env:NEXA_TOKEN="key/your_token_here"
```

### **Basic Usage**

Here's a simple example to get you started:

```python theme={"dark"}
from nexaai import LLM, GenerationConfig, ModelConfig, LlmChatMessage

# Initialize model (platform-specific)
model_name = "NexaAI/Qwen3-1.7B-4bit-MLX"  # Example for macOS
config = ModelConfig()
llm = LLM.from_(model=model_name, config=config)

# Create conversation
conversation = [
    LlmChatMessage(role="system", content="You are a helpful assistant."),
    LlmChatMessage(role="user", content="Hello, how are you?")
]

# Generate response
prompt = llm.apply_chat_template(conversation)
for token in llm.generate_stream(prompt, GenerationConfig(max_tokens=100)):
    print(token, end="", flush=True)
```

<Note>
  This is a simplified example. For complete setup instructions, model recommendations, and platform-specific optimizations, please refer to your platform guide above.
</Note>

## **Next Steps**

1. **Choose your platform** and follow the detailed setup guide
2. **Explore the [API Reference](/en/nexa-sdk-python/api-reference)** for comprehensive documentation
3. **Check out platform-specific examples** in your chosen guide

<br />

<div class="feedback-wrapper">
  <span class="feedback-label">Was this page helpful?</span>

  <div class="feedback-toggle">
    <input type="radio" name="feedback" id="feedback-yes" class="feedback-input" />

    <label for="feedback-yes" class="feedback-button">
      <img src="https://mintcdn.com/nexaai/g8-zBYnunEyVtcK3/Images/FeedBack/thumbs-up.svg?fit=max&auto=format&n=g8-zBYnunEyVtcK3&q=85&s=0b57c51c8db9940403e7552956e5c30e" alt="Thumbs up" class="feedback-icon" noZoom width="14" height="14" data-path="Images/FeedBack/thumbs-up.svg" />

      Yes
    </label>

    <input type="radio" name="feedback" id="feedback-no" class="feedback-input" />

    <label for="feedback-no" class="feedback-button">
      <img src="https://mintcdn.com/nexaai/g8-zBYnunEyVtcK3/Images/FeedBack/thumbs-down.svg?fit=max&auto=format&n=g8-zBYnunEyVtcK3&q=85&s=ebacf61d57c8259c6df243d329b548b3" alt="Thumbs down" class="feedback-icon" noZoom width="14" height="14" data-path="Images/FeedBack/thumbs-down.svg" />

      No
    </label>
  </div>
</div>
