merge upstream

.github/ISSUE_TEMPLATE/config.yml

@@ -1,4 +1,4 @@
 contact_links:
   - name: 🤔 Questions & Help
-    url: https://github.com/outlines-dev/outlines/discussions/new
+    url: https://github.com/dottxt-ai/outlines/discussions/new
     about: "If you have a question about how to use Outlines, please start a discussion."

.github/ISSUE_TEMPLATE/doc_request.md

@@ -0,0 +1,21 @@
+---
+name: 📚 Documentation
+about: Help with documentation improvements.
+title: ''
+labels: ''
+assignees: ''
+---
+
+### Documentation request
+
+Documentation is a high priority for outlines. If you would like to see something added to the documentation, please help us out by:
+
+- Checking to see if the documentation does not already exist.
+- Providing a detailed explanation of what you'd like to understand better.
+- Highlighting any specific difficulties you ran into.
+
+### Are you willing to open a PR?
+
+Tell us whether you are willing to submit a PR for this yourself, we'd greatly appreciate it!
+
+Thanks for contributing!

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -18,6 +18,6 @@ A few important guidelines and requirements before we can merge your PR:
 Consider opening a **Draft PR** if your work is still in progress but you would
 like some feedback from other contributors.
 
-[issues]: https://github.com/outlines-dev/outlines/issues
+[issues]: https://github.com/dottxt-ai/outlines/issues
 [git-guidelines]: https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
 [docstring-guidelines]: https://numpydoc.readthedocs.io/en/latest/format.html

.github/scripts/build_sdist_and_wheel.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+# Build sdist and wheel
+python -m pip install -U pip
+python -m pip install build
+python -m build
+
+# Check sdist install and imports
+mkdir -p test-sdist
+cd test-sdist
+python -m venv venv-sdist
+venv-sdist/bin/python -m pip install ../dist/outlines-*.tar.gz
+venv-sdist/bin/python -c "import outlines"
+cd ..
+
+# Check wheel install and imports
+mkdir -p test-wheel
+cd test-wheel
+python -m venv venv-wheel
+venv-wheel/bin/python -m pip install ../dist/outlines-*.whl
+venv-wheel/bin/python -c "import outlines"
+cd ..

.github/workflows/asv_benchmark_pr.yml

@@ -0,0 +1,68 @@
+name: Benchmark PR
+
+on:
+  push:
+  pull_request:
+    types: [synchronize, labeled]
+  workflow_dispatch:
+env:
+  PYTHON_VERSION: "3.10"
+  WORKING_DIR: ${{ github.workspace }}/benchmarks
+  BENCHMARKS_OUTPUT: ${{ github.workspace }}/benchmarks_output
+
+permissions:
+  contents: read
+
+# Cancels all previous workflow runs for pull requests that have not completed.
+concurrency:
+  # The concurrency group contains the workflow name and the branch name for pull requests
+  # or the commit hash for any other events.
+  group: ${{ github.workflow }}-${{ github.event_name == 'pull_request' && github.head_ref || github.sha }}
+  cancel-in-progress: true
+
+jobs:
+  benchmark-pr:
+    runs-on: ubuntu-latest
+    if: ${{ contains(github.event.pull_request.labels.*.name, 'run-benchmarks') || github.ref == 'refs/heads/main' }}
+
+    defaults:
+      run:
+        working-directory: ${{ env.WORKING_DIR }}
+
+    steps:
+
+    - name: Checkout repository
+      uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ env.PYTHON_VERSION }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install asv virtualenv lf-asv-formatter
+
+    - name: Create ASV machine config file
+      run: asv machine --machine gh-runner --yes
+
+    - name: Run Benchmarks - `PR HEAD` vs `main`
+      run: |
+        # prepare main branch for comparison
+        git remote add upstream https://github.com/${{ github.repository }}.git
+        git fetch upstream main
+
+        # Run benchmarks, allow errors, they will be caught in the next step
+        asv continuous upstream/main HEAD \
+            --no-stats --interleave-rounds -a repeat=3 || true
+
+    - name: BENCHMARK RESULTS
+      run: |
+        asv compare --factor=1.1 --no-stats --split upstream/main HEAD | tee ${{ env.BENCHMARKS_OUTPUT }}
+        if grep -q "Benchmarks that have got worse" "${{ env.BENCHMARKS_OUTPUT }}"; then
+          echo "Performance degradation detected!"
+          exit 1
+        fi

.github/workflows/build_documentation.yml

@@ -3,6 +3,7 @@ name: Build the documentation
 on:
   pull_request:
     branches: [main]
+  workflow_dispatch:
 
 jobs:
   build:

.github/workflows/publish_documentation.yml

@@ -1,9 +1,13 @@
 name: Publish the documentation
 
 on:
+  workflow_dispatch:
   push:
     branches:
       - main
+  release:
+    types:
+      - created
 
 permissions:
   contents: write
@@ -13,6 +17,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - uses: actions/setup-python@v4
         with:
           python-version: 3.x
@@ -24,7 +30,24 @@ jobs:
           restore-keys: |
             mkdocs-material-
       - run: pip install -r requirements-doc.txt
