Merge pull request #219 from tedhtchang/remove-url-dep-ref

Fix PyPi publish error caused by direct url reference

Author: anhuong

README.md

@@ -8,24 +8,24 @@ This repo provides basic tuning scripts with support for specific models. The re
 ## Installation
 
 ```
-pip install -e .
+pip install fms-hf-tuning
 ```
 
 > Note: After installing, if you wish to use [FlashAttention](https://github.com/Dao-AILab/flash-attention), then you need to install these requirements:
 ```
-pip install -e ".[dev]"
-pip install -e ".[flash-attn]"
+pip install fms-hf-tuning[dev]
+pip install fms-hf-tuning[flash-attn]
 ```
 [FlashAttention](https://github.com/Dao-AILab/flash-attention) requires the [CUDA Toolit](https://developer.nvidia.com/cuda-toolkit) to be pre-installed.
 
 If you wish to use [aim](https://github.com/aimhubio/aim), then you need to install it:
 ```
-pip install -e ".[aim]"
+pip install fms-hf-tuning[aim]
 ```
 
 If you wish to use [fms-acceleration](https://github.com/foundation-model-stack/fms-acceleration), you need to install it. 
 ```
-pip install -e ".[fms-accel]"
+pip install git+https://github.com/foundation-model-stack/fms-acceleration.git#subdirectory=plugins/framework
 ```
 `fms-acceleration` is a collection of plugins that packages that accelerate fine-tuning / training of large models, as part of the `fms-hf-tuning` suite. For more details on see [this section below](#fms-acceleration).
 
@@ -389,7 +389,7 @@ Equally you can pass in a JSON configuration for running tuning. See [build doc]
 
 To access `fms-acceleration` features the `[fms-accel]` dependency must first be installed:
   ```
-  $ pip install -e .[fms-accel]
+  $ pip install https://github.com/foundation-model-stack/fms-acceleration.git#subdirectory=plugins/framework
   ```
 
 Furthermore, the required `fms-acceleration` plugin must be installed. This is done via the command line utility `fms_acceleration.cli`. To show available plugins:

pyproject.toml

@@ -44,9 +44,6 @@ dependencies = [
 dev = ["wheel>=0.42.0,<1.0", "packaging>=23.2,<24", "ninja>=1.11.1.1,<2.0", "scikit-learn>=1.0, <2.0", "boto3>=1.34, <2.0"]
 flash-attn = ["flash-attn>=2.5.3,<3.0"]
 aim = ["aim>=3.19.0,<4.0"]
-fms-accel = [
-  "fms_acceleration @ git+https://github.com/foundation-model-stack/fms-acceleration.git#subdirectory=plugins/framework"
-]
 
 [tool.setuptools.packages.find]
 exclude = ["tests", "tests.*"]

tuning/config/acceleration_configs/acceleration_framework_config.py

@@ -178,10 +178,10 @@ def get_framework(self):
         else:
             if not self.is_empty():
                 raise ValueError(
-                    "No acceleration framework package found. To use, first "
-                    "ensure that 'pip install -e.[fms-accel]' is done first to "
-                    "obtain the acceleration framework dependency. Additional "
-                    "acceleration plugins make be required depending on the requsted "
+                    "No acceleration framework package found. To use, first ensure that "
+                    "'pip install git+https://github.com/foundation-model-stack/fms-acceleration.git#subdirectory=plugins/framework' "  # pylint: disable=line-too-long
+                    "is done first to obtain the acceleration framework dependency. Additional "
+                    "acceleration plugins make be required depending on the requested "
                     "acceleration. See README.md for instructions."
                 )