Rename CLI tools and move to proper entry_point (#396)

Author: joecummings

setup.py

@@ -20,8 +20,12 @@ def read_requirements(file):
     packages=find_packages(),
     python_requires=">=3.8",
     install_requires=read_requirements("requirements.txt"),
-    scripts=["_scripts/cli_utils/tune"],
-    description="Package for finetuning LLMs and diffusion models using native PyTorch",
+    entry_points={
+        "console_scripts": [
+            "tune = torchtune._cli.cli_utils.tune:main",
+        ]
+    },
+    description="Package for finetuning LLMs using native PyTorch",
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",
     url="https://github.com/pytorch-labs/torchtune",

tests/_scripts/__init__.py tests/torchtune/_cli/__init__.pytests/_scripts/__init__.py renamed to tests/torchtune/_cli/__init__.py

@@ -4,4 +4,4 @@
 # This source code is licensed under the BSD-style license found in the
 # LICENSE file in the root directory of this source tree.
 
-TUNE_PATH = "_scripts/cli_utils/tune"
+TUNE_PATH = "torchtune/_cli/cli_utils/tune.py"

tests/_scripts/common.py tests/torchtune/_cli/common.pytests/_scripts/common.py renamed to tests/torchtune/_cli/common.py

@@ -13,13 +13,13 @@
 
 import pytest
 import torch
-
-from tests._scripts.common import TUNE_PATH
 from tests.test_utils import assert_expected
+
+from tests.torchtune._cli.common import TUNE_PATH
 from tests.torchtune.models.llama2.scripts.compare_decoder import Transformer
 from torchtune.models.llama2 import llama2
 
-ASSETS = Path(__file__).parent.parent / "assets"
+ASSETS = Path(__file__).parent.parent.parent / "assets"
 
 # Generating `tiny_state_dict_with_one_key.pt`
 # >>> import torch

tests/_scripts/conftest.py tests/torchtune/_cli/conftest.pytests/_scripts/conftest.py renamed to tests/torchtune/_cli/conftest.py

@@ -12,7 +12,7 @@
 
 import pytest
 
-from tests._scripts.common import TUNE_PATH
+from tests.torchtune._cli.common import TUNE_PATH
 
 
 class TestTuneCLIWithDownloadScript:

tests/_scripts/test_convert_checkpoint.py …orchtune/_cli/test_convert_checkpoint.pytests/_scripts/test_convert_checkpoint.py renamed to tests/torchtune/_cli/test_convert_checkpoint.py tests/_scripts/test_convert_checkpoint.py renamed to tests/torchtune/_cli/test_convert_checkpoint.py

@@ -8,11 +8,11 @@
 import runpy
 import sys
 
-from _scripts.ls import _NULL_VALUE
-
 from recipes import list_configs, list_recipes
 
-from tests._scripts.common import TUNE_PATH
+from tests.torchtune._cli.common import TUNE_PATH
+
+from torchtune._cli.ls import _NULL_VALUE
 
 
 class TestTuneCLIWithListScript:

tests/_scripts/test_download.py tests/torchtune/_cli/test_download.pytests/_scripts/test_download.py renamed to tests/torchtune/_cli/test_download.py

@@ -15,7 +15,7 @@
 import torchtune
 from recipes import list_configs, list_recipes
 
-from tests._scripts.common import TUNE_PATH
+from tests.torchtune._cli.common import TUNE_PATH
 
 
 class TestTuneCLI:

tests/_scripts/test_ls.py tests/torchtune/_cli/test_ls.pytests/_scripts/test_ls.py renamed to tests/torchtune/_cli/test_ls.py

@@ -0,0 +1,5 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+#
+# This source code is licensed under the BSD-style license found in the
+# LICENSE file in the root directory of this source tree.