Fix packaging (quic#68)

* Fix pyproject.toml not including all source files

Signed-off-by: Ilango Rajagopal <[email protected]>

* Remove setup.py

Signed-off-by: Ilango Rajagopal <[email protected]>

* Added missing __init__.py files

Signed-off-by: Ilango Rajagopal <[email protected]>

* CI: Package install instead of editable install

Signed-off-by: Ilango Rajagopal <[email protected]>

* Remove duplicate code checkout stage

Signed-off-by: Ilango Rajagopal <[email protected]>

* Tests should not refer to ROOT_DIR

Signed-off-by: Ilango Rajagopal <[email protected]>

* Use direct path for test json files

Signed-off-by: Ilango Rajagopal <[email protected]>

* Add minimum version for setuptools

Signed-off-by: Ilango Rajagopal <[email protected]>

* Update installation instructions

Signed-off-by: Ilango Rajagopal <[email protected]>

---------

Signed-off-by: Ilango Rajagopal <[email protected]>

Author: irajagop

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: v0.3.4
+    rev: v0.5.2
     hooks:
       # Run the linter.
       - id: ruff

QEfficient/compile/__init__.py

@@ -0,0 +1,6 @@
+# -----------------------------------------------------------------------------
+#
+# Copyright (c) 2024 Qualcomm Innovation Center, Inc. All rights reserved.
+# SPDX-License-Identifier: BSD-3-Clause
+#
+# -----------------------------------------------------------------------------

QEfficient/transformers/models/__init__.py

@@ -0,0 +1,6 @@
+# -----------------------------------------------------------------------------
+#
+# Copyright (c) 2024 Qualcomm Innovation Center, Inc. All rights reserved.
+# SPDX-License-Identifier: BSD-3-Clause
+#
+# -----------------------------------------------------------------------------

README.md

@@ -89,18 +89,8 @@ System Requirements:
 
 ## Installation 
 ```bash
-# Create Python virtual env and activate it. (Required Python 3.8)
- 
-# Login to the Cloud AI 100 Server.
-ssh -X username@hostname
-
-python3.8 -m venv qeff_env
-source qeff_env/bin/activate
- 
-# Clone the QEfficient Repo.
- 
-# Install the qefficient-library in Host machine (Used for CLI APIs) (Until we have docker integrated in Apps SDK)
-pip install -e .
+pip install -U pip
+pip install git+https://github.com/quic/efficient-transformers
 ```
 
 # Quick Start Guide

pyproject.toml

@@ -39,11 +39,15 @@ test = ["pytest","pytest-mock"]
 quality = ["black", "ruff", "hf_doc_builder@git+https://github.com/huggingface/doc-builder.git"]
 
 [build-system]
-requires = ["setuptools"]
+requires = ["setuptools>=62.0.0"]
 build-backend = "setuptools.build_meta"
 
-[tool.setuptools]
-packages = ["QEfficient"]
+[tool.setuptools.packages.find]
+include = ["QEfficient*"]
+namespaces = false
+
+[tool.setuptools.dynamic.version]
+attr = "QEfficient.__version__"
 
 [tool.ruff]
 line-length = 120

scripts/Jenkinsfile

@@ -11,33 +11,16 @@ pipeline
 
     stages 
     {
-        stage('Code Checkout') 
-        {
-            steps 
-            {
-                checkout scm
-            }
-        }
-        stage('Env Activation')
-        {
-            steps
-            {
-            sh '''
-                    mkdir -p preflight_qeff
-                    python3.8 -m venv preflight_qeff
-                    . preflight_qeff/bin/activate
-                '''
-            } 
-        }
-        stage('Install requirments')
+        stage('Install QEfficient')
         {
             steps
             {
                 sh '''
+                    python3.8 -m venv preflight_qeff
                     . preflight_qeff/bin/activate
                     pip install --upgrade pip setuptools
-                    pip install /opt/qti-aic/dev/lib/x86_64/qaic-0.0.1-py3-none-any.whl
-                    pip install -e .[test]
+                    pip install .[test]
+                    rm -rf QEfficient
                 '''
             }
         }

setup.py

@@ -13,7 +13,7 @@
 
 from QEfficient.generation.text_generation_inference import check_batch_size_and_num_prompts
 from QEfficient.utils import get_qpc_dir_path
-from QEfficient.utils.constants import QEFF_MODELS_DIR, ROOT_DIR, Constants
+from QEfficient.utils.constants import QEFF_MODELS_DIR, Constants
 from QEfficient.utils.logging_utils import logger
 
 
@@ -66,9 +66,7 @@ def __init__(
         self.model_name = model_name
         self.num_cores = num_cores
         self.prompt = prompt
-        self.prompts_txt_file_path = (
-            os.path.join(ROOT_DIR, prompts_txt_file_path) if prompts_txt_file_path is not None else None
-        )
+        self.prompts_txt_file_path = prompts_txt_file_path if prompts_txt_file_path is not None else None
         self.aic_enable_depth_first = aic_enable_depth_first
         self.mos = mos
         self.cache_dir = cache_dir
@@ -177,7 +175,7 @@ def pytest_generate_tests(metafunc):
     -----------
     Ref: https://docs.pytest.org/en/7.3.x/how-to/parametrize.html
     """
-    json_file = os.path.join(ROOT_DIR, "tests", "cloud", "high_level_testing.json")
+    json_file = "tests/cloud/high_level_testing.json"
     with open(json_file, "r") as file:
         json_data = json.load(file)
 

tests/cloud/conftest.py

@@ -6,16 +6,15 @@
 # -----------------------------------------------------------------------------
 
 import json
-import os
 
 import pytest
 from transformers import AutoConfig, AutoModelForCausalLM
 
-from QEfficient.utils.constants import ROOT_DIR, Constants
+from QEfficient.utils.constants import Constants
 from QEfficient.utils.device_utils import get_available_device_id
 from tests.utils import get_cloud_ai_100_tokens, set_up
 
-TEST_CONFIG_FILE_PATH = os.path.join(ROOT_DIR, "tests", "config.json")
+TEST_CONFIG_FILE_PATH = "tests/config.json"
 
 
 def get_config(model_config):

tests/transformers/models/test_causal_lm_models.py

@@ -15,7 +15,7 @@
 from QEfficient.exporter.export_hf_to_cloud_ai_100 import qualcomm_efficient_converter
 from QEfficient.transformers.transform import transform_lm
 from QEfficient.utils import hf_download, load_hf_tokenizer
-from QEfficient.utils.constants import QEFF_MODELS_DIR, ROOT_DIR, Constants
+from QEfficient.utils.constants import QEFF_MODELS_DIR, Constants
 from QEfficient.utils.device_utils import get_available_device_id, is_multi_qranium_setup_available, is_qpc_size_gt_32gb
 from QEfficient.utils.run_utils import ApiRunner
 
@@ -180,7 +180,7 @@ def get_cloud_ai_100_tokens(setup_info):
     if device_id:
         _, test_qpcs_path = compile_kv_model_on_cloud_ai_100(
             onnx_path=setup_info["onnx_model_path"],
-            specializations_json=f"{ROOT_DIR}/scripts/specializations.json",
+            specializations_json="scripts/specializations.json",
             num_cores=14,
             base_path=tests_qpc_dir,
             mxfp6=False,