Skip to main content

The engression loss (energy score) proposed by Shen et al. for distributional regression with a few convenient wrappers, in Pytorch.

Project description

Engression - Pytorch

The engression loss (energy score) proposed by Shen et al. for distributional regression with a few convenient wrappers, in Pytorch.

The paper's original code by Xinwei Shen is available here.

Install

pip install engression-pytorch

Usage

import torch
from engression_pytorch import EnergyScoreLoss, gConcat

x = torch.randn(batch_size, input_dim)
y = torch.randn(batch_size, out_dim)
preds = torch.randn(batch_size, m, out_dim)

g = gConcat(
    model = model,
    noise_dim = 100,
    noise_type = 'normal',
    noise_scale = 1.0,
    m_train = 2, 
    m_eval = 512,
)

g.train() # change m to m_train
preds = g(x) # (batch_size, m_train, output_dim)

# loss = energy_score(y, preds, beta = 1.0, p = 2)
loss = EnergyScoreLoss(beta = 1.0, p = 2)(y, preds)
loss.backward()

g.eval() # changes m to m_predict
sample = g(x) # (batch_size, m_eval, output_dim)

Citations

@misc{shen2024engressionextrapolationlensdistributional,
      title={Engression: Extrapolation through the Lens of Distributional Regression}, 
      author={Xinwei Shen and Nicolai Meinshausen},
      year={2024},
      eprint={2307.00835},
      archivePrefix={arXiv},
      primaryClass={stat.ME},
      url={https://arxiv.org/abs/2307.00835}, 
}
@article{KNEIB202399,
title = {Rage Against the Mean – A Review of Distributional Regression Approaches},
journal = {Econometrics and Statistics},
volume = {26},
pages = {99-123},
year = {2023},
issn = {2452-3062},
doi = {https://doi.org/10.1016/j.ecosta.2021.07.006},
url = {https://www.sciencedirect.com/science/article/pii/S2452306221000824},
author = {Thomas Kneib and Alexander Silbersdorff and Benjamin Säfken},
}

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

engression_pytorch-0.1.1.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

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

engression_pytorch-0.1.1-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

Details for the file engression_pytorch-0.1.1.tar.gz.

File metadata

  • Download URL: engression_pytorch-0.1.1.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.11

File hashes

Hashes for engression_pytorch-0.1.1.tar.gz
Algorithm Hash digest
SHA256 cab703f98b2a9255a12d69bdfd48f320b22e3ef370f1520737e7df6d8f4c9f97
MD5 0535f9bb7ef3969010212c206acc470c
BLAKE2b-256 c1ef6a9388447e9ef75f5f221b3a73655ae6da7b25faabd030db5d5367b0162d

See more details on using hashes here.

File details

Details for the file engression_pytorch-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for engression_pytorch-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d0b2008646b9b8d862b6fe06782a01ca8e06db051d1b82664c58aea060a348bb
MD5 fe5cc02656e918a4ee845aa1e3c711eb
BLAKE2b-256 9997bdfff3eac89d5b3d14b72854fc7eb91ec74b33a1ff91b3f9b6de4aeb6aad

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