***

layout: overview
slug: nemo-curator/nemo\_curator/tasks/image
title: nemo\_curator.tasks.image
--------------------------------

## Module Contents

### Classes

| Name                                                   | Description                              |
| ------------------------------------------------------ | ---------------------------------------- |
| [`ImageBatch`](#nemo_curator-tasks-image-ImageBatch)   | Task for processing batches of images.   |
| [`ImageObject`](#nemo_curator-tasks-image-ImageObject) | Represents a single image with metadata. |

### API

<Anchor id="nemo_curator-tasks-image-ImageBatch">
  <CodeBlock links={{"nemo_curator.tasks.image.ImageObject":"#nemo_curator-tasks-image-ImageObject","nemo_curator.utils.performance_utils.StagePerfStats":"/nemo-curator/nemo_curator/utils/performance_utils#nemo_curator-utils-performance_utils-StagePerfStats"}} showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_curator.tasks.image.ImageBatch(
        task_id: str,
        dataset_name: str,
        data: list[nemo_curator.tasks.image.ImageObject] = list(),
        _stage_perf: list[nemo_curator.utils.performance_utils.StagePerfStats] = list(),
        _metadata: dict[str, typing.Any] = dict()
    )
    ```
  </CodeBlock>
</Anchor>

<Indent>
  <Badge>
    Dataclass
  </Badge>

  **Bases:** [Task](/nemo-curator/nemo_curator/tasks/tasks#nemo_curator-tasks-tasks-Task)

  Task for processing batches of images.
  Images are stored as a list of ImageObject instances, each containing
  the path to the image and associated metadata.

  <ParamField path="data" type="list[ImageObject] = field(default_factory=list)" />

  <ParamField path="num_items" type="int">
    Number of images in this batch.
  </ParamField>

  <Anchor id="nemo_curator-tasks-image-ImageBatch-validate">
    <CodeBlock showLineNumbers={false} wordWrap={true}>
      ```python
      nemo_curator.tasks.image.ImageBatch.validate() -> bool
      ```
    </CodeBlock>
  </Anchor>

  <Indent>
    Validate the task data.
  </Indent>
</Indent>

<Anchor id="nemo_curator-tasks-image-ImageObject">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_curator.tasks.image.ImageObject(
        image_path: str = '',
        image_id: str = '',
        metadata: dict[str, typing.Any] = dict(),
        image_data: numpy.ndarray | None = None,
        embedding: numpy.ndarray | None = None,
        aesthetic_score: float | None = None,
        nsfw_score: float | None = None
    )
    ```
  </CodeBlock>
</Anchor>

<Indent>
  <Badge>
    Dataclass
  </Badge>

  Represents a single image with metadata.

  <ParamField path="aesthetic_score" type="float | None = None" />

  <ParamField path="embedding" type="ndarray | None = None" />

  <ParamField path="image_data" type="ndarray | None = None" />

  <ParamField path="image_id" type="str = ''" />

  <ParamField path="image_path" type="str = ''" />

  <ParamField path="metadata" type="dict[str, Any] = field(default_factory=dict)" />

  <ParamField path="nsfw_score" type="float | None = None" />
</Indent>