documentation

Tractables · Feb 13, 2024 · ea9cb21 · ea9cb21
1 parent 568d296
commit ea9cb21
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 68 deletions.
diff --git a/.gitignore b/.gitignore
@@ -166,4 +166,6 @@ examples/data
 examples/circuits
 examples/1_pc_training/samples_test.png
 
-tests/examples/
+tests/examples/
+
+docs/build/
diff --git a/docs/source/api.rst b/docs/source/api.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,19 +1,24 @@
-PyJuice
+Welcome to PyJuice's documentation!
 ===================================
 
-**PyJuice** is a Python library for Probabilistic Circuits.
+**PyJuice** is a Python library for Probabilistic Circuits. It aims to provide a easy-to-use environment for defining PCs that support efficient and scalable training and inference.
 
-Check out the :doc:`start` section for further information, including instructions for
- :ref:`installation` of the project.
-
-.. note::
+Getting started
+--------
 
-   This project is under active development.
+- Installation
+- Tutorials
 
-Contents
+API
 --------
 
+- :doc:`pyjuice <python-api/pyjuice>`
+- :doc:`pyjuice.nodes <python-api/nodes>`
+
 .. toctree::
+   :maxdepth: 1
+   :caption: API
+   :hidden:
 
-   start
-   api
+   python-api/pyjuice
+   python-api/nodes
diff --git a/docs/source/python-api/nodes.rst b/docs/source/python-api/nodes.rst
@@ -0,0 +1,11 @@
+pyjuice.nodes
+======
+
+.. currentmodule:: pyjuice.nodes
+
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+
+    foreach
+    foldup_aggregate
diff --git a/docs/source/python-api/pyjuice.rst b/docs/source/python-api/pyjuice.rst
@@ -0,0 +1,14 @@
+pyjuice
+======
+
+.. currentmodule:: pyjuice
+
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+
+    compile
+    inputs
+    product
+    summate
+    set_block_size