added docs to write results function

fastmri_recon/evaluate/utils/write_results.py

@@ -16,6 +16,24 @@ def _filename_submission(filename, brain=False):
     return name
 
 def write_result(exp_id, result, filename, coiltype='multicoil', scale_factor=1e6, brain=False, challenge=False):
+    """Write a reconstruction result to the correct file.
+
+    Args:
+        exp_id (str): the name of the experiments generating the reconstruction,
+            typically the model name.
+        result (ndarray): the numpy array containing the reconstruction.
+        filename (str): the test or challenge filename from which the
+            reconstruction was generated.
+        coiltype (str): either `'singlecoil'`` or `'multicoil'``, indicating the type
+            of acquisition. Defaults to `'multicoil'``.
+        scale_factor (float): the scale factor used for the reconstruction.
+            The result will be divided by this scale factor before being saved.
+            Default to 1e6.
+        brain (bool): whether the reconstruction is from the brain dataset.
+            Defaults to False.
+        challenge (bool): whether the reconstruction is from the challenge
+            dataset. For now only applies for brain data. Defaults to False.
+    """
     if brain:
         if challenge:
             res_main_dir = f'{FASTMRI_DATA_DIR}brain_{coiltype}_challenge/'