# Use com NumPy

Este documento é uma introdução rápida ao uso de `datasets` com NumPy, com foco especial em como obter objetos `numpy.ndarray` dos nossos datasets e como usá-los para treinar modelos baseados em NumPy, como modelos do `scikit-learn`.

## Formato do conjunto de dados

Por padrão, os conjuntos de dados retornam objetos Python comuns: inteiros, números de ponto flutuante, strings, listas, etc.

Para obter arrays do NumPy, você pode definir o formato do conjunto de dados como `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]
> Um objeto [Dataset](/docs/datasets/v5.2.0/pt/package_reference/main_classes#datasets.Dataset) é um encapsulamento de uma tabela Arrow, que permite leituras rápidas de arrays no dataset para arrays NumPy.

Observe que o mesmo procedimento exato se aplica a objetos `DatasetDict`, de modo que, ao definir o formato de um `DatasetDict` como `numpy`, todos os `Dataset`s presentes serão formatados como `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]])}
```

### Arrays N-dimensionais

Se o seu conjunto de dados consiste em arrays de N dimensões, você verá que, por padrão, eles são considerados o mesmo array se a forma for fixa:

```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)}
```

No entanto, essa lógica frequentemente exige comparações de forma e cópias de dados lentas. Para evitar isso, você deve usar explicitamente o tipo de recurso `Array` e especificar a forma dos seus tensors:

```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]]])}
```

### Outros tipos de recursos

Os dados de [ClassLabel](/docs/datasets/v5.2.0/pt/package_reference/main_classes#datasets.ClassLabel) são convertidos corretamente em arrays:

```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])}
```

Objetos de string e binários permanecem inalterados, pois o NumPy suporta apenas números.

Os tipos de recurso [Image](/docs/datasets/v5.2.0/pt/package_reference/main_classes#datasets.Image) e [Audio](/docs/datasets/v5.2.0/pt/package_reference/main_classes#datasets.Audio) também são suportados.

> [!TIP]
> Para usar o tipo de recurso [Image](/docs/datasets/v5.2.0/pt/package_reference/main_classes#datasets.Image), você precisará instalar o extra `vision` como `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]
> Para usar o tipo de recurso [Audio](/docs/datasets/v5.2.0/pt/package_reference/main_classes#datasets.Audio), você precisa instalar o extra `audio` como `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)
```

## Carregamento de dados

O NumPy não possui recursos nativos de carregamento de dados, portanto, você precisará materializar os arrays NumPy como `X, y` para usar no `scikit-learn` ou utilizar uma biblioteca como [PyTorch](https://pytorch.org/) para carregar seus dados usando um `DataLoader`.

### Usando `with_format('numpy')`

A maneira mais fácil de obter arrays NumPy de um dataset é usar o método `with_format('numpy')`. Vamos supor que queremos treinar uma rede neural no [dataset MNIST](http://yann.lecun.com/exdb/mnist/) disponível no HuggingFace Hub em 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)}
```

Uma vez definido o formato, podemos alimentar o modelo baseado em NumPy com o conjunto de dados em lotes usando o método `Dataset.iter()`:

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