Final release of hfppl before rename (#36)

Author: benlebrun

README.md

@@ -4,7 +4,9 @@
 [![Tests](https://github.com/genlm/hfppl/actions/workflows/tests.yml/badge.svg)](https://github.com/genlm/hfppl/actions/workflows/tests.yml)
 [![codecov](https://codecov.io/gh/probcomp/hfppl/graph/badge.svg?token=414EHUC2P3)](https://codecov.io/gh/probcomp/hfppl)
 
-
+⚠️ **DEPRECATION NOTICE** ⚠️
+This package has been renamed to [`llamppl`](https://pypi.org/project/llamppl/).
+You're looking at the final release of `hfppl`. No further updates will be published here.
 
 LLaMPPL is a research prototype for language model probabilistic programming: specifying language generation tasks by writing probabilistic programs that combine calls to LLMs, symbolic program logic, and probabilistic conditioning. To solve these tasks, LLaMPPL uses a specialized sequential Monte Carlo inference algorithm. This technique, SMC steering, is described in [our recent workshop abstract](https://arxiv.org/abs/2306.03081).
 

hfppl/__init__.py

@@ -6,3 +6,11 @@
 from .llms import *
 from .modeling import *
 from .util import *
+
+import warnings
+
+warnings.warn(
+    "The 'hfppl' library is deprecated and will be renamed to 'llamppl'. "
+    "Please migrate to 'llamppl'. This is the final release of 'hfppl'.",
+    DeprecationWarning,
+)

pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "hfppl"
 version = "0.0.0"
-description = "Probabilistic programming with HuggingFace Transformer models."
+description = "Deprecated. Please use 'llamppl' instead."
 authors = [
     "Alex Lew <[email protected]>",
     "Gabriel Grand <[email protected]>",