Skip to content

Commit

Permalink
added mkdocs and a basic index file
Browse files Browse the repository at this point in the history
  • Loading branch information
sarthakpati authored Oct 3, 2024
1 parent 5e65cf8 commit cdf134a
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# GaNDLF-Synth

Presenting the **G**ener**a**lly **N**uanced **D**eep **L**earning **F**ramework for **Synth**esis (GaNDLF-Synth), a unified abstraction to train various synthesis algorithms in a zero/low code approach.

## Documentation

**Coming soon**!

## Citation

```
@misc{pati2024gandlfsynthframeworkdemocratizegenerative,
title={GaNDLF-Synth: A Framework to Democratize Generative AI for (Bio)Medical Imaging},
author={Sarthak Pati and Szymon Mazurek and Spyridon Bakas},
year={2024},
eprint={2410.00173},
archivePrefix={arXiv},
primaryClass={cs.LG},
url={https://arxiv.org/abs/2410.00173},
}
```
56 changes: 56 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
site_name: GaNDLF
repo_url: https://github.com/mlcommons/GaNDLF-Synth
repo_name: mlcommons/gandlf-ynth
nav:
- Home: index.md
theme:
features:
- toc.integrate
- search.suggest
- search.highlight
- search.share
- content.code.annotate
icon:
admonition:
note: octicons/tag-16
abstract: octicons/checklist-16
info: octicons/info-16
tip: octicons/squirrel-16
success: octicons/check-16
question: octicons/question-16
warning: octicons/alert-16
failure: octicons/x-circle-16
danger: octicons/zap-16
bug: octicons/bug-16
example: octicons/beaker-16
quote: octicons/quote-16
name: material
logo: images/logo.png
favicon: images/favicon.png
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: teal
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: teal
toggle:
icon: material/toggle-switch
name: Switch to light mode

markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- admonition
- pymdownx.details
- pymdownx.superfences
- toc:
permalink: True

0 comments on commit cdf134a

Please sign in to comment.