KEMBAR78
Fix typo in aiq.profiler.decorators by dnandakumar-nv · Pull Request #132 · NVIDIA/NeMo-Agent-Toolkit · GitHub
Skip to content

Conversation

@dnandakumar-nv
Copy link
Contributor

Description

Fix a typo in aiq.profiler.decorators

By Submitting this PR I confirm:

  • I am familiar with the Contributing Guidelines.
  • We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
    • Any contribution which contains commits that are not Signed-Off will not be accepted.
  • When the PR is ready for review, new or existing tests cover these changes.
  • When the PR is ready for review, the documentation is up to date with these changes.

Introduce a `track_function` decorator to wrap sync, async, and generator functions for tracking execution spans. Added new SPAN_START, SPAN_CHUNK, and SPAN_END types to IntermediateStep. Updated tests to ensure tracking functionality is properly validated.

Signed-off-by: dnandakumar-nv <168006707+dnandakumar-nv@users.noreply.github.com>
This update adds the SPDX-based copyright and license headers to comply with legal and attribution requirements. The changes ensure proper licensing information is included for the test file.

Signed-off-by: dnandakumar-nv <168006707+dnandakumar-nv@users.noreply.github.com>
Document how to use the `@track_function` decorator in the profiler, outlining its stages, compatibility, and key benefits. This update helps users profile custom functions with ease, providing metadata, real-time event streaming, and automatic data serialization.

Signed-off-by: dnandakumar-nv <168006707+dnandakumar-nv@users.noreply.github.com>
Replaced the SpanPayload class with TraceMetadata within IntermediateStepPayload to standardize metadata handling. Updated the function tracking logic and corresponding tests to reflect this change, improving both clarity and maintainability.

Signed-off-by: dnandakumar-nv <168006707+dnandakumar-nv@users.noreply.github.com>
This commit introduces the `function_name` parameter to intermediate step tracking, ensuring the function's name is included in logs and metadata. This enhances traceability and debugging by providing more context about the tracked steps.

Signed-off-by: dnandakumar-nv <168006707+dnandakumar-nv@users.noreply.github.com>
Simplified and condensed docstrings to enhance readability and maintain focus on key functionality. Removed verbose examples and redundant details while retaining essential information about function behavior.

Signed-off-by: dnandakumar-nv <168006707+dnandakumar-nv@users.noreply.github.com>
Signed-off-by: dnandakumar-nv <168006707+dnandakumar-nv@users.noreply.github.com>
Corrected misspelled 'decroators' to 'decorators' in module paths and updated all relevant references across the codebase. This ensures consistent module imports and prevents potential import errors.

Signed-off-by: dnandakumar-nv <168006707+dnandakumar-nv@users.noreply.github.com>
@copy-pr-bot
Copy link

copy-pr-bot bot commented Apr 15, 2025

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

Signed-off-by: Dhruv Nandakumar <168006707+dnandakumar-nv@users.noreply.github.com>
@dnandakumar-nv dnandakumar-nv added improvement Improvement to existing functionality non-breaking Non-breaking change labels Apr 15, 2025
@dnandakumar-nv dnandakumar-nv marked this pull request as ready for review April 15, 2025 15:59
@dnandakumar-nv dnandakumar-nv requested a review from a team as a code owner April 15, 2025 15:59
@dnandakumar-nv
Copy link
Contributor Author

/ok to test

@copy-pr-bot
Copy link

copy-pr-bot bot commented Apr 15, 2025

/ok to test

@dnandakumar-nv, there was an error processing your request: E1

See the following link for more information: https://docs.gha-runners.nvidia.com/cpr/e/1/

@dnandakumar-nv dnandakumar-nv changed the title Fix typo Fix typo in aiq.profiler.decorators Apr 15, 2025
@dnandakumar-nv
Copy link
Contributor Author

/ok to test e1644ea

Copy link
Member

@willkill07 willkill07 left a comment

Choose a reason for hiding this comment

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

