From a54b34c11c2af5bcc7aa6690933ce81993d36098 Mon Sep 17 00:00:00 2001
From: Hamish Tomlinson <htomlinson@google.com>
Date: Tue, 21 Feb 2023 06:34:56 -0800
Subject: [PATCH] Improve readme explanation of ranked_*.pdb.

PiperOrigin-RevId: 511185129
Change-Id: I035bff2f22d5b863771711f300de335e4fb3e396
---
 README.md | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 1af8c72..d662305 100644
--- a/README.md
+++ b/README.md
@@ -576,12 +576,15 @@ The contents of each output file are as follows:
     structure, after performing an Amber relaxation procedure on the unrelaxed
     structure prediction (see Jumper et al. 2021, Suppl. Methods 1.8.6 for
     details).
-*   `ranked_*.pdb` – A PDB format text file containing the relaxed predicted
-    structures, after reordering by model confidence. Here `ranked_0.pdb` should
-    contain the prediction with the highest confidence, and `ranked_4.pdb` the
-    prediction with the lowest confidence. To rank model confidence, we use
+*   `ranked_*.pdb` – A PDB format text file containing the predicted structures,
+    after reordering by model confidence. Here `ranked_i.pdb` should contain
+    the prediction with the (`i + 1`)-th highest confidence (so that
+    `ranked_0.pdb` has the highest confidence). To rank model confidence, we use
     predicted LDDT (pLDDT) scores (see Jumper et al. 2021, Suppl. Methods 1.9.6
-    for details).
+    for details). If `--models_to_relax=all` then all ranked structures are
+    relaxed. If `--models_to_relax=best` then only `ranked_0.pdb` is relaxed
+    (the rest are unrelaxed). If `--models_to_relax=none`, then the ranked
+    structures are all unrelaxed.
 *   `ranking_debug.json` – A JSON format text file containing the pLDDT values
     used to perform the model ranking, and a mapping back to the original model
     names.
-- 
GitLab