https://github.com/pyro-ppl/pyro-api

Generic API for dispatch to Pyro backends.
https://github.com/pyro-ppl/pyro-api

Last synced: 6 months ago
JSON representation

Generic API for dispatch to Pyro backends.

• Host: GitHub
• URL: https://github.com/pyro-ppl/pyro-api
• Owner: pyro-ppl
• License: apache-2.0
• Created: 2019-10-08T17:46:55.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-02-13T20:35:54.000Z (almost 4 years ago)
• Last Synced: 2025-03-29T13:22:26.706Z (10 months ago)
• Language: Python
• Homepage: https://pyro.ai/api
• Size: 52.7 KB
• Stars: 16
• Watchers: 7
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.com/pyro-ppl/pyro-api.svg?branch=master)](https://travis-ci.com/pyro-ppl/pyro-api)

[![Latest Version](https://badge.fury.io/py/pyro-api.svg)](https://pypi.python.org/pypi/pyro-api)

[![Documentation Status](https://readthedocs.org/projects/pyro-api/badge/?version=latest)](http://pyro-api.readthedocs.io/en/latest/?badge=master)

# Pyro API

Generic API for modeling and inference for dispatch to different Pyro backends.

----------------------------------------------------------------------------------------------------

## Testing

For testing API compatibility on different backends, install pytest and other test dependencies that includes backends like [funsor](https://github.com/pyro-ppl/funsor) and [numpyro](https://github.com/pyro-ppl/numpyro) and run the test suite:

```

pip install -e .[test]

pytest -vs

```

This library has no dependencies and can easily be installed for testing your particular Pyro backend

implementation. You can use the following pattern and test your backend on models in the `pyroapi.testing`

module.

```python

from pyro_api.dispatch import pyro_backend

from pyro_api.testing import MODELS

# Register backend

with pyro_backend(handlers='my_backend.handlers', 

                  distributions='my_backend.distributions',

                  ...):

                  

    # Test on models in pyro_api.testing

    for model in MODELS:

        f = MODELS[model]()

        model, model_args = f['model'], f.get('model_args', ())

        model(*model_args) 

        ... # further testing

```