Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add specification for SegmentMax-16 #28103

Open
wants to merge 11 commits into
base: master
Choose a base branch
from

Conversation

p-wysocki
Copy link
Contributor

@p-wysocki p-wysocki commented Dec 17, 2024

Details:

Related PRs:

Tickets:

Signed-off-by: p-wysocki <[email protected]>
Signed-off-by: p-wysocki <[email protected]>
@p-wysocki p-wysocki requested a review from a team as a code owner December 17, 2024 15:08
@p-wysocki p-wysocki requested review from zKulesza and removed request for a team December 17, 2024 15:08
@github-actions github-actions bot added the category: docs OpenVINO documentation label Dec 17, 2024
Copy link
Member

@rkazants rkazants left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let us have EmbeddingSegmentsMax similar to EmbeddingSegmentsSum.
It should also have default index (defining default value for empty segment)


* **1**: *data*

* **Description**: The numerical data on which SegmentMax operation will be performed. **Required.**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please define input shapes and output shape for each input and describe what dimensions are equal

Copy link
Contributor Author

@p-wysocki p-wysocki Dec 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

data can have any rank and dimensions, so it's described as ND of any numerical type. segment_ids are specified to be a 1D tensor of non-negative, sorted integer numbers of size equal to the size of the first dimension of the input tensor.

Could you please specify what's missing? I think the shapes are covered, but I may be missing something.

@p-wysocki
Copy link
Contributor Author

Let us have EmbeddingSegmentsMax similar to EmbeddingSegmentsSum.

EmbeddingSegmentX is for sparse inputs, while SegmentMax I'm implementing (to unlock some models) accepts dense inputs, so I don't think it should be added as EmbeddingSegmentMax. I'm moving the discussion to internal channels, if it results in changes, I'll apply them to the PR.

@p-wysocki p-wysocki requested a review from rkazants December 18, 2024 12:34
Signed-off-by: p-wysocki <[email protected]>
* **2**: *segment_ids*

* **Description**: Controls how the data is divided into segments. **Required.**
* **Range of values**: 1D tensor of non-negative, sorted integer numbers. Its size is equal to the size of the first dimension of the input tensor.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can see that unsorted segment_ids may lead to error or undefined behavior (implementation specific, depends on the hardware).
Should we specify a common behavior for OV op?
Can be clarified at the plugin implementation stage.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assumed that we'll verify the orderliness of segment_ids during shape inference and raise an error if needed. We can always remove that check from shape inference later and unify the behavior, but I suppose for now the op will be enabled in CPU with reusage of reference implementation.

p-wysocki and others added 2 commits January 22, 2025 16:08
…ts/operation-specs/arithmetic/segment-max-16.rst

Co-authored-by: Katarzyna Mitrus <[email protected]>
Signed-off-by: p-wysocki <[email protected]>
@p-wysocki
Copy link
Contributor Author

There is also V2 https://www.tensorflow.org/api_docs/python/tf/raw_ops/SegmentMaxV2 where the default has been changed to numeric_limits::lowest(). Adding attribute for default value seems to be a simple solution to support both cases, but to enable V2 at once we would also need to consider "num_segments" input.

I added an attribute for the default value. num_segments, according to TF docs, is only used for shape inference so it shouldn't be much more work.

@p-wysocki p-wysocki requested review from praasz and mitruska January 23, 2025 10:57
…ts/operation-specs/arithmetic/segment-max-16.rst
…ts/operation-specs/arithmetic/segment-max-16.rst
Comment on lines 33 to 37
* **1**: *empty_segment_value*

* **Description**: The value assigned to segments which are empty. **Required.**
* **Range of values**: A scalar.
* **Type**: *T*
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let us have it as an input. it will be more convenient if this value is not constant to compute.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After some discussion with @mitruska I modified the empty_segment_value to still be an attribute, but now is called fill_mode and is of type string. The reason is that it's not an input to the TF operation, but a way to differentiate between SegmentMax and SegmentMaxV2. It allows us to create one operator and enable both of these.

The reason why its type has been changed to string is that the value LOWEST inserts the lower limit of type T into empty segments, and that lower value should be calculated at runtime because we may not know the type during operator conversion and some precision transformations may break the op.

What do you think? Can it stay as an attribute in its current form?

p-wysocki and others added 3 commits January 29, 2025 08:08
…ts/operation-specs/arithmetic/segment-max-16.rst

Co-authored-by: Roman Kazantsev <[email protected]>
…ts/operation-specs/arithmetic/segment-max-16.rst

Co-authored-by: Roman Kazantsev <[email protected]>
Signed-off-by: p-wysocki <[email protected]>
Comment on lines +33 to +40
* **1**: *empty_segment_value*

* **Description**: The value assigned to segments which are empty. **Required.**
* **Range of values**: Name of the mode in string format:

* ``ZERO`` - the empty segments are filled with zeros.
* ``LOWEST`` - the empty segments are filled with the lowest value of the data type *T*.
* **Type**: ``string``
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let it be a constant input (the fourth one) of type T please. It will be more flexible for future use cases.
Attribute is injected in IR and no way to change it in run-time

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since one of the values is LOWEST, which means the lowest value of type T, wouldn't this require custom behavior for graph type conversions? Setting that value dynamically during runtime could be safer.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know but I don't exclude that this operation can be used in some decompositions to express some new FW operation. If we make an attribute for it, we create additional constraints. I think we don't need addtional constraints and let it make more flexible.

Signed-off-by: p-wysocki <[email protected]>
Copy link
Member

@rkazants rkazants left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

still propose to avoid the attribute that can be input. Attribute is a constraint

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: docs OpenVINO documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants