Merge pull request #8 from szmazurek/feature/mkdocs

Add mkdocs config
mlcommons · Oct 25, 2024 · 89ac97d · 89ac97d
2 parents bd42754 + 99191a0
commit 89ac97d
Show file tree

Hide file tree

Showing 8 changed files with 16 additions and 9 deletions.
diff --git a/docs/acknowledgements.md b/docs/acknowledgements.md
@@ -11,15 +11,13 @@ This file records the following pieces of information:
 
 |        **Application**       |   **Lead Author**   |                       **Link**                       |
 |:------------------------:|:---------------:|:------------------------------------------------:|
-|    arxiv here      | Sarthak Pati |  |
+| Framework introduction   | Sarthak Pati    |     [Arxiv](https://arxiv.org/abs/2410.00173)|
 
 
 
 ## People
 
 - [All coders and developers of GaNDLF-Synth](https://github.com/mlcommons/GaNDLF-Synth/graphs/contributors)
 
-# TODO
 - Supervisors:
-
-    - [Spyridon Bakas](https://www.med.upenn.edu/cbica/sbakas/)
+    - [Spyridon Bakas](https://medicine.iu.edu/faculty/64865/bakas-spyridon)
diff --git a/docs/customize.md b/docs/customize.md
@@ -121,6 +121,6 @@ data_postprocessing:
 ```
 
 ## Distributed Training
-For detalis on using distributed training, see the [usage page](./usage.md#distributed-training).
+For detalis on using distributed training, see the [usage page](./usage.md#parallelize-the-training-and-inference).
 
 
diff --git a/docs/FAQ.md → docs/faq.md b/docs/FAQ.md → docs/faq.md
diff --git a/docs/images/favicon.png b/docs/images/favicon.png
diff --git a/docs/images/logo.png b/docs/images/logo.png
diff --git a/docs/index.md b/docs/index.md
@@ -1,6 +1,6 @@
 # GaNDLF-Synth
 
-The **G**ener**a**lly **N**uanced **D**eep **L**earning **F**ramework - **synth**esis (GaNDLF-Synth) for reproducible and automated deep generative modeling in medical imaging.
+The **G**ener**a**lly **N**uanced **D**eep **L**earning **F**ramework - **Synth**esis (GaNDLF-Synth) for reproducible and automated deep generative modeling in medical imaging.
 
 ## Why use GaNDLF-Synth?
 
@@ -36,6 +36,7 @@ and **CSV inputs** that describe the training data.
 
 ## Citation
 Please cite the following article for GaNDLF-Synth:
+```bib
 @misc{pati2024gandlfsynthframeworkdemocratizegenerative,
       title={GaNDLF-Synth: A Framework to Democratize Generative AI for (Bio)Medical Imaging}, 
       author={Sarthak Pati and Szymon Mazurek and Spyridon Bakas},
@@ -45,6 +46,7 @@ Please cite the following article for GaNDLF-Synth:
       primaryClass={cs.LG},
       url={https://arxiv.org/abs/2410.00173}, 
 }
+```
 
 ## Contact
 GaNDLF developers can be reached via the following ways:

diff --git a/docs/usage.md b/docs/usage.md
@@ -174,7 +174,7 @@ You can use the following code snippet to run GaNDLF:
   # -rt , --reset # [optional] completely resets the previous run by deleting `model-dir`
   # -rm , --resume # [optional] resume previous training by only keeping model dict in `model-dir`
 ```
-## Parallelize the Training
+## Parallelize the Training and Inference
 
 ### Using single or multiple GPUs
 GaNDLF-Synth supports using single or multiple GPUs out of the box. By default, if the GPU is available (`CUDA_VISIBLE_DEVICES` is set), training and inference will use it. If multiple GPUs are available, GaNDLF-Synth will use all of them by DDP strategy (described below).

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,8 +1,15 @@
-site_name: GaNDLF
+site_name: GaNDLF-Synth
 repo_url: https://github.com/mlcommons/GaNDLF-Synth
-repo_name: mlcommons/gandlf-ynth
+repo_name: mlcommons/gandlf-synth
 nav:
   - Home: index.md
+  - Getting Started: getting_started.md
+  - Installation: setup.md
+  - Usage: usage.md
+  - Customize training and inference: customize.md
+  - Extending GaNDLF-Synth: extending.md
+  - FAQ: faq.md
+  - Acknowledgements: acknowledgements.md
 theme:
   features:
     - toc.integrate