Skip to content

removes need for PSMFeatureExtractor by always adding percolator features - #7323

Merged
timosachsenberg merged 31 commits into
developfrom
feature/PSMFeature_incorp
Nov 1, 2024
Merged

timosachsenberg merged 31 commits into
developfrom
feature/PSMFeature_incorp

Conversation

@timosachsenberg

@timosachsenberg timosachsenberg commented Jan 31, 2024 •

Copy link
Copy Markdown
Contributor

User description

Description

This PR focuses on the enhancement of several OpenMS Adapters (CometAdapter, MSFraggerAdapter, MSGFPlusAdapter, MascotAdapterOnline, XTandemAdapter) by adding percolator features to them. This is achieved by including PercolatorFeatureSetHelper.h and using its functions to add features to peptide identifications. The added features are then stored as meta values in the search parameters of protein identifications.

Checklist

  • Make sure that you are listed in the AUTHORS file
  • Add relevant changes and new features to the CHANGELOG file
  • I have commented my code, particularly in hard-to-understand areas
  • New and existing unit tests pass locally with my changes
  • Updated or added python bindings for changed or new classes (Tick if no updates were necessary.)

How can I get additional information on failed tests during CI

Click to expand If your PR is failing you can check out
  • The details of the action statuses at the end of the PR or the "Checks" tab.
  • http://cdash.openms.de/index.php?project=OpenMS and look for your PR. Use the "Show filters" capability on the top right to search for your PR number.
    If you click in the column that lists the failed tests you will get detailed error messages.

Advanced commands (admins / reviewer only)

Click to expand
  • /reformat (experimental) applies the clang-format style changes as additional commit. Note: your branch must have a different name (e.g., yourrepo:feature/XYZ) than the receiving branch (e.g., OpenMS:develop). Otherwise, reformat fails to push.
  • setting the label "NoJenkins" will skip tests for this PR on jenkins (saves resources e.g., on edits that do not affect tests)
  • commenting with rebuild jenkins will retrigger Jenkins-based CI builds

⚠️ Note: Once you opened a PR try to minimize the number of pushes to it as every push will trigger CI (automated builds and test) and is rather heavy on our infrastructure (e.g., if several pushes per day are performed).


Type

Enhancement


Description

This PR focuses on the enhancement of several OpenMS Adapters (CometAdapter, MSFraggerAdapter, MSGFPlusAdapter, MascotAdapterOnline, XTandemAdapter) by adding percolator features to them. This is achieved by including PercolatorFeatureSetHelper.h and using its functions to add features to peptide identifications. The added features are then stored as meta values in the search parameters of protein identifications.


Changes walkthrough

Relevant files
Enhancement
CometAdapter.cpp
Addition of Percolator Features to CometAdapter                                   

src/topp/CometAdapter.cpp

  • Included PercolatorFeatureSetHelper.h to add percolator features.
  • Added percolator features to peptide identifications.
+6/-0     
MSFraggerAdapter.cpp
Addition of Percolator Features to MSFraggerAdapter                           

src/topp/MSFraggerAdapter.cpp

  • Included PercolatorFeatureSetHelper.h to add percolator features.
  • Added percolator features to peptide identifications.
+5/-1     
MSGFPlusAdapter.cpp
Addition of Percolator Features to MSGFPlusAdapter                             

src/topp/MSGFPlusAdapter.cpp

  • Included PercolatorFeatureSetHelper.h to add percolator features.
  • Added percolator features to peptide identifications.
+6/-0     
MascotAdapterOnline.cpp
Addition of Percolator Features to MascotAdapterOnline                     

src/topp/MascotAdapterOnline.cpp

  • Included PercolatorFeatureSetHelper.h to add percolator features.
  • Added percolator features to peptide identifications.
+6/-0     
XTandemAdapter.cpp
Addition of Percolator Features to XTandemAdapter                               

src/topp/XTandemAdapter.cpp

  • Included PercolatorFeatureSetHelper.h to add percolator features.
  • Added percolator features to peptide identifications.
+5/-0     

✨ Usage guide:

Overview:
The describe tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

When commenting, to edit configurations related to the describe tool (pr_description section), use the following template:

/describe --pr_description.some_config1=... --pr_description.some_config2=...

With a configuration file, use the following template:

[pr_description]
some_config1=...
some_config2=...
Enabling\disabling automation
  • When you first install the app, the default mode for the describe tool is:
pr_commands = ["/describe --pr_description.add_original_user_description=true" 
                         "--pr_description.keep_original_user_title=true", ...]

meaning the describe tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description.

  • Markers are an alternative way to control the generated description, to give maximal control to the user. If you set:
pr_commands = ["/describe --pr_description.use_description_markers=true", ...]

the tool will replace every marker of the form pr_agent:marker_name in the PR description with the relevant content, where marker_name is one of the following:

  • type: the PR type.
  • summary: the PR summary.
  • walkthrough: the PR walkthrough.

Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all.

Custom labels

The default labels of the describe tool are quite generic: [Bug fix, Tests, Enhancement, Documentation, Other].

