Merge pull request #91 from lapp0/version-documentation

Version documentation Smoke test

.github/workflows/publish_documentation.yml

@@ -5,6 +5,9 @@ on:
   push:
     branches:
       - main
+  release:
+    types:
+      - created
 
 permissions:
   contents: write
@@ -14,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
@@ -25,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/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 }}

benchmarks/bench_cfg_guide.py

@@ -7,8 +7,6 @@
 from outlines.fsm.guide import CFGGuide
 from outlines.models.transformers import TransformerTokenizer
 
-from .common import ensure_numba_compiled
-
 random.seed(42)
 
 
@@ -30,9 +28,6 @@ class CFGGuideBenchmark:
 
     def setup(self, grammar_name):
         self.tokenizer = get_tiny_tokenizer()
-        ensure_numba_compiled(
-            self.tokenizer
-        )  # numba not currently used, but will be in the future
         self.prebuilt_cfg_guide = CFGGuide(
             benched_grammars[grammar_name], self.tokenizer
         )

benchmarks/bench_json_schema.py

@@ -2,7 +2,7 @@
 from outlines.fsm.guide import RegexGuide
 from outlines.fsm.json_schema import build_regex_from_schema
 
-from .common import ensure_numba_compiled, setup_tokenizer  # noqa: E402
+from .common import setup_tokenizer  # noqa: E402
 
 simple_schema = """{
         "$defs": {
@@ -69,7 +69,6 @@ class JsonSchemaBenchmark:
     def setup(self, schema_name):
         self.tokenizer = setup_tokenizer()
         self.schema = schemas[schema_name]
-        ensure_numba_compiled(self.tokenizer)
 
     @cache_disabled()
     def time_json_schema_to_regex(self, schema_name):

benchmarks/bench_regex_guide.py

@@ -1,7 +1,7 @@
 from outlines.caching import cache_disabled
 from outlines.fsm.guide import RegexGuide
 
-from .common import ensure_numba_compiled, setup_tokenizer
+from .common import setup_tokenizer
 
 regex_samples = {
     "email": r"[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?",
@@ -21,7 +21,6 @@ class RegexGuideBenchmark:
 
     def setup(self, pattern_name):
         self.tokenizer = setup_tokenizer()
-        ensure_numba_compiled(self.tokenizer)
         self.pattern = regex_samples[pattern_name]
 
     @cache_disabled()
@@ -34,7 +33,6 @@ class MemoryRegexGuideBenchmark:
 
     def setup(self, pattern_name):
         self.tokenizer = setup_tokenizer()
-        ensure_numba_compiled(self.tokenizer)
         self.pattern = regex_samples[pattern_name]
 
     @cache_disabled()

benchmarks/common.py

@@ -1,14 +1,8 @@
 from transformers import AutoTokenizer
 
-from outlines.fsm.guide import RegexGuide
 from outlines.models.transformers import TransformerTokenizer
 
 
 def setup_tokenizer():
     tokenizer = AutoTokenizer.from_pretrained("gpt2")
     return TransformerTokenizer(tokenizer)
-
-
-def ensure_numba_compiled(tokenizer):
-    RegexGuide("a", tokenizer)
-    return True

docs/reference/models/llamacpp.md

@@ -67,7 +67,7 @@ from outlines import models
 
 model = models.llamacpp(
     "TheBloke/phi-2-GGUF",
-    "phi-2.Q4_K_M.gguf"
+    "phi-2.Q4_K_M.gguf",
     n_gpu_layers=-1,  # to use GPU acceleration
 )
 ```

mkdocs.yml

@@ -45,6 +45,10 @@ extra:
   analytics:
     provider: google
     property: !ENV GOOGLE_ANALYTICS_KEY
+  version:
+    provider: mike
+    default: latest
+    alias: true
 
 # Extensions
 markdown_extensions: