outlines 0.1.dev0__tar.gz → 0.1.1__tar.gz

outlines-0.1.1/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,87 @@
+# Issue template inspired by NumPy's excellent template:
+# https://github.com/numpy/numpy/edit/main/.github/ISSUE_TEMPLATE/bug-report.yml
+name: 🐞 Bug report
+description: Create a bug report to help us reproduce and fix it.
+title: "<Please write a descriptive title>"
+labels: ["bug"]
+
+body:
+  - type: markdown
+    attributes:
+      value: >-
+        Thank you for taking the time to file a bug report. First, carefully read
+        the following before everything else:
+
+          - Does your issue only arise in a library that uses Outlines? If so,
+            submit your issue to this library's issue tracker.
+          - Did you check the issue tracker for open and closed issues that may be
+            related to your bug?
+
+  - type: textarea
+    attributes:
+      label: "Describe the issue as clearly as possible:"
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: "Steps/code to reproduce the bug:"
+      description: >
+        A short code example that reproduces the problem/missing feature. It
+        should be self-contained, i.e., can be copy-pasted into the Python
+        interpreter or run as-is via `python myproblem.py`.
+      placeholder: |
+        import outlines
+
+        << your code here >>
+      render: python
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: "Expected result:"
+      description: >
+        Please describe what you expect the above example to output.
+      placeholder: |
+        << the expected result here >>
+      render: shell
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: "Error message:"
+      description: >
+        Please include the full error message, if any.
+      placeholder: |
+        << Full traceback starting from `Traceback: ...` >>
+      render: shell
+
+  - type: textarea
+    attributes:
+      label: "Outlines/Python version information:"
+      description: |
+          Please run the following code and paste the output here.
+          python -c "from outlines import _version; print(_version.__version__)"
+          python -c "import sys; print('Python', sys.version)"
+          pip freeze
+      value: |
+          Version information
+          <details>
+          ```
+          (command output here)
+          ```
+          </details>
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: "Context for the issue:"
+      description: |
+        Please explain how this issue affects your work or why it should be prioritized.
+      placeholder: |
+        << your explanation here >>
+    validations:
+      required: false

outlines-0.1.1/.github/ISSUE_TEMPLATE/config.yml

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

outlines-0.1.1/.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!

outlines-0.1.1/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,27 @@
+---
+name: 🚀 New feature
+about: Request a new feature.
+title: ''
+labels: ''
+assignees: ''
+---
+
+Before suggesting a new feature, please make sure this hasn't already been suggested by searching through the past issues and the PR tracker.
+
+### Presentation of the new feature
+
+Assume that we know nothing about this feature. Please give us as much information as possible so we can judge it fairly. That includes (but is not limited to):
+- Academic article
+- Blog posts
+- Implementations
+- Personnal experience with the feature
+
+### Where does it fit in Outlines?
+
+Please explain to us why you are suggesting this feature for integration in Outlines.
+
+### Are you willing to open a PR?
+
+Tell us whether you are willing to add the feature yourself, and if so if you can share a design plan. **You may be challenged.**
+
+Thanks for contributing!

outlines-0.1.1/.github/ISSUE_TEMPLATE/improvement.yml

@@ -0,0 +1,34 @@
+name: ✨ Improvement
+description: Propose an improvement to Outlines.
+title: "<Description of the proposed change>"
+labels: "enhancement"
+
+body:
+  - type: markdown
+    attributes:
+      value: >-
+        Before suggesting an improvement, please make sure this hasn't already been suggested by searching through the past issues and the PR tracker.
+
+        ## Current behavior
+
+  - type: textarea
+    attributes:
+      label: "What behavior of the library made you think about the improvement?"
+      placeholder: |
+        Sample code with the current behavior
+
+  - type: markdown
+    attributes:
+      value: >-
+        ## Desired behavior
+
+  - type: textarea
+    attributes:
+      label: "How would you like it to behave?"
+      placeholder: |
+        Sample code with the desired behavior
+
+  - type: markdown
+    attributes:
+      value: >-
+        **Be aware that your proposal may be challenged.** Outlines has strong design principles that we are committed to stick to. If there is an alternative way to achieve what you would like, we will let you know.

outlines-0.1.1/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,23 @@
+# 🚧 Thank you for opening a PR!
+
+A few important guidelines and requirements before we can merge your PR:
+
+- [ ] We should be able to understand what the PR does from its title only;
+- [ ] There is a high-level description of the changes;
+- [ ] *If I add a new feature*, there is an [issue][issues] discussing it already;
+- [ ] There are links to *all* the relevant issues, discussions and PRs;
+- [ ] The branch is rebased on the latest `main` commit;
+- [ ] **Commit messages** follow these [guidelines][git-guidelines];
+- [ ] One commit per logical change;
+- [ ] The code respects the current **naming conventions**;
+- [ ] Docstrings follow the [numpy style guide][docstring-guidelines];
+- [ ] `pre-commit` is installed and configured on your machine, and you ran it before opening the PR;
+- [ ] There are tests covering the changes;
+- [ ] The documentation is up-to-date;
+
+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/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

outlines-0.1.1/.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 ..

outlines-0.1.1/.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

outlines-0.1.1/.github/workflows/build_documentation.yml

@@ -0,0 +1,23 @@
+name: Build the documentation
+
+on:
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Build the documentation
+        env:
+          GOOGLE_ANALYTICS_KEY: ${{ secrets.GOOGLE_ANALYTICS_KEY }}
+        run: |
+          pip install -r requirements-doc.txt
+          mkdocs build

