new content and changes

interTwin-eu · May 15, 2024 · 383c7c3 · 383c7c3
1 parent 5300c7f
commit 383c7c3
Show file tree

Hide file tree

Showing 10 changed files with 120 additions and 359 deletions.
diff --git a/docs/3dgan_doc.rst b/docs/3dgan_doc.rst
@@ -38,22 +38,22 @@ dataloader.py
    :language: python
 
 
-cern-pipeline.yaml
-++++++++++++++++++
+config.yaml
++++++++++++
 
 This YAML file defines the pipeline configuration for the CERN use case.
 
-.. literalinclude:: ../use-cases/3dgan/cern-pipeline.yaml
+.. literalinclude:: ../use-cases/3dgan/config.yaml
    :language: yaml
 
 
-inference-pipeline.yaml
-+++++++++++++++++++++++
+create_inference_sample.py
+++++++++++++++++++++++++++
 
-This YAML file defines the pipeline configuration for the CERN use case inference.
+This file defines a pipeline configuration for the CERN use case inference.
 
-.. literalinclude:: ../use-cases/3dgan/inference-pipeline.yaml
-   :language: yaml
+.. literalinclude:: ../use-cases/3dgan/create_inference_sample.py
+   :language: python
 
 
 Dockerfile
@@ -63,13 +63,11 @@ Dockerfile
    :language: bash
 
 
-pipeline.yaml
-+++++++++++++
+startscript
++++++++++++
 
-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
+.. literalinclude:: ../use-cases/3dgan/startscript
+   :language: bash
 
 
 
@@ -90,12 +88,18 @@ interLink x 3DGAN
 
 
 3dgan-inference.yaml
-++++++++++++++++++++++++
+++++++++++++++++++++
 
 .. literalinclude:: ../use-cases/3dgan/interLink/3dgan-inference.yaml
    :language: yaml
 
 
+3dgan-train.yaml
+++++++++++++++++
+
+.. literalinclude:: ../use-cases/3dgan/interLink/3dgan-train.yaml
+   :language: yaml
+
 
 
 .. .. automodule:: 3dgan.model

diff --git a/docs/hpc_setup.rst b/docs/hpc_setup.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -37,23 +37,23 @@ In ``itwinai`` platform, we focus mainly on the MLOps step, simulating or oversi
 .. toctree::
    :maxdepth: 2
    :hidden:
-   :caption: 🪄 itwinai Modules
+   :caption: 📚 Integrated Use-cases
 
-   modules
+   use_cases
 
 .. toctree::
    :maxdepth: 2
    :hidden:
-   :caption: 📚 Integrated Use-cases
+   :caption: 🚀 Tutorials
 
-   use_cases
+   tutorials
 
 .. toctree::
    :maxdepth: 2
    :hidden:
-   :caption: 🚀 Tutorials
+   :caption: 🪄 Python API reference
 
-   tutorials
+   modules
 
 
 `interTwin Demo: itwinai integration with other DTE modules <https://www.youtube.com/watch?v=NoVCfSxwtX0>`_

diff --git a/docs/itwinai.cluster.rst b/docs/itwinai.cluster.rst
diff --git a/docs/itwinai.distributed.rst b/docs/itwinai.distributed.rst
@@ -0,0 +1,7 @@
+itwinai.distributed
+===================
+
+.. automodule:: itwinai.distributed
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/itwinai.tf.modules.rst b/docs/itwinai.tf.modules.rst
@@ -14,6 +14,13 @@ utils.py
    :language: python
 
 
+distributed.py
+++++++++++++++
+
+.. literalinclude:: ../src/itwinai/tensorflow/distributed.py
+   :language: python
+
+
 .. .. automodule:: itwinai.tensorflow.trainer
 ..    :members:
 ..    :undoc-members:

diff --git a/docs/itwinai.torch.modules.rst b/docs/itwinai.torch.modules.rst
@@ -1,10 +1,10 @@
 itwinai PyTorch Modules
 =======================
 
-cluster.py
-++++++++++
+distributed.py
+++++++++++++++
 
-.. literalinclude:: ../src/itwinai/torch/cluster.py
+.. literalinclude:: ../src/itwinai/torch/distributed.py
    :language: python
 
 inference.py
@@ -31,10 +31,10 @@ types.py
 .. literalinclude:: ../src/itwinai/torch/types.py
    :language: python
 
-utils.py
-++++++++
+reproducibility.py
+++++++++++++++++++
 
-.. literalinclude:: ../src/itwinai/torch/utils.py
+.. literalinclude:: ../src/itwinai/torch/reproducibility.py
    :language: python