DeepRank / deeprank2

An open-source deep learning framework for data mining of protein-protein interfaces or single-residue variants.
https://deeprank2.readthedocs.io/en/latest/?badge=latest
Apache License 2.0
32 stars 12 forks source link

docs: clarify queries' usage #586

Closed gcroci2 closed 6 months ago

gcroci2 commented 6 months ago

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 :)