Skip to content

fix: small changes to improve reliability of getting started notebooks#989

Merged
rapids-bot[bot] merged 3 commits intoNVIDIA:release/1.3from
bbednarski9:release/1.3
Oct 13, 2025
Merged

fix: small changes to improve reliability of getting started notebooks#989
rapids-bot[bot] merged 3 commits intoNVIDIA:release/1.3from
bbednarski9:release/1.3

Conversation

@bbednarski9
Copy link
Contributor

@bbednarski9 bbednarski9 commented Oct 13, 2025

Description

fix: small changes to improve reliability of getting started notebooks

This PR tweaks a couple of cells in the getting started notebooks to prevent users from running into a couple of easily avoided runtime errors in notebooks 1 & 3. pkill improves reliability of closing the nat service after making the curl. 'Revenue' change reduces changes that agent will improperly parameterize data analysis tool call.
Closes

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.

Summary by CodeRabbit

  • Bug Fixes

    • Improved the example notebook’s server shutdown step to target only the intended process, reducing the risk of terminating unrelated tasks.
  • Documentation

    • Clarified notebook prompt wording to explicitly reference the “Revenue” field when discussing outliers, improving instruction clarity for users working through the example.

Signed-off-by: Bryan Bednarski <bbednarski@nvidia.com>
Signed-off-by: Bryan Bednarski <bbednarski@nvidia.com>
@bbednarski9 bbednarski9 requested a review from a team as a code owner October 13, 2025 21:49
@coderabbitai
Copy link

coderabbitai bot commented Oct 13, 2025

Walkthrough

Two example notebooks were updated: one refines a process-termination command to target only “nat serve” processes; the other adjusts a notebook prompt string to reference the column name "Revenue" explicitly. No structural or control-flow changes were introduced.

Changes

Cohort / File(s) Summary
Notebook process command refinement
examples/notebooks/1_getting_started_with_nat.ipynb
Replaced pkill -9 nat with pkill -9 -f "nat serve" to match processes by full command line containing "nat serve".
Notebook prompt text tweak
examples/notebooks/3_adding_tools_and_agents.ipynb
Updated input string from asking for outliers in revenue to outliers in 'Revenue' (literal text change only).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested labels

bug, non-breaking

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title succinctly summarizes the main change, falls under 72 characters, and uses an imperative tone with “fix” to describe the update, meeting the style guideline for a concise, descriptive, imperative title.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 40b4d00 and 090fa20.

📒 Files selected for processing (2)
  • examples/notebooks/1_getting_started_with_nat.ipynb (1 hunks)
  • examples/notebooks/3_adding_tools_and_agents.ipynb (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
**/*

⚙️ CodeRabbit configuration file

**/*: # Code Review Instructions

  • Ensure the code follows best practices and coding standards. - For Python code, follow
    PEP 20 and
    PEP 8 for style guidelines.
  • Check for security vulnerabilities and potential issues. - Python methods should use type hints for all parameters and return values.
    Example:
    def my_function(param1: int, param2: str) -> bool:
        pass
  • For Python exception handling, ensure proper stack trace preservation:
    • When re-raising exceptions: use bare raise statements to maintain the original stack trace,
      and use logger.error() (not logger.exception()) to avoid duplicate stack trace output.
    • When catching and logging exceptions without re-raising: always use logger.exception()
      to capture the full stack trace information.

Documentation Review Instructions - Verify that documentation and comments are clear and comprehensive. - Verify that the documentation doesn't contain any TODOs, FIXMEs or placeholder text like "lorem ipsum". - Verify that the documentation doesn't contain any offensive or outdated terms. - Verify that documentation and comments are free of spelling mistakes, ensure the documentation doesn't contain any

words listed in the ci/vale/styles/config/vocabularies/nat/reject.txt file, words that might appear to be
spelling mistakes but are listed in the ci/vale/styles/config/vocabularies/nat/accept.txt file are OK.

Misc. - All code (except .mdc files that contain Cursor rules) should be licensed under the Apache License 2.0,

and should contain an Apache License 2.0 header comment at the top of each file.

  • Confirm that copyright years are up-to date whenever a file is changed.

Files:

  • examples/notebooks/1_getting_started_with_nat.ipynb
  • examples/notebooks/3_adding_tools_and_agents.ipynb
examples/**/*

⚙️ CodeRabbit configuration file

examples/**/*: - This directory contains example code and usage scenarios for the toolkit, at a minimum an example should
contain a README.md or file README.ipynb.

  • If an example contains Python code, it should be placed in a subdirectory named src/ and should
    contain a pyproject.toml file. Optionally, it might also contain scripts in a scripts/ directory.
  • If an example contains YAML files, they should be placed in a subdirectory named configs/. - If an example contains sample data files, they should be placed in a subdirectory named data/, and should
    be checked into git-lfs.

Files:

  • examples/notebooks/1_getting_started_with_nat.ipynb
  • examples/notebooks/3_adding_tools_and_agents.ipynb
🔇 Additional comments (2)
examples/notebooks/3_adding_tools_and_agents.ipynb (1)

945-945: LGTM! Explicit column name improves tool parameterization.

Wrapping 'Revenue' in single quotes clarifies that it's a literal column name rather than a general concept, which should help the LLM correctly pass it to the detect_outliers_iqr tool's metric parameter.

examples/notebooks/1_getting_started_with_nat.ipynb (1)

438-438: LGTM! More precise process targeting improves reliability.

Using pkill -9 -f "nat serve" instead of pkill -9 nat is more specific and safer. The -f flag matches against the full command line, ensuring only the NAT server process is terminated rather than any process with "nat" in its name.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai bot added bug Something isn't working non-breaking Non-breaking change labels Oct 13, 2025
@willkill07 willkill07 closed this Oct 13, 2025
@willkill07 willkill07 reopened this Oct 13, 2025
@willkill07 willkill07 closed this Oct 13, 2025
@willkill07 willkill07 reopened this Oct 13, 2025
@bbednarski9
Copy link
Contributor Author

/merge

@rapids-bot rapids-bot bot merged commit 19e52ee into NVIDIA:release/1.3 Oct 13, 2025
26 of 35 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working non-breaking Non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants