Docs dev

.github/workflows/documentation.yml

@@ -0,0 +1,38 @@
+name: Build and Deploy Sphinx Documentation
+
+# on:
+#   push:
+#     branches:
+#       - docs_dev
+#     tags:
+#       - 'v*'
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        persist-credentials: false
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.9'
+
+    - name: Install dependencies
+      run: |
+        pip install -r docs/requirements.txt
+        pip install sphinx sphinx-rtd-theme
+
+    - name: Build documentation
+      run: |
+        cd docs
+        make html
+
+    - name: Deploy to GitHub Pages
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./docs/_build/html

.readthedocs.yaml

@@ -0,0 +1,32 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+   install:
+   - requirements: docs/requirements.txt

docs/3dgan_doc.rst

@@ -0,0 +1,124 @@
+3DGAN
+=====
+
+This section covers the CERN use case that utilizes the `torch-lightning` framework for training and evaluation. The following files are integral to this use case:
+
+itwinai x 3DGAN
+---------------
+
+
+.. toctree::
+   :maxdepth: 5
+
+
+model.py
+++++++++
+
+.. literalinclude:: ../use-cases/3dgan/model.py
+   :language: python
+
+
+trainer.py
+++++++++++
+.. literalinclude:: ../use-cases/3dgan/trainer.py
+   :language: python
+
+
+saver.py
+++++++++
+
+.. literalinclude:: ../use-cases/3dgan/saver.py
+   :language: python
+
+
+dataloader.py
++++++++++++++
+
+.. literalinclude:: ../use-cases/3dgan/dataloader.py
+   :language: python
+
+
+cern-pipeline.yaml
+++++++++++++++++++
+
+This YAML file defines the pipeline configuration for the CERN use case.
+
+.. literalinclude:: ../use-cases/3dgan/cern-pipeline.yaml
+   :language: yaml
+
+
+inference-pipeline.yaml
++++++++++++++++++++++++
+
+This YAML file defines the pipeline configuration for the CERN use case inference.
+
+.. literalinclude:: ../use-cases/3dgan/inference-pipeline.yaml
+   :language: yaml
+
+
+Dockerfile
+++++++++++
+
+.. literalinclude:: ../use-cases/3dgan/Dockerfile
+   :language: bash
+
+
+pipeline.yaml
++++++++++++++
+
+This YAML file defines the pipeline configuration for the CERN use case. It includes settings for the model, training, and evaluation.
+
+.. literalinclude:: ../use-cases/3dgan/pipeline.yaml
+   :language: yaml
+
+
+
+This section covers the CERN use case integration with `interLink <https://github.com/interTwin-eu/interLink>`_ using ``itwinai``. The following files are integral to this use case:
+
+interLink x 3DGAN
+-----------------
+
+.. toctree::
+   :maxdepth: 5
+
+
+3dgan-inference-cpu.yaml
+++++++++++++++++++++++++
+
+.. literalinclude:: ../use-cases/3dgan/interLink/3dgan-inference-cpu.yaml
+   :language: yaml
+
+
+3dgan-inference.yaml
+++++++++++++++++++++++++
+
+.. literalinclude:: ../use-cases/3dgan/interLink/3dgan-inference.yaml
+   :language: yaml
+
+
+
+
+.. .. automodule:: 3dgan.model
+..     :members:
+..     :undoc-members:
+..     :show-inheritance:
+
+.. .. automodule:: 3dgan.train
+..     :members:
+..     :undoc-members:
+..     :show-inheritance:
+
+.. .. automodule:: 3dgan.trainer
+..     :members:
+..     :undoc-members:
+..     :show-inheritance:
+
+.. .. automodule:: 3dgan.saver
+..     :members:
+..     :undoc-members:
+..     :show-inheritance:
+
+.. .. automodule:: 3dgan.dataloader
+..     :members:
+..     :undoc-members:
+..     :show-inheritance:

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)