From 947e1468ea83cddafdc026a02d7c376c62853921 Mon Sep 17 00:00:00 2001 From: Nishanth Kumar Date: Tue, 30 Nov 2021 01:34:38 -0500 Subject: [PATCH] includes minor changes to README and documentation --- README.md | 1 + docs/source/index.rst | 7 ++++++- pyproject.toml | 2 ++ 3 files changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 51a202df..4039060d 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ [![PyPI version](https://badge.fury.io/py/pgmax.svg)](https://badge.fury.io/py/pgmax) [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/vicariousinc/PGMax/master.svg)](https://results.pre-commit.ci/latest/github/vicariousinc/PGMax/master) [![codecov](https://codecov.io/gh/vicariousinc/PGMax/branch/master/graph/badge.svg?token=FrRlTDCFjk)](https://codecov.io/gh/vicariousinc/PGMax) +[![Documentation Status](https://readthedocs.org/projects/pgmax/badge/?version=latest)](https://pgmax.readthedocs.io/en/latest/?badge=latest) # PGMax diff --git a/docs/source/index.rst b/docs/source/index.rst index 1c15ea4f..4cdbf02b 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,6 +1,11 @@ PGMax Reference Documentation ============================== -PGMax is a library for working with Factor Graphs in `JAX `_. It currently provides an interface for specifying factor graphs of any type, as well as an efficient implementation of max-product belief propagation and inference on these graphs. +PGMax implements general factor graphs for probabilistic graphical models (PGMs) with discrete variables, and hardware-accelerated differentiable loopy belief propagation (LBP) in `JAX `_. + +- General factor graphs: PGMax goes beyond pairwise PGMs, and supports arbitrary factor graph topology, including higher-order factors. +- LBP in JAX: PGMax generates pure JAX functions implementing LBP for a given factor graph. The generated pure JAX functions run on modern accelerators (GPU/TPU), work with JAX transformations (e.g. ``vmap`` for processing batches of models/samples, ``grad`` for differentiating through the LBP iterative process), and can be easily used as part of a larger end-to-end differentiable system. + + .. toctree:: :maxdepth: 1 diff --git a/pyproject.toml b/pyproject.toml index 0b1982bc..1e04bc72 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,6 +3,7 @@ name = "pgmax" version = "0.2.0" description = "Loopy belief propagation for factor graphs on discrete variables, in JAX!" authors = ["Stannis Zhou ", "Nishanth Kumar ", "Miguel Lazaro-Gredilla ", "Dileep George "] +maintainers = ["Stannis Zhou ", "Nishanth Kumar "] # Additional info license = "MIT" readme = "README.md" @@ -11,6 +12,7 @@ include = [ ] homepage = "https://github.com/vicariousinc/PGMax" repository = "https://github.com/vicariousinc/PGMax" +documentation = "https://pgmax.readthedocs.io/en/latest/" keywords = ["PGMax", "jax"] [tool.poetry.dependencies]