Metadata-Version: 2.4
Name: pixano
Version: 0.7.2
Summary: Data-centric AI building blocks for computer vision applications
Project-URL: Documentation, https://github.com/pixano/pixano#readme
Project-URL: Issues, https://github.com/pixano/pixano/issues
Project-URL: Source, https://github.com/pixano/pixano
Author-email: Pixano Developers <pixano@cea.fr>
License-Expression: CECILL-C
License-File: LICENSE
Keywords: computer vision,data annotation,data visualization,deep learning,machine learning
Classifier: Development Status :: 4 - Beta
Classifier: License :: CeCILL-C Free Software License Agreement (CECILL-C)
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: <3.14,>=3.10
Requires-Dist: boto3<2.0.0,>=1.26.0
Requires-Dist: duckdb<2.0.0,>=1.0.0
Requires-Dist: fastapi<1.0.0,>=0.103.0
Requires-Dist: httpx<1.0.0,>=0.25.0
Requires-Dist: importlib-resources<6.0.0,>=5.12.0
Requires-Dist: ipywidgets<9.0.0,>=8.0.0
Requires-Dist: jinja2<4.0.0,>=3.1.2
Requires-Dist: lancedb<0.30.0,>=0.29.0
Requires-Dist: numpy<3.0.0,>=1.26.0
Requires-Dist: opencv-python<5.0.0,>=4.7.0
Requires-Dist: orjson<4.0.0,>=3.9.0
Requires-Dist: pandas<3.0.0,>=1.5.0
Requires-Dist: pillow<13.0.0,>=9.4.0
Requires-Dist: polars<2.0.0,>1.7.0
Requires-Dist: pycocotools<3.0.0,>=2.0.0
Requires-Dist: pydantic-settings<3.0.0,>=2.0.0
Requires-Dist: pydantic<3.0.0,>=2.9.0
Requires-Dist: s3path<1.0.0,>=0.5.0
Requires-Dist: setuptools<76.0.0,>=65.6.0
Requires-Dist: shortuuid<2.0.0,>=1.0.0
Requires-Dist: tqdm<5.0.0,>=4.64.0
Requires-Dist: typer<1.0.0,>=0.9.0
Requires-Dist: uvicorn<1.0.0,>=0.20.0
Description-Content-Type: text/markdown

<div align="center">

<img src="https://raw.githubusercontent.com/pixano/pixano/main/docs/assets/pixano_wide.png" alt="Pixano" height="100"/>

<br/>
<br/>

**Data-centric AI building blocks for computer vision applications**

**_Under active development, subject to API change_**

[![GitHub version](https://img.shields.io/github/v/release/pixano/pixano?label=release&logo=github)](https://github.com/pixano/pixano/releases)
[![PyPI version](https://img.shields.io/pypi/v/pixano?label=release&logo=pypi&logoColor=white)](https://pypi.org/project/pixano/)
[![Docker](https://img.shields.io/docker/v/pixano/pixano?sort=semver&label=release&logo=docker&logoColor=white)](https://hub.docker.com/r/pixano/pixano/)
[![Coverage](https://img.shields.io/codecov/c/github/pixano/pixano/main?logo=codecov&logoColor=white)](https://codecov.io/github/pixano/pixano)
[![Tests](https://img.shields.io/github/actions/workflow/status/pixano/pixano/backend.yml?label=tests&branch=main)](https://github.com/pixano/pixano/actions/workflows/backend.yml)
[![Documentation](https://img.shields.io/website?url=https%3A%2F%2Fpixano.github.io%2F&up_message=online&down_message=offline&label=docs)](https://pixano.github.io)
[![Python version](https://img.shields.io/pypi/pyversions/pixano?color=blue&logo=python&logoColor=white)](https://www.python.org/downloads/)
[![License](https://img.shields.io/badge/license-CeCILL--C-blue.svg)](LICENSE)

</div>

<hr />

Pixano is an open-source tool by CEA List for exploring and annotating your dataset using AI features:

- **Fast dataset navigation** using the the modern storage format _Lance_
- **Multi-view datasets** support for _text_, _images_ and _videos_, and soon for _3D point clouds_
- **Import and export** support for dataset formats like _COCO_
- **Semantic search** using models like _CLIP_
- **Smart segmentation** using models like _SAM_

# Installing Pixano

## Production

We recommend installing the published Pixano package in a dedicated Python virtual environment (Python >= 3.10, < 3.14).

For example, with <a href="https://conda.io/projects/conda/en/latest/user-guide/install/index.html" target="_blank">conda</a>:

```shell
conda create -n pixano_env python=3.10
conda activate pixano_env
```

Then, install Pixano with pip:

```shell
pip install pixano
```

Init the database and start the Pixano server:

```shell
pixano init path/to/database
pixano server run path/to/database
```

Pixano is also available on the [Docker Hub](https://hub.docker.com/r/pixano/pixano) for official releases.

```shell
docker pull pixano/pixano:stable
docker run -p 7492:7492 -v /path/on/host:/library pixano/pixano:stable
```

In this example, `/path/on/host` is the directory on your machine where Pixano stores its library. Inside the
container, Pixano always uses `/library`.

## Development (from source)

To run the latest version of Pixano from source, you need [uv](https://docs.astral.sh/uv/). Install it if you haven't already:

```shell
curl -LsSf https://astral.sh/uv/install.sh | sh
```

Then, clone the repository and install all dependencies:

```shell
git clone https://github.com/pixano/pixano.git
cd pixano
uv sync
```

This installs the project in editable mode with all dependencies pinned via `uv.lock`. Your local changes are taken into account each time you run your environment.

Build the frontend UI assets:

```shell
cd ui/apps/pixano
pnpm i
pnpm run build
```

Init the data base and start the Pixano server:

```shell
uv run pixano init path/to/database
uv run pixano server run path/to/database
```

For more details on running Pixano locally (frontend setup, testing, formatting), see [CONTRIBUTING.md](CONTRIBUTING.md).

# Using Pixano

Please refer to our <a href="https://pixano.github.io/pixano/latest/getting_started/" target="_blank">Getting started</a> guide for information on how to launch and use the Pixano app, and how to create and use Pixano datasets.

# Contributing

Please refer to our [CONTRIBUTING.md](CONTRIBUTING.md) for information on running Pixano locally and guidelines on how to publish your contributions.

# License

Pixano is licensed under the [CeCILL-C license](LICENSE).
