From 778a2718b58f5d86fc9eadd3924193bb22697d6e Mon Sep 17 00:00:00 2001
From: Justin Hong <jjhong922@berkeley.edu>
Date: Fri, 10 May 2024 15:11:50 -0400
Subject: [PATCH] add deprecation warning on input

---
 CHANGELOG.md         | 14 +++++++++++++-
 pyproject.toml       |  4 ++--
 src/mrvi/__init__.py |  7 +++++++
 3 files changed, 22 insertions(+), 3 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 0e366c4..ba90a22 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -8,7 +8,19 @@ and this project adheres to [Semantic Versioning][].
 [keep a changelog]: https://keepachangelog.com/en/1.0.0/
 [semantic versioning]: https://semver.org/spec/v2.0.0.html
 
-## [1.0.0b1] - 2023-02-21
+## [1.0.1] - 2024-05-10
+
+### :warning: Deprecation Warning
+
+-   The MrVI implementation has been moved to `scvi-tools` (`from scvi.external import MRVI`),
+    and this package will no longer be maintained.
+
+### Added
+
+-   Adds deprecation warning in the form of a FutureWarning on import.
+-   Various fixes and UX improvements to the model kwargs, DE, and DA functions.
+
+## [1.0.0b1] - 2024-02-21
 
 ### :warning: Breaking Changes
 
diff --git a/pyproject.toml b/pyproject.toml
index 0ec75bf..e932be8 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -5,7 +5,7 @@ requires = ["hatchling"]
 
 [project]
 name = "mrvi"
-version = "1.0.0b1"
+version = "1.0.1"
 description = "Multi-resolution Variational Inference"
 readme = "README.md"
 requires-python = ">=3.9"
@@ -14,7 +14,7 @@ authors = [
     {name = "Justin Hong"},
     {name = "Pierre Boyeau"},
     {name = "Adam Gayoso"},
-    {name = "Can Ergan"},
+    {name = "Can Ergen"},
     {name = "Martin Kim"},
 ]
 maintainers = [
diff --git a/src/mrvi/__init__.py b/src/mrvi/__init__.py
index d53e676..f4ac438 100644
--- a/src/mrvi/__init__.py
+++ b/src/mrvi/__init__.py
@@ -1,9 +1,16 @@
+import warnings
 from importlib.metadata import version
 
 from ._model import MrVI
 from ._module import MrVAE
 from ._types import MrVIReduction
 
+warnings.warn(
+    "This package is deprecated. For the latest version of MrVI, please install `scvi-tools` and import the model class via `scvi.external.MRVI`.",
+    FutureWarning,
+    stacklevel=2,
+)
+
 __all__ = [
     "MrVI",
     "MrVAE",