Update docs

davidnabergoj · Aug 13, 2024 · 44364be · 44364be
1 parent b8fd46c
commit 44364be
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 0 deletions.
diff --git a/README.rst → README.md b/README.rst → README.md
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -0,0 +1,23 @@
+Welcome to Torchflows documentation!
+===================================
+
+Torchflows is a library for generative modeling and density estimation using normalizing flows.
+It implements many normalizing flow architectures and their building blocks for:
+
+* easy use of normalizing flows as trainable distributions;
+* easy implementation of new normalizing flows.
+
+Check out the :doc:`usage` section for further information, including
+how to :ref:`installation` the project.
+
+.. note::
+
+   This project is under active development.
+
+Contents
+--------
+
+.. toctree::
+
+   usage
+   api
diff --git a/docs/source/usage.rst b/docs/source/usage.rst
@@ -0,0 +1,13 @@
+Usage
+=====
+
+.. _installation:
+
+Installation
+------------
+
+To use Torchflows, first install it using pip:
+
+.. code-block:: console
+
+   (.venv) $ pip install torchflows