mirror of
https://github.com/rdk/p2rank.git
synced 2026-06-04 12:44:24 +08:00
126a0653f0
Move misc/tutorials/ to documentation/ and add index readme. Update rescoring.md: add quick-start examples, paper links for all methods, add Pocketeer to supported methods list. Fix stale links in README.md (tutorials path, local-env.sh typo).
Documentation
This directory contains documentation and tutorials for P2Rank. Note that the coverage is spotty and incomplete -- not all features and workflows are documented here.
Usage
| File | Description |
|---|---|
| rescoring.md | Rescoring predictions from other pocket prediction methods (Fpocket, Pocketeer, etc.) |
| export-points.md | Exporting SAS points with feature vectors and predicted ligandability scores |
| aa-mapping.md | Non-canonical amino acid residue mapping to standard residues |
| hidden-commands.md | Miscellaneous hidden commands and analysis tools |
| random-examples.md | Assorted command-line examples for prediction and evaluation |
Training
| File | Description |
|---|---|
| training-tutorial.md | Training and evaluating custom models, crossvalidation, grid optimization |
| feature-setup.md | Feature vector configuration and introduction to adding new features |
| new-feature-evaluation-tutorial.md | Implementing a new feature and evaluating its contribution to prediction |
| hyperparameter-optimization-tutorial.md | Grid and Bayesian optimization of algorithm parameters |
| training-score-transformers.md | Training probability and z-score transformers for pocket and residue scores |