outlines-0.1.1/.github/workflows/publish_documentation.yml

@@ -0,0 +1,53 @@
+name: Publish the documentation
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+  release:
+    types:
+      - created
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v3
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install -r requirements-doc.txt
+      - 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 }}
+        if: github.event_name == 'push'
+        run: |
+          mike deploy --push --update-aliases ${{ github.ref_name }} unstable

outlines-0.1.1/.github/workflows/release_docker.yml

@@ -0,0 +1,36 @@
+name: Release Docker
+
+on:
+  release:
+    types:
+      - created
+  workflow_dispatch:
+    inputs:
+      release_tag:
+        description: 'Release Tag (for manual dispatch)'
+        required: false
+        default: 'latest'
+jobs:
+  release-job:
+    name: Build and publish on Docker Hub
+    runs-on: ubuntu-latest
+    environment: release
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Log in to Docker Hub
+      uses: docker/login-action@v3
+      with:
+        username: ${{ secrets.DOCKERHUB_USERNAME }}
+        password: ${{ secrets.DOCKERHUB_TOKEN }}
+    - name: Build and push Docker image
+      uses: docker/build-push-action@v5
+      with:
+        push: true
+        tags: |
+          outlinesdev/outlines:latest
+          outlinesdev/outlines:${{ github.event.release.tag_name || github.event.inputs.release_tag }}
+        build-args: |
+          BUILDKIT_CONTEXT_KEEP_GIT_DIR=true
+    - name: Clean docker cache
+      run: docker system prune --all --force

outlines-0.1.1/.github/workflows/release_pypi.yaml

@@ -0,0 +1,27 @@
+name: Release PyPi
+
+on:
+  release:
+    types:
+      - created
+jobs:
+  release-job:
+    name: Build and publish on PyPi
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: "3.10"
+    - 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: Publish to PyPi
+      uses: pypa/gh-action-pypi-publish@v1.4.2
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_TOKEN }}

outlines-0.1.1/.github/workflows/tests.yml

@@ -0,0 +1,109 @@
+name: Tests
+
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+
+jobs:
+  style:
+    name: Check the code style
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v4
+      with:
+        python-version: "3.10"
+    - uses: pre-commit/action@v3.0.0
+
+  tests:
+    name: Run the tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10"]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Set up test environment
+      run: |
+        python -m pip install --upgrade pip
+        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
+      env:
+        COVERAGE_FILE: .coverage.${{ steps.matrix-id.outputs.id }}
+    - name: Upload coverage data
+      uses: actions/upload-artifact@v4
+      with:
+        name: coverage-data
+        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.
+    needs: tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v4
+        with:
+          cache: pip
+          python-version: "3.11"
+
+      - name: Set up environment
+        run: |
+          pip install --upgrade "coverage[toml]>=5.1" diff-cover
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: coverage-data
+
+      - name: Fetch main for coverage diff
+        run: |
+          git fetch --no-tags --prune origin main
+
+      - name: Combine coverage & fail if it's <100%.
+        run: |
+          python -m coverage combine
+          python -m coverage html --skip-covered --skip-empty
+          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@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

outlines-0.1.1/.gitignore

@@ -0,0 +1,13 @@
+*.egg-info
+__pycache__
+*_version.py
+docs/build
+.coverage
+.idea/
+*.gguf
+.venv
+benchmarks/results
+
+# Remove doc build folders
+.cache/
+build/

outlines-0.1.1/.pre-commit-config.yaml

@@ -0,0 +1,33 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.4.0
+  hooks:
+    -   id: check-merge-conflict
+    -   id: debug-statements
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+- repo: https://github.com/pycqa/isort
+  rev: 5.12.0
+  hooks:
+    - id: isort
+      args: [--profile, black]
+- repo: https://github.com/asottile/pyupgrade
+  rev: v3.3.1
+  hooks:
+    - id: pyupgrade
+      args: [--py37-plus]
+- repo: https://github.com/pycqa/flake8
+  rev: 6.0.0
+  hooks:
+   - id: flake8
+- repo: https://github.com/psf/black
+  rev: 23.3.0
+  hooks:
+    - id: black
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v1.2.0
+  hooks:
+    - id: mypy
+      args: [--allow-redefinition]
+      exclude: ^examples/
+      additional_dependencies: [types-tqdm, types-Pillow]

outlines-0.1.1/.readthedocs.yaml

@@ -0,0 +1,15 @@
+version: 2
+
+python:
+  version: "3.8"
+  install:
+      - method: pip
+        path: .
+        extra_requirements:
+          - rtd
+      - requirements: requirements-doc.txt
+
+sphinx:
+  builder: html
+  configuration: docs/source/conf.py
+  fail_on_warning: true

outlines-0.1.1/Dockerfile

@@ -0,0 +1,17 @@
+FROM python:3.10
+
+WORKDIR /outlines
+
+RUN pip install --upgrade pip
+
+# Copy necessary build components
+COPY pyproject.toml .
+COPY outlines ./outlines
+
+# Install outlines and outlines[serve]
+# .git required by setuptools-scm
+RUN --mount=source=.git,target=.git,type=bind \
+    pip install --no-cache-dir .[serve]
+
+# https://dottxt-ai.github.io/outlines/reference/vllm/
+ENTRYPOINT ["python3", "-m", "outlines.serve.serve"]