The misspelled directory removal should also be a part of the PR
(current branch HEAD does not contain removal: https://github.com/dnandakumar-nv/AgentIQ/tree/third-party-function-tracking/src/aiq/profiler)

Deleted framework-specific profiling and function tracking decorators (`framework_wrapper.py` and `function_tracking.py`). These removals likely indicate deprecation or a shift in approach to handling profiling logic.

Signed-off-by: dnandakumar-nv <168006707+dnandakumar-nv@users.noreply.github.com>
@dnandakumar-nv
Copy link
Contributor Author

The misspelled directory removal should also be a part of the PR (current branch HEAD does not contain removal: https://github.com/dnandakumar-nv/AgentIQ/tree/third-party-function-tracking/src/aiq/profiler)

Done. Thanks for catching this

@dnandakumar-nv
Copy link
Contributor Author

/ok to test 2e7f3c1

@dnandakumar-nv
Copy link
Contributor Author

/merge

@rapids-bot rapids-bot bot merged commit 99a9cba into NVIDIA:develop Apr 15, 2025
10 checks passed
yczhang-nv pushed a commit to yczhang-nv/NeMo-Agent-Toolkit that referenced this pull request Apr 21, 2025
Fix a typo in `aiq.profiler.decorators`

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/AgentIQ/blob/develop/docs/source/advanced/contributing.md).
- We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
  - Any contribution which contains commits that are not Signed-Off will not be accepted.
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.

Authors:
  - Dhruv Nandakumar (https://github.com/dnandakumar-nv)

Approvers:
  - Michael Demoret (https://github.com/mdemoret-nv)
  - Will Killian (https://github.com/willkill07)

URL: NVIDIA#132
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
ericevans-nv pushed a commit to ericevans-nv/agent-iq that referenced this pull request Apr 23, 2025
Fix a typo in `aiq.profiler.decorators`

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/AgentIQ/blob/develop/docs/source/advanced/contributing.md).
- We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
  - Any contribution which contains commits that are not Signed-Off will not be accepted.
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.

Authors:
  - Dhruv Nandakumar (https://github.com/dnandakumar-nv)

Approvers:
  - Michael Demoret (https://github.com/mdemoret-nv)
  - Will Killian (https://github.com/willkill07)

URL: NVIDIA#132
Signed-off-by: Eric Evans <194135482+ericevans-nv@users.noreply.github.com>
ericevans-nv pushed a commit to ericevans-nv/agent-iq that referenced this pull request Apr 23, 2025
Fix a typo in `aiq.profiler.decorators`

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/AgentIQ/blob/develop/docs/source/advanced/contributing.md).
- We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
  - Any contribution which contains commits that are not Signed-Off will not be accepted.
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.

Authors:
  - Dhruv Nandakumar (https://github.com/dnandakumar-nv)

Approvers:
  - Michael Demoret (https://github.com/mdemoret-nv)
  - Will Killian (https://github.com/willkill07)

URL: NVIDIA#132
Signed-off-by: Eric Evans <194135482+ericevans-nv@users.noreply.github.com>
yczhang-nv pushed a commit to yczhang-nv/NeMo-Agent-Toolkit that referenced this pull request May 8, 2025
Fix a typo in `aiq.profiler.decorators`

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/AgentIQ/blob/develop/docs/source/advanced/contributing.md).
- We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
  - Any contribution which contains commits that are not Signed-Off will not be accepted.
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.

Authors:
  - Dhruv Nandakumar (https://github.com/dnandakumar-nv)

Approvers:
  - Michael Demoret (https://github.com/mdemoret-nv)
  - Will Killian (https://github.com/willkill07)

URL: NVIDIA#132
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
AnuradhaKaruppiah pushed a commit to AnuradhaKaruppiah/oss-agentiq that referenced this pull request Aug 4, 2025
Fix a typo in `aiq.profiler.decorators`

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/AgentIQ/blob/develop/docs/source/advanced/contributing.md).
- We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
  - Any contribution which contains commits that are not Signed-Off will not be accepted.
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.

Authors:
  - Dhruv Nandakumar (https://github.com/dnandakumar-nv)

Approvers:
  - Michael Demoret (https://github.com/mdemoret-nv)
  - Will Killian (https://github.com/willkill07)

URL: NVIDIA#132
scheckerNV pushed a commit to scheckerNV/aiq-factory-reset that referenced this pull request Aug 22, 2025
Fix a typo in `aiq.profiler.decorators`

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/AgentIQ/blob/develop/docs/source/advanced/contributing.md).
- We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
  - Any contribution which contains commits that are not Signed-Off will not be accepted.
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.

Authors:
  - Dhruv Nandakumar (https://github.com/dnandakumar-nv)

Approvers:
  - Michael Demoret (https://github.com/mdemoret-nv)
  - Will Killian (https://github.com/willkill07)

URL: NVIDIA#132
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

improvement Improvement to existing functionality non-breaking Non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants