From ea9cb21d074ff9ca2da9202b1130ccd3e422ada0 Mon Sep 17 00:00:00 2001 From: Anji Liu Date: Tue, 13 Feb 2024 19:25:07 +0800 Subject: [PATCH] documentation --- .gitignore | 4 ++- docs/source/api.rst | 57 ------------------------------ docs/source/index.rst | 25 +++++++------ docs/source/python-api/nodes.rst | 11 ++++++ docs/source/python-api/pyjuice.rst | 14 ++++++++ 5 files changed, 43 insertions(+), 68 deletions(-) delete mode 100644 docs/source/api.rst create mode 100644 docs/source/python-api/nodes.rst create mode 100644 docs/source/python-api/pyjuice.rst diff --git a/.gitignore b/.gitignore index 3363da48..2e459a94 100644 --- a/.gitignore +++ b/.gitignore @@ -166,4 +166,6 @@ examples/data examples/circuits examples/1_pc_training/samples_test.png -tests/examples/ \ No newline at end of file +tests/examples/ + +docs/build/ \ No newline at end of file diff --git a/docs/source/api.rst b/docs/source/api.rst deleted file mode 100644 index 0e1dd421..00000000 --- a/docs/source/api.rst +++ /dev/null @@ -1,57 +0,0 @@ -API -=== - - -pyjuice.graph --------------- - -.. automodule:: pyjuice.graph - :imported-members: - :members: - :undoc-members: - :show-inheritance: - -pyjuice.layer --------------- - -.. automodule:: pyjuice.layer - :imported-members: - :members: - :undoc-members: - :show-inheritance: - -pyjuice.model --------------- - -.. automodule:: pyjuice.model - :imported-members: - :members: - :undoc-members: - :show-inheritance: - - -pyjuice.optim --------------- -.. automodule:: pyjuice.optim - :imported-members: - :members: - :undoc-members: - :show-inheritance: - -pyjuice.structures -------------------- -.. automodule:: pyjuice.structures - :imported-members: - :members: - :undoc-members: - :show-inheritance: - - - -pyjuice.transformations ------------------------- -.. automodule:: pyjuice.transformations - :imported-members: - :members: - :undoc-members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index 57a8ba2e..b4c0b289 100644 --- 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 ` +- :doc:`pyjuice.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 new file mode 100644 index 00000000..0d6a2415 --- /dev/null +++ b/docs/source/python-api/nodes.rst @@ -0,0 +1,11 @@ +pyjuice.nodes +====== + +.. currentmodule:: pyjuice.nodes + +.. autosummary:: + :toctree: generated + :nosignatures: + + foreach + foldup_aggregate \ No newline at end of file diff --git a/docs/source/python-api/pyjuice.rst b/docs/source/python-api/pyjuice.rst new file mode 100644 index 00000000..2e8f3781 --- /dev/null +++ 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 \ No newline at end of file