Skip to content
This repository was archived by the owner on Oct 9, 2024. It is now read-only.

Commit

Permalink
add deprecation warning on input
Browse files Browse the repository at this point in the history
justjhong committed May 10, 2024
1 parent 1ddea97 commit 778a271
Showing 3 changed files with 22 additions and 3 deletions.
14 changes: 13 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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

4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -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 = [
7 changes: 7 additions & 0 deletions src/mrvi/__init__.py
Original file line number Diff line number Diff line change
@@ -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",

0 comments on commit 778a271

Please sign in to comment.