Merge branch 'main' into main

Author: markurtz

.github/workflows/development.yml

@@ -91,17 +91,20 @@ jobs:
       matrix:
         python: ["3.9"]
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python }}
       - name: Install dependencies
-        run: pip install toml loguru tox
+        run: pip install tox
       - name: Build the package
         run: |
           export GUIDELLM_BUILD_TYPE=dev
-          export GUIDELLM_BUILD_NUMBER=${{ github.event.pull_request.number }}
+          export GUIDELLM_BUILD_ITERATION=${{ github.event.pull_request.number }}
           tox -e build
       - name: Upload build artifacts
         id: artifact-upload
@@ -112,9 +115,23 @@ jobs:
           compression-level: 6
           if-no-files-found: error
           retention-days: 30
+      - name: Generate GitHub App token
+        id: app-token
+        uses: actions/create-github-app-token@v1
+        with:
+          app-id: ${{ secrets.GH_NM_REDHAT_AUTOMATION_APP_ID }}
+          private-key: ${{ secrets.GH_NM_REDHAT_AUTOMATION_APP_PRIVATE_KEY }}
       - name: Comment Install instructions
-        uses: mshick/add-pr-comment@v2
+        uses: actions/github-script@v7
         with:
-          message: |
-            Build artifacts (.whl and .tar.gz) are available for download for up to 30 days.
-            They are located at ${{ steps.artifact-upload.outputs.artifact-url }}
+          github-token: ${{ steps.app-token.outputs.token }}
+          script: |
+            github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: `📦 **Build Artifacts Available**
+              The build artifacts (\`.whl\` and \`.tar.gz\`) have been successfully generated and are available for download: ${{ steps.artifact-upload.outputs.artifact-url }}.
+              They will be retained for **up to 30 days**.
+              `
+            })

.github/workflows/nightly.yml

@@ -19,7 +19,7 @@ jobs:
       - name: Install dependencies
         run: pip install tox
       - name: Run unit tests
-        run: tox -e test-unit -- -m --cov=guidellm --cov-report=term-missing --cov-fail-under=75
+        run: tox -e test-unit -- --cov=guidellm --cov-report=term-missing --cov-fail-under=75
 
   integration-tests:
     runs-on: ubuntu-latest
@@ -60,17 +60,19 @@ jobs:
       matrix:
         python: ["3.9"]
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python }}
       - name: Install dependencies
-        run: pip install toml loguru tox
+        run: pip install tox
       - name: Build the package
         run: |
           export GUIDELLM_BUILD_TYPE=nightly
-          export GUIDELLM_BUILD_NUMBER=${{ github.run_number }}
           tox -e build
       - name: Find wheel artifact
         id: find-asset-whl
@@ -103,4 +105,4 @@ jobs:
           retention-days: 30
       - name: Log artifact location
         run: |
-          echo "Artifacts uploaded to: https://api.github.com/repos/neuralmagic/guidellm/actions/artifacts/${{ steps.artifact-upload.outputs.artifact-id }}"
+          echo "Artifacts uploaded to: ${{ steps.artifact-upload.outputs.artifact-url }}"

.github/workflows/release-candidate.yml

@@ -4,9 +4,6 @@ on:
   push:
     branches:
       - 'release/*'
-  create:
-    branches:
-      - 'release/*'
 
 jobs:
   unit-tests:
@@ -64,17 +61,19 @@ jobs:
       matrix:
         python: ["3.9"]
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python }}
       - name: Install dependencies
-        run: pip install toml loguru tox
+        run: pip install tox
       - name: Build the package
         run: |
-          export GUIDELLM_BUILD_TYPE=release_candidate
-          export GUIDELLM_BUILD_NUMBER=${{ github.run_number }}
+          export GUIDELLM_BUILD_TYPE=candidate
           tox -e build
       - name: Upload build artifacts
         id: artifact-upload
@@ -87,7 +86,7 @@ jobs:
           retention-days: 30
       - name: Log artifact location
         run: |
-          echo "Artifacts uploaded to: https://api.github.com/repos/neuralmagic/guidellm/actions/artifacts/${{ steps.artifact-upload.outputs.artifact-id }}"
+          echo "Artifacts uploaded to: ${{ steps.artifact-upload.outputs.artifact-url }}"
       - name: Push wheel to PyPI
         uses: neuralmagic/nm-actions/actions/publish-whl@v1.0.0
         with:

.github/workflows/release.yml

@@ -12,17 +12,19 @@ jobs:
       matrix:
         python: ["3.9"]
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python }}
       - name: Install dependencies
-        run: pip install toml loguru tox
+        run: pip install tox
       - name: Build the package
         run: |
           export GUIDELLM_BUILD_TYPE=release
-          export GUIDELLM_BUILD_NUMBER=${{ github.run_number }}
           tox -e build
       - name: Upload build artifacts
         id: artifact-upload
@@ -35,7 +37,7 @@ jobs:
           retention-days: 90
       - name: Log artifact location
         run: |
-          echo "Artifacts uploaded to: https://api.github.com/repos/neuralmagic/guidellm/actions/artifacts/${{ steps.artifact-upload.outputs.artifact-id }}"
+          echo "Artifacts uploaded to: Artifacts uploaded to: ${{ steps.artifact-upload.outputs.artifact-url }}"
       - name: Push wheel to PyPI
         uses: neuralmagic/nm-actions/actions/publish-whl@v1.0.0
         with:

.gitignore

@@ -1,3 +1,7 @@
+# build version files
+src/guidellm/version.txt
+src/guidellm/version.py
+
 # Output files
 benchmarks.json
 benchmarks.yaml

.pre-commit-config.yaml

@@ -26,14 +26,14 @@ repos:
         pydantic_settings,
         pyyaml,
         respx,
-        requests,
         rich,
+        setuptools,
+        setuptools-git-versioning,
         transformers,
 
         # dev dependencies
         pytest,
         pydantic_settings,
-        requests-mock,
 
         # types
         types-click,

README.md

@@ -163,6 +163,7 @@ Our comprehensive documentation offers detailed guides and resources to help you
 
 - [**Installation Guide**](https://github.com/neuralmagic/guidellm/tree/main/docs/install.md) - This guide provides step-by-step instructions for installing GuideLLM, including prerequisites and setup tips.
 - [**Backends Guide**](https://github.com/neuralmagic/guidellm/tree/main/docs/backends.md) - A comprehensive overview of supported backends and how to set them up for use with GuideLLM.
+- [**Data/Datasets Guide**](https://github.com/neuralmagic/guidellm/tree/main/docs/datasets.md) - Information on supported datasets, including how to use them for benchmarking.
 - [**Metrics Guide**](https://github.com/neuralmagic/guidellm/tree/main/docs/metrics.md) - Detailed explanations of the metrics used in GuideLLM, including definitions and how to interpret them.
 - [**Outputs Guide**](https://github.com/neuralmagic/guidellm/tree/main/docs/outputs.md) - Information on the different output formats supported by GuideLLM and how to use them.
 - [**Architecture Overview**](https://github.com/neuralmagic/guidellm/tree/main/docs/architecture.md) - A detailed look at GuideLLM's design, components, and how they interact.