-      - name: Build documentation
+      - run: mkdocs build
+
+      - name: Set up Git
+        run: |
+          git config user.name ${{ github.actor }}
+          git config user.email ${{ github.actor }}@users.noreply.github.com
+
+      - name: Publish Tag as latest
+        env:
+          GOOGLE_ANALYTICS_KEY: ${{ secrets.GOOGLE_ANALYTICS_KEY }}
+        if: github.event_name == 'release'
+        run: |
+          mike deploy --push --update-aliases ${{ github.ref_name }} latest
+          mike set-default --push latest
+
+      - name: Publish main as unstable
         env:
           GOOGLE_ANALYTICS_KEY: ${{ secrets.GOOGLE_ANALYTICS_KEY }}
-        run: mkdocs gh-deploy --force
+        if: github.event_name == 'push'
+        run: |
+          mike deploy --push --update-aliases ${{ github.ref_name }} unstable

.github/workflows/release_pypi.yaml

@@ -15,28 +15,11 @@ jobs:
       uses: actions/setup-python@v2
       with:
         python-version: "3.10"
-    - name: Build sdist and wheel
-      run: |
-        python -m pip install -U pip
-        python -m pip install build
-        python -m build
+    - name: Build SDist and Wheel
+      run: ./.github/scripts/build_sdist_and_wheel.sh
     - name: Check that the package version matches the Release name
       run: |
         grep -Rq "^Version: ${GITHUB_REF:10}$" outlines.egg-info/PKG-INFO
-    - name: Check sdist install and imports
-      run: |
-        mkdir -p test-sdist
-        cd test-sdist
-        python -m venv venv-sdist
-        venv-sdist/bin/python -m pip install ../dist/outlines-*.tar.gz
-        venv-sdist/bin/python -c "import outlines"
-    - name: Check wheel install and imports
-      run: |
-        mkdir -p test-wheel
-        cd test-wheel
-        python -m venv venv-wheel
-        venv-wheel/bin/python -m pip install ../dist/outlines-*.whl
-        venv-wheel/bin/python -c "import outlines"
     - name: Publish to PyPi
       uses: pypa/[email protected]
       with:

.github/workflows/tests.yml

@@ -22,7 +22,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.10"]
+        python-version: ["3.10"]
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
@@ -32,16 +32,30 @@ jobs:
     - name: Set up test environment
       run: |
         python -m pip install --upgrade pip
-        pip install .[test]
+        pip install -e .[test]
+    - name: Create matrix id
+      id: matrix-id
+      env:
+        MATRIX_CONTEXT: ${{ toJson(matrix) }}
+      run: |
+        echo $MATRIX_CONTEXT
+        export MATRIX_ID=`echo $MATRIX_CONTEXT | md5sum | cut -c 1-32`
+        echo $MATRIX_ID
+        echo "::set-output name=id::$MATRIX_ID"
     - name: Run tests
       run: |
-        pytest --cov=outlines
+        pytest -x --cov=outlines
+      env:
+        COVERAGE_FILE: .coverage.${{ steps.matrix-id.outputs.id }}
     - name: Upload coverage data
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: coverage-data
-        path: .coverage*
+        path: .coverage.*
         if-no-files-found: ignore
+        include-hidden-files: true
+        # TODO FIXME: This is only using the last run
+        overwrite: true
 
   coverage:
     name: Combine & check coverage.
@@ -62,29 +76,34 @@ jobs:
         run: |
           pip install --upgrade "coverage[toml]>=5.1" diff-cover
 
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           name: coverage-data
 
-      - name: Fetch master for coverage diff
+      - name: Fetch main for coverage diff
         run: |
           git fetch --no-tags --prune origin main
 
       - name: Combine coverage & fail if it's <100%.
         run: |
-          # Combine coverage files (not needed now, but maybe later)
-          # python -m coverage combine
-
-          # Produce an html report with absolute coverage information
+          python -m coverage combine
           python -m coverage html --skip-covered --skip-empty
-
-          # Report relative coverage and write to the workflow's summary
           python -m coverage xml
           diff-cover coverage.xml --markdown-report=coverage.md --fail-under=100 || (cat coverage.md >> $GITHUB_STEP_SUMMARY && exit 1)
 
       - name: Upload HTML report if check failed.
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: html-report
           path: htmlcov
+          # TODO FIXME: This is only using the last run
+          overwrite: true
         if: ${{ failure() }}
+
+  build-wheel:
+    name: Build Wheel and Test SDist
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Build SDist and Wheel
+        run: ./.github/scripts/build_sdist_and_wheel.sh

.gitignore

@@ -6,3 +6,9 @@ docs/build
 .idea/
 *.gguf
 .venv
+benchmarks/results
+.python-version
+
+# Remove doc build folders
+.cache/
+build/

.pre-commit-config.yaml

@@ -30,3 +30,4 @@ repos:
     - id: mypy
       args: [--allow-redefinition]
       exclude: ^examples/
+      additional_dependencies: [types-tqdm, types-Pillow]

Dockerfile

@@ -13,5 +13,5 @@ COPY outlines ./outlines
 RUN --mount=source=.git,target=.git,type=bind \
     pip install --no-cache-dir .[serve]
 
-# https://outlines-dev.github.io/outlines/reference/vllm/
-ENTRYPOINT python3 -m outlines.serve.serve
+# https://dottxt-ai.github.io/outlines/reference/vllm/
+ENTRYPOINT ["python3", "-m", "outlines.serve.serve"]