Batch Assignment

Overview

The Batch Assignment Plugin automatically assigns assets to batches based on configurable rules such as batch size, assignment strategy, and naming conventions. It enables users to efficiently organize large datasets into manageable groups, streamlining workflows for labeling, review, and processing stages.

Batch Assignment

Custom Batch Assignment

Plugin Functionality

The Batch Assignment Plugin processes project assets and assigns them to batches according to the provided configuration.

• Creates batches and assigns assets to batches automatically based on the provided configuration.

• Sorts assets using the specified field before assignment to ensure deterministic and reproducible batch structures across multiple runs.

• Generates batch names dynamically using the configured prefix, separator, and indexing logic, allowing flexible and standardized naming conventions.

• Preserves existing batch assignments and appends newly generated batch names when enabled, allowing incremental updates without losing prior groupings.

• Enables efficient organization and management of large datasets by structuring assets into clearly defined and scalable batches.

The plugin will process all assets in your project.

Currently, there is no way to only select specific assets as targets for the plugin.

This functionality helps maintain structured and scalable batch organization, especially for large annotation projects.

Example Configurations

Configuration-1: Sequential Assignment

{
  "keep_existing_batches": false,
  "assignment_type": "sequential",
  "batch_size": 2,
  "sort_assets": "external_id",
  "batch_name_prefix": "Batch",
  "batch_name_seperator": "-",
  "batch_name_add_zeros": true
}

Before Execution:

external_id_1 → N/A
external_id_2 → N/A
external_id_3 → N/A
external_id_4 → N/A
...
external_id_20 → N/A

After Execution:

external_id_1 → Batch-01
external_id_2 → Batch-01
external_id_3 → Batch-02
external_id_4 → Batch-02
...
external_id_20 → Batch-10

Configuration-2: Sequential Assignment with a Different Batch Size

{
  "keep_existing_batches": false,
  "assignment_type": "sequential",
  "batch_size": 3,
  "sort_assets": "external_id",
  "batch_name_prefix": "Batch",
  "batch_name_seperator": "-",
  "batch_name_add_zeros": true
}

Before Execution:

external_id_1 → N/A
external_id_2 → N/A
external_id_3 → N/A
external_id_4 → N/A
external_id_5 → N/A
external_id_6 → N/A
external_id_7 → N/A
...
external_id_20 → N/A

After Execution:

external_id_1 → Batch-01
external_id_2 → Batch-01
external_id_3 → Batch-01
external_id_4 → Batch-02
external_id_5 → Batch-02
external_id_6 → Batch-02
external_id_7 → Batch-03
...
external_id_20 → Batch-07

Configuration-3: Keep Existing Batches

{
  "keep_existing_batches": true,
  "assignment_type": "sequential",
  "batch_size": 1,
  "sort_assets": "external_id",
  "batch_name_prefix": "Batch",
  "batch_name_seperator": "-",
  "batch_name_add_zeros": true
}

Before Execution:

external_id_1 → Batch-01
external_id_2 → Batch-01
external_id_3 → Batch-02
external_id_4 → Batch-02
...
external_id_20 → Batch-10

After Execution:

external_id_1 → Batch-01|Batch-01
external_id_2 → Batch-01|Batch-02
external_id_3 → Batch-02|Batch-03
external_id_4 → Batch-02|Batch-04
...
external_id_20 → Batch-10|Batch-20

Configuration-4: Random Assignment

{
  "keep_existing_batches": false,
  "assignment_type": "random",
  "batch_size": 2,
  "sort_assets": "external_id",
  "batch_name_prefix": "Batch",
  "batch_name_seperator": "-",
  "batch_name_add_zeros": true
}

Before Execution:

external_id_1 → N/A
external_id_2 → N/A
external_id_3 → N/A
external_id_4 → N/A
...
external_id_20 → N/A

After Execution:

external_id_1 → Batch-06
external_id_2 → Batch-04
external_id_3 → Batch-08
external_id_4 → Batch-05
...
external_id_20 → Batch-04

Configuration-5: Divide batches into sub-batches

{
  "keep_existing_batches": true,
  "assignment_type": "sequential",
  "batch_size": 2,
  "sort_assets": "batch",
  "batch_name_prefix": "Sub-Batch",
  "batch_name_seperator": "-",
  "batch_name_add_zeros": true
}

Before Execution:

external_id_1 → Batch-1
external_id_2 → Batch-1
external_id_3 → Batch-1
external_id_4 → Batch-1
...
external_id_20 → Batch-1

After Execution:

external_id_1 → Batch-1|Sub-Batch-01
external_id_2 → Batch-1|Sub-Batch-01
external_id_3 → Batch-1|Sub-Batch-02
external_id_4 → Batch-1|Sub-Batch-02
...
external_id_20 → Batch-1|Sub-Batch-10

Supported Data Types

• Compatible with all data types available in AngoHub.

Supported Annotation Tools

• Compatible with all annotation tools available in AngoHub.

Plugin Configuration

You may vary a number of settings related to your export from the Config JSON field. Each option is detailed below:

{
  "keep_existing_batches": true,
  "assignment_type": "sequential",
  "batch_size": 100,
  "sort_assets": "external_id",
  "batch_name_prefix": "Batch",
  "batch_name_seperator": "-",
  "batch_name_add_zeros": true
}

• "keep_existing_batches": Determines whether existing batch assignments are preserved when assigning new batches. When set to true, the new batch is appended to the asset’s current batch list. When set to false, the existing batch assignment is overwritten and only the new batch is kept.

  • Example:

    • "keep_existing_batches": true

    • "keep_existing_batches": false

• "assignment_type": Determines how assets are distributed into batches.

  • Options:

    • "sequential"

    • "random"

  • Example:

    • "assignment_type": "sequential"

• "batch_size": Specifies the number of assets to include in each batch.

  • Example:

    • "batch_size": 100

• "sort_assets": Defines the sorting method to apply before batching.

  • Options:

    • "default"

    • "external_id"

    • "asset_id"

    • "batch"

  • Example:

    • "sort_assets": "external_id"

• "batch_name_prefix": Sets a prefix to include at the beginning of each batch name.

  • Example:

    • "batch_name_prefix": "Batch"

• "batch_name_separator": Defines the character or symbol used to separate the batch name prefix and number.

  • Example:

    • "batch_name_separator": "-"

• "batch_name_add_zeros": Determines whether batch numbers should include leading zeros for consistent naming.

  • Example:

    • "batch_name_add_zeros": true

    • "batch_name_add_zeros": false