Skip to content

Conversation

@sanjaysgk
Copy link
Collaborator

@sanjaysgk sanjaysgk commented Jun 30, 2025

Summary by Sourcery

Update example notebook version references and introduce a new demonstration notebook with pipeline usage and sample outputs

New Features:

  • Add New_test.ipynb to showcase run_pipeline usage with logging and generated PeptiGram figures
  • Create processed_peptides_prot-peptigram.csv under test_outputAPI to record pipeline output data

Enhancements:

  • Bump protpeptigram version reference to 1.1.1.dev0 and clean up dependency log entries in example.ipynb

@sanjaysgk sanjaysgk merged commit d4c5875 into main Jun 30, 2025
3 checks passed
@sourcery-ai
Copy link

sourcery-ai bot commented Jun 30, 2025

Reviewer's Guide

This PR refines the example notebook by bumping the protpeptigram package version and cleaning up extraneous output lines, and adds a new end-to-end test notebook plus its generated CSV output to demonstrate and validate the full pipeline.

File-Level Changes

Change Details Files
Update version and clean output in example.ipynb
  • Bumped protpeptigram version from 1.0.0.dev0 to 1.1.1.dev0
  • Removed redundant pip notices and reordered dependency lines
  • Inserted missing “six” dependency line under python-dateutil
example/example.ipynb
Add comprehensive pipeline test notebook
  • Created New_test.ipynb with code cells to install, import, run and display pipeline logs
  • Included full DataProcessor and runner output captures
  • Demonstrated loading, filtering, formatting, and visualization steps
example/New_test.ipynb
Include processed peptides CSV output
  • Added processed_peptides_prot-peptigram.csv as pipeline artifact
  • Ensures test_outputAPI directory now contains expected CSV
test_outputAPI/processed_peptides_prot-peptigram.csv

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @sanjaysgk - I've reviewed your changes - here's some feedback:

  • Remove committed notebook outputs and generated files (e.g. images, test_outputAPI) from version control and provide only the cleaned notebook or script.
  • Avoid embedding absolute local file paths and environment-specific logs in the example notebooks to keep them portable.
  • Fix or remove the incomplete !pip install cell in the new notebook to ensure the install command is valid.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Remove committed notebook outputs and generated files (e.g. images, test_outputAPI) from version control and provide only the cleaned notebook or script.
- Avoid embedding absolute local file paths and environment-specific logs in the example notebooks to keep them portable.
- Fix or remove the incomplete `!pip install` cell in the new notebook to ensure the install command is valid.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants