First Commit

.github/workflows/build-package.yaml

@@ -0,0 +1,26 @@
+name: build-package
+run-name: ${{ github.actor }} build package
+on: [pull_request]
+jobs:
+  build-package:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+      - uses: snok/install-poetry@v1
+        with:
+          version: 1.2.2
+          virtualenvs-create: false
+          installer-parallel: true
+      - run: poetry install
+      - run: poetry build
+      - run: echo "VERSION=$(poetry version --short)" >> $GITHUB_ENV
+      - run: ls dist
+#  TODO: Use upload to test build before release
+#      - name: Upload whl
+#        uses: actions/upload-artifact@v3
+#        with:
+#          name: build-whl
+#          path: dist/jax_tqdm-${{env.VERSION}}-py3-none-any.whl

.github/workflows/code-formatting.yaml

@@ -0,0 +1,19 @@
+name: code-formatting
+run-name: ${{ github.actor }} code format checks
+on: [pull_request]
+jobs:
+  run-pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+      - uses: snok/install-poetry@v1
+        with:
+          version: 1.2.2
+          virtualenvs-create: false
+          installer-parallel: true
+      - run: poetry install
+      - run: pre-commit install
+      - run: task lint

.github/workflows/run-tests.yaml

@@ -0,0 +1,18 @@
+name: run-tests
+run-name: ${{ github.actor }} run tests
+on: [pull_request]
+jobs:
+  run-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+      - uses: snok/install-poetry@v1
+        with:
+          version: 1.2.2
+          virtualenvs-create: false
+          installer-parallel: true
+      - run: poetry install
+      - run: pytest -vv

.gitignore

@@ -0,0 +1,131 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+.idea

.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+    -   id: check-docstring-first
+    -   id: check-merge-conflict
+    -   id: check-toml
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+-   repo: https://github.com/pycqa/flake8
+    rev: 3.9.2
+    hooks:
+    -   id: flake8
+        args:
+          - "--max-line-length=88"
+          - "--max-complexity=18"
+          - "--select=B,C,E,F,W,T4,B9"
+          - "--ignore=W503,E203"
+          - "--per-file-ignores=__init__.py:F401"
+-   repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+    -   id: isort
+        args:
+          - "--multi-line=3"
+          - "--use-parentheses"
+          - "--trailing-comma"
+-   repo: https://github.com/psf/black
+    rev: "refs/tags/22.3.0:refs/tags/22.3.0"
+    hooks:
+    -   id: black

README.md

@@ -0,0 +1,119 @@
+# Jaxpr-Viz
+
+JAX Computation Graph Visualisation Tool
+
+## Installation
+
+Install with pip:
+
+```bash
+pip install jpviz
+```
+
+## Usage
+
+Jaxpr-viz can be used to visualise jit compiled (and nested)
+functions, for example with the functions
+
+```python
+import jax
+import jax.numpy as jnp
+
+@jax.jit
+def foo(x):
+    return 2 * x
+
+@jax.jit
+def bar(x):
+    x = foo(x)
+    return x - 1
+```
+
+jaxpr-viz wraps functions, which can then be called
+with concrete arguments
+
+```python
+import jpviz
+
+jpviz.draw(bar)(jnp.arange(10))
+```
+
+produces
+
+![bar computation graph](.github/images/bar_collapsed.png)
+
+> **NOTE:** For sub-functions to show as nodes/sub-graphs they
+> need to be marked with `@jax.jit`
+
+### Visualisation Options
+
+#### Collapse Nodes
+By default, functions that are composed of only primitive functions
+are collapsed into a single node (like `foo` in the above example).
+The full computation graph can be rendered using the `collapse_primitives`
+flag
+
+```python
+import jpviz
+
+jpviz.draw(bar, collapse_primitives=True)(jnp.arange(10))
+```
+
+produces
+
+![bar computation graph](.github/images/bar_expanded.png)
+
+#### Show Types
+
+By default, type information is included in the node labels, this
+can be hidden using the `show_avals` flag
+
+```python
+import jpviz
+
+jpviz.draw(bar, show_avals=False)(jnp.arange(10))
+```
+
+produces
+
+![bar computation graph](.github/images/bar_no_types.png "Title")
+
+#### Jupyter Notebook
+
+To show the rendered graph in a jupyter notebook you can use the
+helper function `view_pydot`
+
+```python
+dot = jpviz.draw(bar, collapse_primitives=True)(jnp.arange(10))
+jpviz.view_pydot(dot)
+```
+
+## Developers
+
+Dependencies can be installed with [poetry](https://python-poetry.org/) by running
+
+```bash
+poetry install
+```
+
+### Pre-Commit Hooks
+
+Pre commit hooks can be installed by running
+
+```bash
+pre-commit install
+```
+
+Pre-commit checks can then be run using
+
+```bash
+task lint
+```
+
+### Tests
+
+Tests can be run with
+
+```bash
+task test
+```