From 4dbec03b19797c20964dafec28faee9afdf5f90b Mon Sep 17 00:00:00 2001
From: scap3yvt <149599669+scap3yvt@users.noreply.github.com>
Date: Wed, 6 Nov 2024 11:28:38 -0500
Subject: [PATCH] added faq point for the version mismatch

---
 docs/faq.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/docs/faq.md b/docs/faq.md
index dfe0c2234..0bb98239d 100644
--- a/docs/faq.md
+++ b/docs/faq.md
@@ -53,6 +53,10 @@ Please see https://mlcommons.github.io/GaNDLF/usage/#federating-your-model-evalu
 
 Please read the [migration guide](https://mlcommons.github.io/GaNDLF/migration_guide) to understand the changes that have been made to GaNDLF. If you have any questions, please feel free to [post a support request](https://github.com/mlcommons/GaNDLF/issues/new?assignees=&labels=&template=--questions-help-support.md&title=).
 
+### I am getting an error realted to version mismatch (greater or smaller) between the configuration and GaNDLF version. What should I do?
+
+This is a safety feature to ensure a tight integartion between the configuration used to define a model and the code version used to perform the training. Ensure that you have all requirements satisfied, and then check the ``version`` key in the configration, and ensure it appropriately matches the output of ``gandlf run --version``.
+
 ### What if I have another question?
 
 Please [post a support request](https://github.com/mlcommons/GaNDLF/issues/new?assignees=&labels=&template=--questions-help-support.md&title=).