Skip to main content

Generate ID

Synopsis

This operator adds a new attribute with

id role in the input ExampleSet. Each example in the input ExampleSet is tagged with an incremented id. If an attribute with id role already exists, it is overridden by the new id attribute.

Description

This operator adds a new attribute with id role in the input ExampleSet. It assigns a unique id to each example. This operator is usually used to uniquely identify each example. Each example in the input ExampleSet is tagged with an incremented id. The number from where the ids start can be controlled by the offset parameter. Numerical and integer ids can be assigned. If an attribute with id role already exists in the input ExampleSet, it is overridden by the new id attribute.

Input

example set input

This input port expects an ExampleSet. It is output of the Retrieve operator in the attached Example Process.

Output

example set output

The ExampleSet with an id attribute is output of this port.

original

The ExampleSet that was given as input is passed without changing to the output through this port. This is usually used to reuse the same ExampleSet in further operators or to view the ExampleSet in the Results Workspace.

Parameters

Create nominal ids

This parameter indicates if nominal ids should be created instead of integer ids. By default this parameter is not checked, thus integer ids are created by default. Nominal ids are of the format id_1, id_2, id_3 and so on.

Offset

This is an expert parameter. It is used if you want to start id from a number other than 1. This parameter is used to set the offset value. It is 0 by default, thus ids start from 1 by default.