From 61e191eb1b1bbd1ec529176ecc26fefa207ef9a2 Mon Sep 17 00:00:00 2001 From: Luca Antiga Date: Tue, 8 Nov 2022 13:43:42 +0100 Subject: [PATCH] Add project deprecation notice (#305) * Add project deprecation notice * typo Co-authored-by: Luca Antiga Co-authored-by: Jirka Borovec <6035284+Borda@users.noreply.github.com> Co-authored-by: Ethan Harris Co-authored-by: Jirka --- README.md | 14 ++++++++++++++ lightning_transformers/setup_tools.py | 2 +- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8833d72a..25972903 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,17 @@ +# Deprecation notice + +### Nov 8 2022 + +This repository is being deprecated and **will be archived (read-only) on Nov 18, 2022**. Thanks to everyone who contributed to `lightning-transformers`, we feel it's time to move on. + +:hugs: Transformers can **already be easily trained using the Lightning :zap: Trainer**. Here's a recent example from the community: . Note that there are **no limitations or workarounds**, things just work out of the box. + +The `lightning-transformers` repo explored the possibility to provide task-specific modules and pre-baked defaults, at the cost of introducing extra abstractions. In the spirit of keeping ourselves focused, these abstractions are not something we wish to continue supporting. + +If you liked `lightning-transformers` and want to continue developing it in the future, feel free to fork the repo and choose another name for the project. + +______________________________________________________________________ +
diff --git a/lightning_transformers/setup_tools.py b/lightning_transformers/setup_tools.py index 8e90991e..24fbc2ba 100644 --- a/lightning_transformers/setup_tools.py +++ b/lightning_transformers/setup_tools.py @@ -44,7 +44,7 @@ def _load_readme_description(path_dir: str, homepage: str, ver: str) -> str: """Load readme as decribtion. >>> _load_readme_description(_PROJECT_ROOT, "", "") # doctest: +ELLIPSIS +NORMALIZE_WHITESPACE - '
...' + '# ...' """ path_readme = os.path.join(path_dir, "README.md") text = open(path_readme, encoding="utf-8").read()