Add more notebooks (#23)

Author: dirmeier

.github/workflows/draft-paper.yaml

@@ -0,0 +1,28 @@
+name: joss
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  paper:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Build draft PDF
+        uses: openjournals/openjournals-draft-action@master
+        with:
+          journal: joss
+          # This should be the path to the paper within your repo.
+          paper-path: paper/paper.md
+      - name: Upload
+        uses: actions/upload-artifact@v1
+        with:
+          name: paper
+          # This is the output path where Pandoc will write the compiled
+          # PDF. Note, this should be the same directory as the input
+          # paper.md
+          path: paper/paper.pdf

.pre-commit-config.yaml

@@ -9,7 +9,6 @@ repos:
     - id: check-toml
     - id: check-yaml
     - id: debug-statements
-    - id: end-of-file-fixer
     - id: requirements-txt-fixer
     - id: trailing-whitespace
 
@@ -60,15 +59,6 @@ repos:
     args: ["--ignore-missing-imports"]
     files: "(surjectors|examples)"
 
-- repo: https://github.com/nbQA-dev/nbQA
-  rev: 1.6.3
-  hooks:
-  - id: nbqa-black
-  - id: nbqa-pyupgrade
-    args: [--py39-plus]
-  - id: nbqa-isort
-  - id: nbqa-flake8
-
 - repo: https://github.com/jorisroovers/gitlint
   rev: v0.19.1
   hooks:

README.md

@@ -2,7 +2,6 @@
 
 [![status](http://www.repostatus.org/badges/latest/concept.svg)](http://www.repostatus.org/#concept)
 [![ci](https://github.com/dirmeier/surjectors/actions/workflows/ci.yaml/badge.svg)](https://github.com/dirmeier/surjectors/actions/workflows/ci.yaml)
-[![codecov](https://codecov.io/gh/dirmeier/surjectors/branch/main/graph/badge.svg?token=dn1xNBSalZ)](https://codecov.io/gh/dirmeier/surjectors)
 [![version](https://img.shields.io/pypi/v/surjectors.svg?colorB=black&style=flat)](https://pypi.org/project/surjectors/)
 
 > Surjection layers for density estimation with normalizing flows

docs/examples.rst

@@ -1,5 +1,5 @@
-Examples
-========
+More examples
+=============
 
 .. note::
 

docs/index.rst

@@ -3,6 +3,12 @@
 👋 Welcome to Surjectors!
 =========================
 
+.. div:: sd-text-left sd-font-italic
+
+   Surjection layers for density estimation with normalizing flows
+
+----
+
 Surjectors is a light-weight library for density estimation using
 inference and generative surjective normalizing flows, i.e., flows can that reduce or increase dimensionality.
 Surjectors builds on Distrax and Haiku and is fully compatible with both of them.
@@ -89,6 +95,9 @@ Surjectors is licensed under the Apache 2.0 License.
     :hidden:
 
     Introduction <notebooks/introduction>
+    Unconditional and conditional density estimation <notebooks/normalizing_flows>
+    Dimensionality reduction using surjectors <notebooks/dimension_reduction>
+    Self-contained scripts <examples>
 
 ..  toctree::
     :caption: 🧱 API

docs/news.rst

@@ -1,6 +1,10 @@
 📰 News
 =======
 
+Latest news on the development of `Surjectors`.
+
+-------
+
 .. note::
 
     No news so far :).