Skip to content

docs: clarify queries' usage#586

Merged
gcroci2 merged 6 commits intodevfrom
585_clarify_usage_queries_gcroci2
Mar 7, 2024
Merged

docs: clarify queries' usage#586
gcroci2 merged 6 commits intodevfrom
585_clarify_usage_queries_gcroci2

Conversation

@gcroci2
Copy link
Copy Markdown
Collaborator

@gcroci2 gcroci2 commented Mar 4, 2024

No description provided.

@gcroci2 gcroci2 changed the base branch from main to dev March 4, 2024 10:54
@gcroci2 gcroci2 requested a review from DaniBodor March 4, 2024 10:54
@gcroci2 gcroci2 linked an issue Mar 4, 2024 that may be closed by this pull request
Clarify usage of PPI and SRV in README. #585
Closed
DaniBodor
DaniBodor reviewed Mar 4, 2024
View reviewed changes
Copy link
Copy Markdown
Collaborator

@DaniBodor DaniBodor left a comment

Choose a reason for hiding this comment

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

Nice.
The other thing I felt was missing from the README is what we can actually do with it. In other words, what are ProteinProteinInterfaceQuery and SingleResidueVariantQuery?

In the very top of the README, we just state "DeepRank2 is an open-source deep learning (DL) framework for data mining of protein-protein interfaces (PPIs) or single-residue variants (SRVs)."
I think this statement warrants a little bit of extra information. Shall we do this in the same PR, or make a separate one?

@gcroci2
Copy link
Copy Markdown
Collaborator Author

gcroci2 commented Mar 5, 2024

Nice. The other thing I felt was missing from the README is what we can actually do with it. In other words, what are ProteinProteinInterfaceQuery and SingleResidueVariantQuery?

In the very top of the README, we just state "DeepRank2 is an open-source deep learning (DL) framework for data mining of protein-protein interfaces (PPIs) or single-residue variants (SRVs)." I think this statement warrants a little bit of extra information. Shall we do this in the same PR, or make a separate one?

I've done it here, give it a look :)

@gcroci2 gcroci2 requested a review from DaniBodor March 5, 2024 10:19
DaniBodor
DaniBodor approved these changes Mar 5, 2024
View reviewed changes
Copy link
Copy Markdown
Collaborator

@DaniBodor DaniBodor left a comment

Choose a reason for hiding this comment

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

Really good improvements!
I left one final suggestion to the PPI/SRV explanation.

I only looked at the README, I assume that the other two documents are copies from here, right?

@gcroci2 gcroci2 merged commit ba8d38a into dev Mar 7, 2024
@gcroci2 gcroci2 deleted the 585_clarify_usage_queries_gcroci2 branch March 7, 2024 10:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@DaniBodor DaniBodor DaniBodor approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Clarify usage of PPI and SRV in README.

2 participants

@gcroci2 @DaniBodor