Metadata-Version: 2.4
Name: luml_sdk
Version: 0.2.0
Summary: LUML Python SDK
Requires-Python: >=3.12
Requires-Dist: cloudpickle<4.0.0,>=3.1.2
Requires-Dist: fnnx<0.1.0,>=0.0.8
Requires-Dist: pydantic<3.0.0,>=2.11.7
Requires-Dist: pyfnx-utils<1.0.0,>=0.0.1
Requires-Dist: sqlparse<1.0.0,>=0.4.4
Provides-Extra: datasets
Requires-Dist: pandas<3.0.0,>=2.0.0; extra == 'datasets'
Requires-Dist: pyarrow<19.0.0,>=14.0.0; extra == 'datasets'
Provides-Extra: datasets-hf
Requires-Dist: datasets<4.0.0,>=2.14.0; extra == 'datasets-hf'
Provides-Extra: datasets-polars
Requires-Dist: polars<2.0.0,>=1.0.0; extra == 'datasets-polars'
Provides-Extra: llm
Requires-Dist: openai<3.0.0,>=1.0.0; extra == 'llm'
Provides-Extra: tracing
Requires-Dist: opentelemetry-api>=1.36.0; extra == 'tracing'
Requires-Dist: opentelemetry-instrumentation-openai>=0.44.1; extra == 'tracing'
Requires-Dist: opentelemetry-sdk>=1.36.0; extra == 'tracing'
Description-Content-Type: text/markdown

# LUML SDK

Python SDK for ML experiment tracking. LUML lets you log metrics, parameters, models, evaluations, and LLM traces as your experiments run — either locally (SQLite) or synced to the LUML cloud platform.

**Main use cases:**
- Track training runs: log hyperparameters, metrics over time, final models
- Run and score evaluations on LLM or classical ML outputs
- Capture LLM traces automatically via OpenTelemetry instrumentation
- Upload experiments and models to the LUML platform for sharing and collaboration

## Installation

```bash
pip install luml-sdk
```

With optional extras:

```bash
pip install luml-sdk[tracing]   # LLM tracing via OpenTelemetry
pip install luml-sdk[datasets]  # pandas / pyarrow support
```

## Getting your API key

To upload experiments to the LUML platform you need an API key.

1. Go to [luml.ai](https://luml.ai) and log in
2. Open **Settings** → **API Keys**
3. Click **Generate new key** and copy it

![API key settings page](https://raw.githubusercontent.com/luml-ai/luml/main/lumlflow/docs/images/api_key.webp)

Set it as an environment variable:

```bash
export LUML_API_KEY=your_api_key_here
```

## Documentation

[https://docs.luml.ai/sdk/experiments/backends/sqlite](https://docs.luml.ai/sdk/experiments/backends/sqlite)