---
name: cellclass
description: >
  Cell classification using machine learning models. Use when writing Python code that uses the cellclass package.
compatibility: Requires Python >=3.12,<3.15.
---

# CellClass

Cell classification using machine learning models

## Installation

```bash
pip install cellclass
```

## API overview

### Datasets

Loading labelled crops for training.

- `ROIDataset`: Dataset of image regions (ROIs) and integer class labels
- `prepare_dataset`: Prepare an .npz dataset from a directory of .npy cell image files

### Models

Model construction and evaluation.

- `Model`: Supported classification model architectures
- `create_model`: Create a classification model for cell image data
- `test_epoch`: Run one evaluation pass and return true and predicted labels

## Resources

- [Full documentation](https://hocheggerlab.github.io/omero-screen/cellclass/)
- [llms.txt](llms.txt) — Indexed API reference for LLMs
- [llms-full.txt](llms-full.txt) — Comprehensive documentation for LLMs