Skip to main content

Package implementing PLN models

Project description

PLNmodels: Poisson lognormal models

The Poisson lognormal model and variants can be used for analysis of mutivariate count data. This package implements efficient algorithms to fit such models.

Getting started

The getting started can be found here. If you need just a quick view of the package, see next.

Installation

PLNmodels is available on pypi. The development version is available on GitHub.

Package installation

pip install pyPLNmodels

Usage and main fitting functions

The package comes with an ecological data set to present the functionality

import pyPLNmodels
from pyPLNmodels.models import PlnPCAcollection, Pln
from pyPLNmodels.oaks import load_oaks
oaks = load_oaks()

Unpenalized Poisson lognormal model (aka PLN)

pln = Pln.from_formula("counts ~ 1  + tree + dist2ground + orientation ", data = oaks, take_log_offsets = True)
pln.fit()
print(pln)

Rank Constrained Poisson lognormal for Poisson Principal Component Analysis (aka PLNPCA)

pca =  PlnPCAcollection.from_formula("counts ~ 1  + tree + dist2ground + orientation ", data = oaks, take_log_offsets = True, ranks = [3,4,5])
pca.fit()
print(pca)

References

Please cite our work using the following references:

  • J. Chiquet, M. Mariadassou and S. Robin: Variational inference for probabilistic Poisson PCA, the Annals of Applied Statistics, 12: 2674–2698, 2018. link

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyPLNmodels-0.0.58.tar.gz (1.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyPLNmodels-0.0.58-py3-none-any.whl (135.6 kB view details)

Uploaded Python 3

File details

Details for the file pyPLNmodels-0.0.58.tar.gz.

File metadata

  • Download URL: pyPLNmodels-0.0.58.tar.gz
  • Upload date:
  • Size: 1.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for pyPLNmodels-0.0.58.tar.gz
Algorithm Hash digest
SHA256 955c427e5f2c9e1d2892a72587094ed36dcfcfdca12253d94765ffccd073fe8e
MD5 16749fb8665cacef3d3ad1f03f458cd3
BLAKE2b-256 7a7094f07ca0447795a09742895f7e8f907a2860a4c3afab44f67e5b50bc4e5b

See more details on using hashes here.

File details

Details for the file pyPLNmodels-0.0.58-py3-none-any.whl.

File metadata

  • Download URL: pyPLNmodels-0.0.58-py3-none-any.whl
  • Upload date:
  • Size: 135.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for pyPLNmodels-0.0.58-py3-none-any.whl
Algorithm Hash digest
SHA256 bda4ec2949b850232a7f3eedd37ca5106e163518b56ab9c63031f8384701e9de
MD5 a0a270338c74c2ae4095bf88a26a6286
BLAKE2b-256 e9fccd358dd25e32aef8437e00d29b6aeb895f576868cc02beffe3aa03803ab3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page