Initial MKDocs commit (#8)

Author: szaman19

DGraph/__init__.py

@@ -0,0 +1,20 @@
+# Copyright (c) 2014-2024, Lawrence Livermore National Security, LLC.
+# Produced at the Lawrence Livermore National Laboratory.
+# Written by the LBANN Research Team (B. Van Essen, et al.) listed in
+# the CONTRIBUTORS file. See the top-level LICENSE file for details.
+#
+# LLNL-CODE-697807.
+# All rights reserved.
+#
+# This file is part of LBANN: Livermore Big Artificial Neural Network
+# Toolkit. For details, see http://software.llnl.gov/LBANN or
+# https://github.com/LBANN and https://github.com/LLNL/LBANN.
+#
+# SPDX-License-Identifier: (Apache-2.0)
+
+"""DGraph.
+
+Modules exported by this package:
+
+- `Communicator`: The DGraph communicator used to perform communication over PyTorch.
+"""

DGraph/distributed/Engine.py

@@ -16,16 +16,31 @@
 
 
 class BackendEngine(object):
+    """The abstract DGraph communication engine used by the Communicator. The engine
+    is responsible for initializing the communication backend library, and performing
+    the necessary communication operations.
+
+    The engine should be implemented by the backend-specific classes. We currently
+    supports the following backends:
+    - NCCL
+    - MPI
+    - NVSHMEM
+    """
+
     def __init__(self):
+        """Initialize the communication backend library."""
         pass
 
     def init_process_group(self, *args, **kwargs):
+        """Initialize the communication backend library."""
         raise NotImplementedError
 
     def get_rank(self) -> int:
+        """Get the rank of the current process."""
         raise NotImplementedError
 
     def get_world_size(self) -> int:
+        """Get the total number of processes."""
         raise NotImplementedError
 
     def scatter(

DGraph/distributed/__init__.py

@@ -0,0 +1,20 @@
+# Copyright (c) 2014-2024, Lawrence Livermore National Security, LLC.
+# Produced at the Lawrence Livermore National Laboratory.
+# Written by the LBANN Research Team (B. Van Essen, et al.) listed in
+# the CONTRIBUTORS file. See the top-level LICENSE file for details.
+#
+# LLNL-CODE-697807.
+# All rights reserved.
+#
+# This file is part of LBANN: Livermore Big Artificial Neural Network
+# Toolkit. For details, see http://software.llnl.gov/LBANN or
+# https://github.com/LBANN and https://github.com/LLNL/LBANN.
+#
+# SPDX-License-Identifier: (Apache-2.0)
+
+"""DGraph Distributed Module
+
+Modules exported by this package:
+- `Engine`: The DGraph communication engine used by the Communicator.
+- `BackendEngine`: The abstract DGraph communication engine used by the Communicator.
+"""

README.md

@@ -47,4 +47,4 @@ A list of publications, presentations and posters are shown
 
 ## Reporting issues
 Issues, questions, and bugs can be raised on the [Github issue
-tracker](https://github.com/LBANN/lbann/issues).
+tracker](https://github.com/LBANN/DGraph/issues).

docs/index.md

@@ -0,0 +1,44 @@
+# LBANN: Livermore Big Artificial Neural Network Toolkit
+
+The Livermore Big Artificial Neural Network toolkit (LBANN) is an
+open-source, HPC-centric, deep learning training framework that is
+optimized to compose multiple levels of parallelism.
+
+LBANN provides model-parallel acceleration through domain
+decomposition to optimize for strong scaling of network training.  It
+also allows for composition of model-parallelism with both data
+parallelism and ensemble training methods for training large neural
+networks with massive amounts of data.  LBANN is able to advantage of
+tightly-coupled accelerators, low-latency high-bandwidth networking,
+and high-bandwidth parallel file systems.
+
+##  DGraph
+DGraph is deep learning library for training graph neural networks at scale that is built on top of PyTorch.
+
+
+### Running tests
+To run the tests, use the following command:
+```shell
+python -m pytest tests/
+```
+
+### Requirements
+DGraph requires the following packages:
+- PyTorch >= 2.1.0
+- NumPy
+- pytest
+
+For the full list of requirements, see `requirements.txt`.
+
+DGraph also requires the following libraries:
+- NCCL
+- NVSHMEM
+
+## Publications
+
+A list of publications, presentations and posters are shown
+[here](https://lbann.readthedocs.io/en/latest/publications.html).
+
+## Reporting issues
+Issues, questions, and bugs can be raised on the [Github issue
+tracker](https://github.com/LBANN/DGraph/issues).

docs/project-structure.md

@@ -0,0 +1,7 @@
+::: DGraph.Communicator.Communicator
+    options:
+        show_root_heading: true
+    
+::: DGraph.distributed.Engine.BackendEngine
+    options:
+        show_root_heading: true

docs/reference.md

@@ -0,0 +1,17 @@
+site_name: DGraph
+
+plugins:
+- mkdocstrings:
+    handlers:
+      python:
+        options:
+          show_root_heading: false
+
+theme:
+  name: material
+
+nav:
+  - Home: index.md
+  - Project Structure: project-structure.md
+  - GitHub: https://github.com/LBANN/DGraph
+  - Reference: reference.md