Add Pre-Commit Hooks and Fix Dev Dependency Issues (#12)

* Add pre commit functionality to the repo, fix any errors popping up with current state of main and running the pre commit checks, fix install and versioning issues with dev dependencies

* update DEVELOPING.md docs

Author: markurtz

.github/workflows/ci.yml

@@ -20,4 +20,3 @@ jobs:
 
       - name: Run tox
         run: tox
-

.pre-commit-config.yaml

@@ -0,0 +1,41 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.6.0
+  hooks:
+  - id: trailing-whitespace
+  - id: end-of-file-fixer
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.5.2
+  hooks:
+    - id: ruff
+- repo: https://github.com/psf/black-pre-commit-mirror
+  rev: 24.4.2
+  hooks:
+  - id: black
+- repo: https://github.com/pycqa/isort
+  rev: 5.13.2
+  hooks:
+  - id: isort
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v1.10.1
+  hooks:
+  - id: mypy
+    args: [--check-untyped-defs]
+    additional_dependencies:
+      [
+        # main dependencies
+        click,
+        datasets,
+        loguru,
+        numpy,
+        openai,
+        requests,
+        transformers,
+
+        # dev dependencies
+        pytest,
+
+        # types
+        types-click,
+        types-requests,
+      ]

DEVELOPING.md

@@ -1,19 +1,3 @@
-<!--
-Copyright (c) 2021 - present / Neuralmagic, Inc. All Rights Reserved.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-   http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
--->
-
 # Developing GuideLLM
 
 GuideLLM is developed and tested using Python 3.8-3.11.
@@ -33,16 +17,12 @@ python3 -m pip install -e "./[dev]"
 
 This will clone the GuideLLM repo, install it, and install the development dependencies.
 
-To develop framework specific features, you will also need the relevant framework packages.
-Those can be installed by adding the framework name to the install extras. Frameworks include
-`torch`, `keras`, and `tensorflow_v1`. For example:
+After this, install pre-commit hooks to ensure code quality and style checks are run before committing changes.
+
 ```bash
-python3 -m pip install -e "./[dev,torch]"
+pre-commit install
 ```
 
-Note: Running all pytorch tests using `make test TARGETS=torch`, also requires `torchvision`
-and `onnxruntime` install all these dependencies using `python3 -m pip install -e "./[dev, torch, torchvision, onnxruntime]"`
-
 **Code Styling and Formatting checks**
 
 ```bash
@@ -52,115 +32,3 @@ make quality
 
 This will run automatic code styling using `black` and `isort` and test that the
 repository's code matches its standards.
-
-**EXAMPLE: test changes locally**
-
-```bash
-make test TARGETS=<CSV of frameworks to run>
-```
-
-This will run the targeted GuideLLM unit tests for the frameworks specified.
-The targets should be specified, because not all framework dependencies can be installed to run all tests.
-
-To run just PyTorch tests, run
-```bash
-make test TARGETS=pytorch
-```
-
-File any error found before changes as an Issue and fix any errors found after making changes before submitting a Pull Request.
-
-## GitHub Workflow
-
-1. Fork the `neuralmagic/guidellm` repository into your GitHub account: https://github.com/neuralmagic/guidellm/fork.
-
-2. Clone your fork of the GitHub repository, replacing `<username>` with your GitHub username.
-
-   Use ssh (recommended):
-
-   ```bash
-   git clone [email protected]:<username>/guidellm.git
-   ```
-
-   Or https:
-
-   ```bash
-   git clone https://github.com/<username>/guidellm.git
-   ```
-
-3. Add a remote to keep up with upstream changes.
-
-   ```bash
-   git remote add upstream https://github.com/neuralmagic/guidellm.git
-   ```
-
-   If you already have a copy, fetch upstream changes.
-
-   ```bash
-   git fetch upstream
-   ```
-
-4. Create a feature branch to work in.
-
-   ```bash
-   git checkout -b feature-xxx remotes/upstream/main
-   ```
-
-5. Work in your feature branch.
-
-   ```bash
-   git commit -a
-   ```
-
-6. Periodically rebase your changes
-
-   ```bash
-   git pull --rebase
-   ```
-
-7. When done, combine ("squash") related commits into a single one
-
-   ```bash
-   git rebase -i upstream/main
-   ```
-
-   This will open your editor and allow you to re-order commits and merge them:
-   - Re-order the lines to change commit order (to the extent possible without creating conflicts)
-   - Prefix commits using `s` (squash) or `f` (fixup) to merge extraneous commits.
-
-8. Submit a pull-request
-
-   ```bash
-   git push origin feature-xxx
-   ```
-
-   Go to your fork main page
-
-   ```bash
-   https://github.com/<username>/guidellm
-   ```
-
-   If you recently pushed your changes GitHub will automatically pop up a `Compare & pull request` button for any branches you recently pushed to. If you click that button it will automatically offer you to submit your pull-request to the `neuralmagic/guidellm` repository.
-
-   - Give your pull-request a meaningful title.
-     You'll know your title is properly formatted once the `Semantic Pull Request` GitHub check
-     transitions from a status of "pending" to "passed".
-   - In the description, explain your changes and the problem they are solving.
-
-9. Addressing code review comments
-
-   Repeat steps 5. through 7. to address any code review comments and rebase your changes if necessary.
-
-   Push your updated changes to update the pull request
-
-   ```bash
-   git push origin [--force] feature-xxx
-   ```
-
-   `--force` may be necessary to overwrite your existing pull request in case your
-  commit history was changed when performing the rebase.
-
-   Note: Be careful when using `--force` since you may lose data if you are not careful.
-
-   ```bash
-   git push origin --force feature-xxx
-   ```

MANIFEST.in

@@ -1 +1 @@
-include LICENSE
+include LICENSE

docs/README.md

@@ -1 +0,0 @@
-TODO

docs/conf.py

@@ -1 +0,0 @@
-TODO

pyproject.toml

@@ -36,19 +36,19 @@ dependencies = [
 
 [project.optional-dependencies]
 dev = [
-    "guidellm[code_quality]",
-    "pre-commit",
-    "sphinx",
-]
-code_quality = [
-    "black",
-    "isort",
-    "mypy",
-    "pytest",
-    "pytest-mock",
-    "ruff",
-    "tox",
-    "types-requests"
+    # general
+    "pre-commit~=3.5.0",
+    "sphinx~=7.1.2",
+
+    # code quality
+    "black~=24.4.2",
+    "isort~=5.13.2",
+    "mypy~=1.10.1",
+    "pytest~=8.2.2",
+    "pytest-mock~=3.14.0",
+    "ruff~=0.5.2",
+    "tox~=4.16.0",
+    "types-requests~=2.32.0"
 ]
 
 

src/guidellm/core/distribution.py

@@ -16,7 +16,7 @@ class Distribution:
     :type data: List[Union[int, float]], optional
     """
 
-    def __init__(self, data: Optional[List[Union[int, float]]] = None):
+    def __init__(self, data: Optional[Union[List[int], List[float]]] = None):
         """
         Initialize the Distribution with optional data.
 
@@ -227,7 +227,7 @@ def describe(self) -> dict:
         logger.debug(f"Generated description: {description}")
         return description
 
-    def add_data(self, new_data: List[Union[int, float]]):
+    def add_data(self, new_data: Union[List[int], List[float]]):
         """
         Add new data points to the distribution.
 
@@ -237,7 +237,7 @@ def add_data(self, new_data: List[Union[int, float]]):
         self._data.extend(new_data)
         logger.debug(f"Added new data: {new_data}")
 
-    def remove_data(self, remove_data: List[Union[int, float]]):
+    def remove_data(self, remove_data: Union[List[int], List[float]]):
         """
         Remove specified data points from the distribution.
 

tests/conftest.py

@@ -28,6 +28,6 @@ def inner_wrapper(*_, base_url: Optional[str] = None, **kwargs) -> OpenAIBackend
 
         defaults.update(kwargs)
 
-        return Backend.create(**defaults)
+        return Backend.create(**defaults)  # type: ignore
 
     return inner_wrapper

tests/dummy/data/openai.py

@@ -37,7 +37,7 @@ def openai_completion_factory(
         }
         payload.update(kwargs)
 
-        yield Completion(**payload)
+        yield Completion(**payload)  # type: ignore
 
 
 def openai_model_factory(n: int = 3) -> Generator[Model, None, None]:

tests/unit/conftest.py

@@ -25,7 +25,7 @@ def openai_models_list_patch(mocker) -> List[openai.types.Model]:
     Mock available models function to avoid OpenAI API call.
     """
 
-    items: list[openai.types.Model] = [
+    items: List[openai.types.Model] = [
         item for item in dummy.data.openai_model_factory()
     ]
     mocker.patch(

tests/unit/request/test_base.py

@@ -74,7 +74,7 @@ def test_request_generator_repr():
 @pytest.mark.regression
 def test_request_generator_iter_calls_create_item():
     generator = TestRequestGenerator(mode="sync")
-    generator.create_item = Mock(
+    generator.create_item = Mock(  # type: ignore
         return_value=TextGenerationRequest(prompt="Mock prompt")
     )
 
@@ -91,7 +91,7 @@ def test_request_generator_iter_calls_create_item():
 @pytest.mark.regression
 def test_request_generator_async_iter_calls_create_item():
     generator = TestRequestGenerator(mode="sync")
-    generator.create_item = Mock(
+    generator.create_item = Mock(  # type: ignore
         return_value=TextGenerationRequest(prompt="Mock prompt")
     )
 

tox.ini

@@ -4,7 +4,7 @@ env_list = py38,py39,py310,py311,py312
 
 [testenv]
 deps = .[code_quality]
-commands = 
+commands =
     python -m pytest tests/unit
 
 [testenv:lint]