If you specify custom labels in the repo's labels page or via configuration file, you can get tailored labels for your use cases.
Examples for custom labels:

  • Main topic:performance - pr_agent:The main topic of this PR is performance
  • New endpoint - pr_agent:A new endpoint was added in this PR
  • SQL query - pr_agent:A new SQL query was added in this PR
  • Dockerfile changes - pr_agent:The PR contains changes in the Dockerfile
  • ...

The list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases.
Note that Labels are not mutually exclusive, so you can add multiple label categories.
Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.

Inline File Walkthrough 💎

For enhanced user experience, the describe tool can add file summaries directly to the "Files changed" tab in the PR page.
This will enable you to quickly understand the changes in each file, while reviewing the code changes (diffs).

To enable inline file summary, set pr_description.inline_file_summary in the configuration file, possible values are:

  • 'table': File changes walkthrough table will be displayed on the top of the "Files changed" tab, in addition to the "Conversation" tab.
  • true: A collapsable file comment with changes title and a changes summary for each file in the PR.
  • false (default): File changes walkthrough will be added only to the "Conversation" tab.
Utilizing extra instructions

The describe tool can be configured with extra instructions, to guide the model to a feedback tailored to the needs of your project.

Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Notice that the general structure of the description is fixed, and cannot be changed. Extra instructions can change the content or style of each sub-section of the PR description.

Examples for extra instructions:

[pr_description] 
extra_instructions="""
- The PR title should be in the format: '<PR type>: <title>'
- The title should be short and concise (up to 10 words)
- ...
"""

Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

More PR-Agent commands

To invoke the PR-Agent, add a comment using one of the following commands:

  • /review: Request a review of your Pull Request.
  • /describe: Update the PR title and description based on the contents of the PR.
  • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
  • /ask <QUESTION>: Ask a question about the PR.
  • /update_changelog: Update the changelog based on the PR's contents.
  • /add_docs 💎: Generate docstring for new components introduced in the PR.
  • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
  • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

See the tools guide for more details.
To list the possible configuration parameters, add a /config comment.

See the describe usage page for a comprehensive guide on using this tool.

@timosachsenberg
timosachsenberg marked this pull request as draft January 31, 2024 11:57
@timosachsenberg

Copy link
Copy Markdown
Contributor Author

/describe

@github-actions

Copy link
Copy Markdown
Contributor

PR Description updated to latest commit (bba2c7a)

1 similar comment
@github-actions

Copy link
Copy Markdown
Contributor

PR Description updated to latest commit (bba2c7a)

@github-actions

Copy link
Copy Markdown
Contributor

PR Analysis

  • 🎯 Main theme: Incorporating Percolator features into various adapters
  • 📝 PR summary: This PR aims to remove the need for PSMFeatureExtractor by always adding percolator features to various adapters. The adapters affected include CometAdapter, MSFraggerAdapter, MSGFPlusAdapter, MascotAdapterOnline, and XTandemAdapter.
  • 📌 Type of PR: Enhancement
  • 🧪 Relevant tests added: No
  • ⏱️ Estimated effort to review [1-5]: 3, because the changes are spread across multiple files but the changes themselves are not complex and follow a similar pattern.
  • 🔒 Security concerns: No

PR Feedback

💡 General suggestions: The changes are consistent across the files and the code seems to be well written. However, it would be beneficial to add tests to ensure the new functionality works as expected and does not introduce any regressions.

🤖 Code feedback:
relevant filesrc/topp/CometAdapter.cpp
suggestion      

Consider checking if the feature_set is not empty before setting the meta value. This could prevent potential issues if the addCOMETFeatures function does not add any features to the feature_set. [important]

relevant lineprotein_identifications.front().getSearchParameters().setMetaValue("extra_features", ListUtils::concatenate(feature_set, ","));

relevant filesrc/topp/MSFraggerAdapter.cpp
suggestion      

Similar to the previous suggestion, consider checking if the feature_set is not empty before setting the meta value. [important]

relevant lineprotein_identifications.front().getSearchParameters().setMetaValue("extra_features", ListUtils::concatenate(feature_set, ","));


✨ Usage guide:

Overview:
The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...
Utilizing extra instructions

The review tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project.

Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize.

Examples for extra instructions:

[pr_reviewer] # /review #
extra_instructions="""
In the 'general suggestions' section, emphasize the following:
- Does the code logic cover relevant edge cases?
- Is the code logic clear and easy to understand?
- Is the code logic efficient?
...
"""

Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

How to enable\disable automation
  • When you first install PR-Agent app, the default mode for the review tool is:
pr_commands = ["/review", ...]

meaning the review tool will run automatically on every PR, with the default configuration.
Edit this field to enable/disable the tool, or to change the used configurations

Auto-labels

The review tool can auto-generate two specific types of labels for a PR:

  • a possible security issue label, that detects possible security issues (enable_review_labels_security flag)
  • a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)
Extra sub-tools

The review tool provides a collection of possible feedbacks about a PR.
It is recommended to review the possible options, and choose the ones relevant for your use case.
Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example:
require_score_review, require_soc2_ticket, and more.

More PR-Agent commands

