From eabe102f94854a70cd386dbea8e461ea89c95b66 Mon Sep 17 00:00:00 2001
From: Augustin Zidek <augustinzidek@google.com>
Date: Wed, 13 Nov 2024 11:14:54 +0000
Subject: [PATCH] Mention fundamental flags in the README

PiperOrigin-RevId: 696059716
---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/README.md b/README.md
index 0864122..415b2f2 100644
--- a/README.md
+++ b/README.md
@@ -73,6 +73,16 @@ python run_alphafold.py \
     --output_dir=/root/af_output
 ```
 
+There are various flags that you can pass to the `run_alphafold.py` command, to
+list them all run `python run_alphafold.py --help`. Two fundamental flags that
+control which parts AlphaFold 3 will run are:
+
+*   `--run_data_pipeline` (defaults to `true`): whether to run the data
+    pipeline, i.e. genetic and template search. This part is CPU-only, time
+    consuming and could be run on a machine without a GPU.
+*   `--run_inference` (defaults to `true`): whether to run the inference. This
+    part requires a GPU.
+
 ## AlphaFold 3 Input
 
 See the [input documentation](docs/input.md).
-- 
GitLab