# Использование с NumPy

Этот документ представляет собой краткое введение к использованию `datasets` с NumPy, с особым акцентом на то, как извлекать объекты `numpy.ndarray` из наших наборов данных и как использовать их для обучения моделей на базе NumPy, таких как модели `scikit-learn`.

## Формат набора данных

По умолчанию наборы данных возвращают обычные объекты Python: целые числа, числа с плавающей точкой, строки, списки и т. д.

Чтобы получать массивы NumPy, можно задать формат набора данных как `numpy`:

```py
>>> from datasets import Dataset
>>> data = [[1, 2], [3, 4]]
>>> ds = Dataset.from_dict({"data": data})
>>> ds = ds.with_format("numpy")
>>> ds[0]
{'data': array([1, 2])}
>>> ds[:2]
{'data': array([
    [1, 2],
    [3, 4]])}
```

> [!TIP]
> Объект [Dataset](/docs/datasets/v5.2.0/ru/package_reference/main_classes#datasets.Dataset) представляет собой обёртку над таблицей Arrow, которая позволяет быстро считывать данные из массивов набора в массивы NumPy.

Обратите внимание, что точно такая же процедура применяется к объектам `DatasetDict`, так что при установке формата `DatasetDict` в `numpy` все `Dataset` в нём будут отформатированы как `numpy`:

```py
>>> from datasets import DatasetDict
>>> data = {"train": {"data": [[1, 2], [3, 4]]}, "test": {"data": [[5, 6], [7, 8]]}}
>>> dds = DatasetDict.from_dict(data)
>>> dds = dds.with_format("numpy")
>>> dds["train"][:2]
{'data': array([
    [1, 2],
    [3, 4]])}
```

### Многомерные массивы

Если ваш набор данных состоит из N-мерных массивов, вы увидите, что по умолчанию они считаются одним и тем же массивом, если форма (shape) фиксирована:

```py
>>> from datasets import Dataset
>>> data = [[[1, 2],[3, 4]], [[5, 6],[7, 8]]]  # fixed shape
>>> ds = Dataset.from_dict({"data": data})
>>> ds = ds.with_format("numpy")
>>> ds[0]
{'data': array([[1, 2],
        [3, 4]])}
```

```py
>>> from datasets import Dataset
>>> data = [[[1, 2],[3]], [[4, 5, 6],[7, 8]]]  # varying shape
>>> ds = Dataset.from_dict({"data": data})
>>> ds = ds.with_format("numpy")
>>> ds[0]
{'data': array([array([1, 2]), array([3])], dtype=object)}
```

Однако такая логика часто требует медленных сравнений форм и копирования данных. Чтобы избежать этого, необходимо явно использовать тип фичи `Array` и указать форму ваших тензоров:

```py
>>> from datasets import Dataset, Features, Array2D
>>> data = [[[1, 2],[3, 4]],[[5, 6],[7, 8]]]
>>> features = Features({"data": Array2D(shape=(2, 2), dtype='int32')})
>>> ds = Dataset.from_dict({"data": data}, features=features)
>>> ds = ds.with_format("numpy")
>>> ds[0]
{'data': array([[1, 2],
        [3, 4]])}
>>> ds[:2]
{'data': array([[[1, 2],
         [3, 4]],
 
        [[5, 6],
         [7, 8]]])}
```

### Другие типы признаков

Данные [ClassLabel](/docs/datasets/v5.2.0/ru/package_reference/main_classes#datasets.ClassLabel) корректно преобразуются в массивы:

```py
>>> from datasets import Dataset, Features, ClassLabel
>>> labels = [0, 0, 1]
>>> features = Features({"label": ClassLabel(names=["negative", "positive"])})
>>> ds = Dataset.from_dict({"label": labels}, features=features)
>>> ds = ds.with_format("numpy")
>>> ds[:3]
{'label': array([0, 0, 1])}
```

Строковые и двоичные объекты остаются без изменений, так как NumPy поддерживает только числа.

Также поддерживаются типы функций [Image](/docs/datasets/v5.2.0/ru/package_reference/main_classes#datasets.Image) и [Audio](/docs/datasets/v5.2.0/ru/package_reference/main_classes#datasets.Audio).

> [!TIP]
> Чтобы использовать тип функции [Image](/docs/datasets/v5.2.0/ru/package_reference/main_classes#datasets.Image), необходимо установить дополнительный пакет `vision` командой `pip install datasets[vision]`.

```py
>>> from datasets import Dataset, Features, Image
>>> images = ["path/to/image.png"] * 10
>>> features = Features({"image": Image()})
>>> ds = Dataset.from_dict({"image": images}, features=features)
>>> ds = ds.with_format("numpy")
>>> ds[0]["image"].shape
(512, 512, 3)
>>> ds[0]
{'image': array([[[ 255, 255, 255],
              [ 255, 255, 255],
              ...,
              [ 255, 255, 255],
              [ 255, 255, 255]]], dtype=uint8)}
>>> ds[:2]["image"].shape
(2, 512, 512, 3)
>>> ds[:2]
{'image': array([[[[ 255, 255, 255],
              [ 255, 255, 255],
              ...,
              [ 255, 255, 255],
              [ 255, 255, 255]]]], dtype=uint8)}
```

> [!TIP]
> Чтобы использовать тип функции [Audio](/docs/datasets/v5.2.0/ru/package_reference/main_classes#datasets.Audio), необходимо установить дополнительный пакет `audio` командой `pip install datasets[audio]`.

```py
>>> from datasets import Dataset, Features, Audio
>>> audio = ["path/to/audio.wav"] * 10
>>> features = Features({"audio": Audio()})
>>> ds = Dataset.from_dict({"audio": audio}, features=features)
>>> ds = ds.with_format("numpy")
>>> ds[0]["audio"]["array"]
array([-0.059021  , -0.03894043, -0.00735474, ...,  0.0133667 ,
              0.01809692,  0.00268555], dtype=float32)
>>> ds[0]["audio"]["sampling_rate"]
array(44100, weak_type=True)
```

## Загрузка данных

В NumPy нет встроенных возможностей для загрузки данных, поэтому вам нужно либо материализовать массивы NumPy, такие как `X, y`, для использования в `scikit-learn`, либо использовать библиотеку, например [PyTorch](https://pytorch.org/), чтобы загрузить данные с помощью `DataLoader`.

### Использование `with_format('numpy')`

Самый простой способ получить массивы NumPy из набора данных — использовать метод `with_format('numpy')`. Допустим, мы хотим обучить нейросеть на [наборе данных MNIST](http://yann.lecun.com/exdb/mnist/), доступном на HuggingFace Hub по адресу https://huggingface.co/datasets/mnist.

```py
>>> from datasets import load_dataset
>>> ds = load_dataset("ylecun/mnist")
>>> ds = ds.with_format("numpy")
>>> ds["train"][0]
{'image': array([[  0,   0,   0, ...],
                       [  0,   0,   0, ...],
                       ...,
                       [  0,   0,   0, ...],
                       [  0,   0,   0, ...]], dtype=uint8),
 'label': array(5)}
```

После того как формат задан, мы можем передавать датасет в модель на основе NumPy партиями, используя метод `Dataset.iter()`:

```py
>>> for epoch in range(epochs):
...     for batch in ds["train"].iter(batch_size=32):
...         x, y = batch["image"], batch["label"]
...         ...
```