To invoke the PR-Agent, add a comment using one of the following commands:

  • /review: Request a review of your Pull Request.
  • /describe: Update the PR title and description based on the contents of the PR.
  • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
  • /ask <QUESTION>: Ask a question about the PR.
  • /update_changelog: Update the changelog based on the PR's contents.
  • /add_docs 💎: Generate docstring for new components introduced in the PR.
  • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
  • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

See the tools guide for more details.
To list the possible configuration parameters, add a /config comment.

See the review usage page for a comprehensive guide on using this tool.

@github-actions

Copy link
Copy Markdown
Contributor

PR Code Suggestions

Suggestions                                                                                                                                                         
possible issue
Add a check to ensure feature_set is not empty before using it. 

The feature_set variable is declared but not checked if it's empty before being used.
This could lead to unexpected behavior. It would be better to check if feature_set is
not empty before using it.

src/topp/CometAdapter.cpp [721-723]

 StringList feature_set;
 PercolatorFeatureSetHelper::addCOMETFeatures(peptide_identifications, feature_set);
-protein_identifications.front().getSearchParameters().setMetaValue("extra_features", ListUtils::concatenate(feature_set, ","));
+if (!feature_set.empty())
+{
+  protein_identifications.front().getSearchParameters().setMetaValue("extra_features", ListUtils::concatenate(feature_set, ","));
+}
 
Add a check to ensure feature_set is not empty before using it. 

Similar to the previous suggestion, it would be better to check if feature_set is not
empty before using it.

src/topp/MSFraggerAdapter.cpp [894-896]

 StringList feature_set;
 PercolatorFeatureSetHelper::addMSFRAGGERFeatures(feature_set);
-protein_identifications.front().getSearchParameters().setMetaValue("extra_features", ListUtils::concatenate(feature_set, ","));
+if (!feature_set.empty())
+{
+  protein_identifications.front().getSearchParameters().setMetaValue("extra_features", ListUtils::concatenate(feature_set, ","));
+}
 
Add a check to ensure feature_set is not empty before using it. 

Again, it would be better to check if feature_set is not empty before using it.

src/topp/MSGFPlusAdapter.cpp [860-862]

 StringList feature_set;
 PercolatorFeatureSetHelper::addMSGFFeatures(peptide_ids, feature_set);
-protein_ids.front().getSearchParameters().setMetaValue("extra_features", ListUtils::concatenate(feature_set, ","));
+if (!feature_set.empty())
+{
+  protein_ids.front().getSearchParameters().setMetaValue("extra_features", ListUtils::concatenate(feature_set, ","));
+}
 
Add a check to ensure feature_set is not empty before using it. 

Once more, it would be better to check if feature_set is not empty before using it.

src/topp/MascotAdapterOnline.cpp [449-451]

 StringList feature_set;
 PercolatorFeatureSetHelper::addMASCOTFeatures(all_pep_ids, feature_set);
-all_prot_ids.front().getSearchParameters().setMetaValue("extra_features", ListUtils::concatenate(feature_set, ","));
+if (!feature_set.empty())
+{
+  all_prot_ids.front().getSearchParameters().setMetaValue("extra_features", ListUtils::concatenate(feature_set, ","));
+}
 

✨ Usage guide:

Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.
When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...
Enabling\disabling automation

When you first install the app, the default mode for the improve tool is:

pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...]

meaning the improve tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.

Utilizing extra instructions

Extra instructions are very important for the improve tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project.

Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on.

Examples for extra instructions:

[pr_code_suggestions] # /improve #
extra_instructions="""
Emphasize the following aspects:
- Does the code logic cover relevant edge cases?
- Is the code logic clear and easy to understand?
- Is the code logic efficient?
...
"""

Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

A note on code suggestions quality
  • While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically.
  • Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base.
  • Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the custom suggestions 💎 tool
  • With large PRs, best quality will be obtained by using 'improve --extended' mode.
More PR-Agent commands

To invoke the PR-Agent, add a comment using one of the following commands:

  • /review: Request a review of your Pull Request.
  • /describe: Update the PR title and description based on the contents of the PR.
  • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
  • /ask <QUESTION>: Ask a question about the PR.
  • /update_changelog: Update the changelog based on the PR's contents.
  • /add_docs 💎: Generate docstring for new components introduced in the PR.
  • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
  • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

See the tools guide for more details.
To list the possible configuration parameters, add a /config comment.

See the improve usage page for a more comprehensive guide on using this tool.

@jpfeuffer

Copy link
Copy Markdown
Contributor

Have you tried the overwriteTOPPTests tool?

@timosachsenberg

Copy link
Copy Markdown
Contributor Author

I don't have X!Tandem here so I just went with the manual edits during household chores ;)
sorry if that caused a lot of noise.
Should be done now.

@timosachsenberg
timosachsenberg marked this pull request as ready for review November 1, 2024 11:22
@timosachsenberg
timosachsenberg merged commit 0fd0cc1 into develop Nov 1, 2024
@timosachsenberg
timosachsenberg deleted the feature/PSMFeature_incorp branch November 1, 2024 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants